opentelekomcloud.cloud.bandwidth module -- Manage VPC 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.bandwidth.
New in opentelekomcloud.cloud 0.13.1
Synopsis¶
Manage VPC bandwidth resource from the OTC.
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 |
|---|---|
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. |
|
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. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Bandwidth name of id. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The value ranges from 5 Mbit/s to 1000 Mbit/s by default. If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer. The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s. |
|
Whether resource should be present or absent. Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
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¶
# Assign bandwidth:
- opentelekomcloud.cloud.bandwidth:
name: "test-bandwidth"
size: 15
# Update bandwidth:
- opentelekomcloud.cloud.bandwidth:
name: "test-bandwidth"
size: 10
# Delete bandwidth:
- opentelekomcloud.cloud.bandwidth:
name: "test-bandwidth"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
VPC bandwidth object. Returned: On Success. |
|
Specifies the bandwidth type. The default value for the shared bandwidth is share. Returned: success |
|
Specifies the bill information. If billing_info is specified, the bandwidth is in yearly/monthly billing mode. Returned: success |
|
Specifies that the bandwidth is billed by bandwidth. The value can be traffic. Returned: success |
|
Specifies the bandwidth ID, which uniquely identifies the bandwidth. Returned: success |
|
Specifies the bandwidth name. Returned: success |
|
Specifies information about the EIP that uses the bandwidth. Returned: success |
|
Specifies the IP address version. 4 means IPv4, 6 means IPv6. Returned: success |
|
Specifies the obtained EIP if only IPv4 EIPs are available. Returned: success |
|
Specifies the ID of the EIP that uses the bandwidth. Returned: success |
|
Specifies the EIP type. Returned: success |
|
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 |
|
Specifies the bandwidth size. Returned: success |
|
Specifies the bandwidth status. Can be FREEZED and NORMAL. Returned: success |
|
Specifies the project ID. Returned: success |