Try SpotterAdd or remove eip to shared bandwidth
| "added in version" 0.13.1 of opentelekomcloud.cloud"
Authors: Gubina Polina (@Polina-Gubina)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2Add or remove eip to shared bandwidth
# 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
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: Bandwidth name of id.
required: true
type: str
size:
description:
- 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.
type: int
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: Whether resource should be present or absent.
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
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
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
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
charge_mode:
choices:
- bandwidth
- traffic
description:
- 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.
type: str
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
publicip_id:
description:
- Specifies the ID of the EIP to be added or removed from shared bandwidth.
required: true
type: str
region_name:
description:
- Name of the region.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
publicip_type:
choices:
- 5_bgp
- 5_mailbgp
- 5_gray
description:
- Specifies the EIP type.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default
value is 5_bgp.
type: str
sdk_log_level:
choices:
- ERROR
- WARN
- INFO
- DEBUG
default: WARN
description: Log level of the OpenStackSDK
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
bandwidth:
contains:
bandwidth_type:
description: Specifies the bandwidth type. The default value for the shared
bandwidth is share.
type: str
billing_info:
description:
- Specifies the bill information. If billing_info is specified, the bandwidth
is in yearly/monthly billing mode.
type: str
charge_mode:
description: Specifies that the bandwidth is billed by bandwidth. The
value can be traffic.
type: str
id:
description: Specifies the bandwidth ID, which uniquely identifies the
bandwidth.
type: str
name:
description: Specifies the bandwidth name.
type: str
publicip_info:
contains:
ip_version:
description:
- Specifies the IP address version. 4 means IPv4, 6 means IPv6.
type: str
publicip_address:
description:
- Specifies the obtained EIP if only IPv4 EIPs are available.
type: str
publicip_id:
description:
- Specifies the ID of the EIP that uses the bandwidth.
type: str
publicip_type:
description:
- Specifies the EIP type.
type: str
description: Specifies information about the EIP that uses the bandwidth.
elements: dict
type: list
share_type:
description:
- Specifies whether the bandwidth is shared or dedicated.
- The value can be PER or WHOLE.
- WHOLE means shared bandwidth, PER means dedicated bandwidth.
type: str
size:
description: Specifies the bandwidth size.
type: int
status:
description: Specifies the bandwidth status. Can be FREEZED and NORMAL.
type: str
tenant_id:
description: Specifies the project ID.
type: str
description: VPC bandwidth object.
returned: On Success.
type: complex