opentelekomcloud.cloud.dms_queue (0.14.2) — module

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2

Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Manage DMS Queues on Open Telekom Cloud

Requirements

• openstacksdk
• openstacksdk >= 0.36.0
• otcextensions
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Create Queue
- opentelekomcloud.cloud.dms_queue:
    name: "test_dms_queue"
    queue_mode: "fifo"
    redrive_policy: "enable"
    max_consume_count: "9"
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Delete Queue
- opentelekomcloud.cloud.dms_queue:
    name: 'test_dms_queue'
    state: absent

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

name:
    description:
    - Name of the Queue. Can also be ID for deletion.
    required: true
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description: Instance state
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

queue_mode:
    choices:
    - normal
    - fifo
    - kafka_ha
    - kafka_ht
    default: normal
    description:
    - Indicates the queue type.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

description:
    description:
    - Description.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

redrive_policy:
    default: disable
    description:
    - This parameter specifies whether to enable dead letter messages.
    - Dead letter messages are messages that cannot be normally consumed.
    - This parameter is valid only when queue_mode is set to NORMAL or FIFO.
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

retention_hours:
    description:
    - Indicates the hours of storing messages in the Kafka queue.
    - This parameter is valid only when queue_mode is set to KAFKA_HA or KAFKA_HT.
    type: int

max_consume_count:
    description:
    - Indicates the maximum number of allowed message consumption failures.
    - This parameter is mandatory only when redrive_policy is set to enable.
    type: int

Outputs

deh_host:
  description: Dictionary of DMS Queue
  returned: changed
  sample:
    queue:
      created: null
      description: null
      id: c28ff35a-dbd4-460a-a30d-cf31a6013eb0
      location:
        cloud: otc
        project:
          domain_id: null
          domain_name: null
          id: 16d53a84a13b49529d2e2c3646691288
          name: eu-de
        region_name: eu-de
        zone: null
      max_consume_count: null
      name: test-queue
      queue_mode: NORMAL
      redrive_policy: disable
      retention_hours: null
  type: dict