opentelekomcloud.cloud.dms_instance (0.14.2) — module

Manage DMS Instances on Open Telekom Cloud

| "added in version" 0.1.2 of opentelekomcloud.cloud"

Authors: Sebastian Gode (@SebastianGode)

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 Instances on Open Telekom Cloud


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create Kafka Instance
- opentelekomcloud.cloud.dms_instance:
    name: 'test'
    storage_space: 600
    vpc_id: '12345678-dc40-4e3a-95b1-5a0756441e12'
    security_group_id: '12345678'
    subnet_id: '12345678-ca80-4b49-bbbb-85ea9b96f8b3'
    available_zones: ['eu-de-03']
    product_id: '00300-30308-0--0'
    storage_spec_code: 'dms.physical.storage.ultra'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete Kafka Instance
- opentelekomcloud.cloud.dms_instance:
    name: 'kafka-c76z'
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Update Kafka Instance
- opentelekomcloud.cloud.dms_instance:
    name: 'kafka-s1dd'
    description: 'Test'

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 Instance. 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

engine:
    default: kafka
    description:
    - Indicates a message engine.
    - Required for creation.
    type: str

vpc_id:
    description:
    - Indicates VPC ID.
    - Required for creation
    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

password:
    description:
    - Indicates the instance password.
    - Required when ssl_enable is 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

subnet_id:
    description:
    - Indicates Network ID.
    - Required for creation
    type: str

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

product_id:
    description:
    - Indicates Product ID.
    - Required for creation
    type: str

ssl_enable:
    default: false
    description:
    - Indicates whether to enable SSL-encrypted access to the Instance.
    type: bool

access_user:
    description:
    - Indicates a username.
    - Required when ssl_enable is true.
    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

maintain_end:
    description:
    - Indicates End of maintenance Window.
    - Must be set in pairs with maintain_begin
    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

storage_space:
    description:
    - Indicates the message storage space with increments of 100 GB.
    - Required for creation
    type: int

engine_version:
    default: 2.3.0
    description:
    - Indicates the version of the message engine.
    - Required for creation.
    type: str

maintain_begin:
    description:
    - Indicates Beginning of mantenance time window.
    - Must be set in pairs with maintain_end
    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

available_zones:
    description:
    - Indicates ID of an AZ.
    - Required for creation
    elements: str
    type: list

enable_publicip:
    description:
    - Indicates whether to enable ppublic access to the instance.
    type: bool

public_bandwidth:
    description:
    - Indicates the public network bandwidth.
    type: str

retention_policy:
    description:
    - Indicates the action to be taken when the memory usage reaches the disk capacity
      threshold.
    type: str

security_group_id:
    description:
    - Indicates Security Group ID.
    - Required for creation
    type: str

storage_spec_code:
    choices:
    - dms.physical.storage.high
    - dms.physical.storage.ultra
    description:
    - Indicates I/O specification of a Kafka instance.
    - When specification is 100MB or 300MB, the storage I/O is
    - dms.physical.storage.high or dms.physical.storage.ultra
    - When specification is 600MB or 1200MB, the storage I/O is dms.physical.storage.ultra.
    - Required for creation
    type: str

Outputs

instance:
  description: Dictionary of Instance
  returned: changed
  sample:
    instance:
      availability_zones:
      - eu-de-03
      engine_name: kafka
      engine_version: 2.3.0
      id: 12345678-e7c4-4ba1-8aa2-f2c4eb507c43
      instance_id: 12345678-e7c4-4ba1-8aa2-f2c4eb507c43
      name: aed93756fa3c04e4083c5b48ad6ba6258-instance
      network_id: 12345678-ca80-4b49-bbbb-85ea9b96f8b3
      product_id: 00300-30308-0--0
      router_id: 12345678-dc40-4e3a-95b1-5a0756441e12
      security_group_id: 12345678-9b1f-4af8-9b53-527ff05c5e12
      storage: 600
      storage_spec_code: dms.physical.storage.ultra
  type: dict