opentelekomcloud.cloud.dms_queue module -- Manage DMS Queues on Open Telekom Cloud

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.dms_queue.

New in opentelekomcloud.cloud 0.1.2

Synopsis

  • Manage DMS Queues 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

api_timeout

integer

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.

auth

dictionary

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.

auth_type

string

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.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

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

string

Description.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

max_consume_count

integer

Indicates the maximum number of allowed message consumption failures.

This parameter is mandatory only when redrive_policy is set to enable.

name

string / required

Name of the Queue. Can also be ID for deletion.

queue_mode

string

Indicates the queue type.

Choices:

  • "normal" ← (default)

  • "fifo"

  • "kafka_ha"

  • "kafka_ht"

redrive_policy

string

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.

Default: "disable"

region_name

string

Name of the region.

retention_hours

integer

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.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

state

string

Instance state

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may 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 Queue
- opentelekomcloud.cloud.dms_queue:
    name: "test_dms_queue"
    queue_mode: "fifo"
    redrive_policy: "enable"
    max_consume_count: "9"
    state: present

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

deh_host

dictionary

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}}

Authors

  • Sebastian Gode (@SebastianGode)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b