opentelekomcloud.cloud.associate_bandwidth module -- Add or remove eip to shared bandwidth

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

New in opentelekomcloud.cloud 0.13.1

Synopsis

  • Add or remove eip to shared bandwidth

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.

charge_mode

string

After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth. Specifies whether the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth is billed by traffic or by bandwidth.

Mandatory for removing eip from a shared bandwidth.

Choices:

  • "bandwidth"

  • "traffic"

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.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

name

string / required

Bandwidth name of id.

publicip_id

string / required

Specifies the ID of the EIP to be added or removed from shared bandwidth.

publicip_type

string

Specifies the EIP type.

publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

Choices:

  • "5_bgp"

  • "5_mailbgp"

  • "5_gray"

region_name

string

Name of the region.

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

size

integer

Specifies size which will be allocated for removed eip. After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth.

state

string

Whether resource should be present or absent.

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

# Add eip to bandwidth:
- opentelekomcloud.cloud.associate_bandwidth:
    name: "test-bandwidth"
    publicip_id: "42d922af-18be-4e6d-804e-18f8c8871471"

# Remove eip from bandwidth:
- opentelekomcloud.cloud.associate_bandwidth:
    name: "new-bandwidth"
    publicip_id: "42d922af-18be-4e6d-804e-18f8c8871471"
    charge_mode: "traffic"
    size: 10
    state: absent

Return Values

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

Key

Description

bandwidth

complex

VPC bandwidth object.

Returned: On Success.

bandwidth_type

string

Specifies the bandwidth type. The default value for the shared bandwidth is share.

Returned: success

billing_info

string

Specifies the bill information. If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

Returned: success

charge_mode

string

Specifies that the bandwidth is billed by bandwidth. The value can be traffic.

Returned: success

id

string

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

Returned: success

name

string

Specifies the bandwidth name.

Returned: success

publicip_info

list / elements=dictionary

Specifies information about the EIP that uses the bandwidth.

Returned: success

ip_version

string

Specifies the IP address version. 4 means IPv4, 6 means IPv6.

Returned: success

publicip_address

string

Specifies the obtained EIP if only IPv4 EIPs are available.

Returned: success

publicip_id

string

Specifies the ID of the EIP that uses the bandwidth.

Returned: success

publicip_type

string

Specifies the EIP type.

Returned: success

share_type

string

Specifies whether the bandwidth is shared or dedicated.

The value can be PER or WHOLE.

WHOLE means shared bandwidth, PER means dedicated bandwidth.

Returned: success

size

integer

Specifies the bandwidth size.

Returned: success

status

string

Specifies the bandwidth status. Can be FREEZED and NORMAL.

Returned: success

tenant_id

string

Specifies the project ID.

Returned: success

Authors

  • Gubina Polina (@Polina-Gubina)

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