opentelekomcloud.cloud.dms_instance_info (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

Get info about DMS instances

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.

# Query all Instances
- opentelekomcloud.cloud.dms_instance_info:

Scanned by Steampunk Spotter

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

- opentelekomcloud.cloud.dms_instance_info:
    status: createfailed

Inputs

    
id:
    description:
    - ID of the Instance
    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

name:
    description:
    - Name
    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

engine:
    description:
    - Name of the Engine
    type: str

status:
    choices:
    - creating
    - running
    - error
    - starting
    - closing
    - frozen
    - createfailed
    description:
    - Instance Status
    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

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

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

exactMatchName:
    default: false
    description:
    - Indicates whether to search for the instance that precisely matches a specified
      instance name.
    type: bool

includeFailure:
    default: true
    description:
    - Indicates whether to return instances that fail to be created.
    type: bool

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

Outputs

dms_queues:
  description: Dictionary of Queue Groups
  returned: changed
  sample:
  - access_user: null
    availability_zones:
    - '12345678'
    charging_mode: 1
    connect_address: ''
    created_at: '1617183440086'
    description: null
    engine_name: kafka
    engine_version: 2.3.0
    id: 12345678-003f-4d2a-9f6a-8468f832faea
    instance_id: 12345678-003f-4d2a-9f6a-8468f832faea
    is_public: false
    is_ssl: false
    kafka_public_status: 'false'
    maintenance_end: 02:00:00
    maintenance_start: '22:00:00'
    max_partitions: 300
    name: kafka-4ck1
    network_id: 12345678-99ee-43aa-9448-6fac41614db6
    password: null
    port: 9092
    product_id: 00300-30308-0--0
    public_bandwidth: 0
    retention_policy: produce_reject
    router_id: 12345678-6d1d-471e-a911-6924b7ec6ea9
    router_name: abcdef
    security_group_id: 12345678-a836-4dc9-ae59-0aea6dcaf0c3
    security_group_name: sg
    service_type: advanced
    spec: 100MB
    spec_code: dms.instance.kafka.cluster.c3.mini
    status: CREATING
    storage: 600
    storage_resource_id: 12345678-f432-4409-8c1b-f1a40fba7408
    storage_spec_code: dms.physical.storage.high
    storage_type: hec
    total_storage: 600
    type: cluster
    used_storage: 0
    user_id: '12345678'
    user_name: test
  type: list