opentelekomcloud.cloud.dms_instance_topic (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 Instance Topics 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 Instance Topic
- opentelekomcloud.cloud.dms_instance_topic:
    instance: 'test'
    id: 'test2'

Scanned by Steampunk Spotter

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

# Delete Instance Topics
- opentelekomcloud.cloud.dms_instance_topic:
    instance: 'test'
    topics:
      - 'test1'
      - 'test2'
    state: absent

Inputs

    
id:
    description:
    - Name of the Instance topic to be created. Required for creation.
    required: false
    type: str

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

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

topics:
    description:
    - Indicates the list of topics to be deleted. Required for deleting.
    elements: str
    required: false
    type: list

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

instance:
    description:
    - Name or ID of the Instance
    required: true
    type: str

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

partition:
    default: 3
    description:
    - Indicates the number of topic partitions, which is used to set the number of concurrently
      consumed messages.
    required: false
    type: int

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    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

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

replication:
    default: 3
    description:
    - Indicates the number of replicas, which is configured to ensure data reliability.
    required: false
    type: int

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

retention_time:
    default: 72
    description:
    - Indicates the retention period of a message.
    required: false
    type: int

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

sync_replication:
    default: false
    description:
    - Indicates whether to enable synchronous replication.
    required: false
    type: bool

sync_message_flush:
    default: false
    description:
    - Indicates whether to enable synchronous flushing.
    required: false
    type: bool

Outputs

instance:
  description: Dictionary of Instance Topics
  returned: changed
  sample:
    topic:
      id: test2
      location:
        cloud: otc
        project:
          id: '12345678'
          name: eu-de
        region_name: eu-de
      partition: 3
      replication: 3
      retention_time: 72
  type: dict