opentelekomcloud.cloud.dms_instance module – Manage DMS Instances on Open Telekom Cloud¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.11.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install opentelekomcloud.cloud.
To use it in a playbook, specify: opentelekomcloud.cloud.dms_instance.
New in version 0.1.2: of opentelekomcloud.cloud
Synopsis¶
Manage DMS Instances on Open Telekom Cloud
Requirements¶
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36.0
otcextensions
python >= 3.6
Parameters¶
Parameter |
Comments |
|---|---|
Indicates a username. Required when ssl_enable is true. |
|
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. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or 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. |
|
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 auth parameter should be updated accordingly. |
|
Indicates ID of an AZ. Required for creation |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Description. |
|
Indicates whether to enable ppublic access to the instance. Choices:
|
|
Indicates a message engine. Required for creation. Default: “kafka” |
|
Indicates the version of the message engine. Required for creation. Default: “2.3.0” |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Indicates Beginning of mantenance time window. Must be set in pairs with maintain_end |
|
Indicates End of maintenance Window. Must be set in pairs with maintain_begin |
|
Name of the Instance. Can also be ID for deletion. |
|
Indicates the instance password. Required when ssl_enable is true. |
|
Indicates Product ID. Required for creation |
|
Indicates the public network bandwidth. |
|
Name of the region. |
|
Indicates the action to be taken when the memory usage reaches the disk capacity threshold. |
|
Indicates Security Group ID. Required for creation |
|
Indicates whether to enable SSL-encrypted access to the Instance. Choices:
|
|
Instance state Choices:
|
|
Indicates the message storage space with increments of 100 GB. Required for creation |
|
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 Choices:
|
|
Indicates Network ID. Required for creation |
|
How long should ansible wait for the requested resource. Default: 180 |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Indicates VPC ID. Required for creation |
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples¶
# 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'
# Delete Kafka Instance
- opentelekomcloud.cloud.dms_instance:
name: 'kafka-c76z'
state: absent
# Update Kafka Instance
- opentelekomcloud.cloud.dms_instance:
name: 'kafka-s1dd'
description: 'Test'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
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”}} |