opentelekomcloud.cloud.vpc_peering module – Add/Update/Delete vpc peering connection from OpenTelekomCloud

Note

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

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

New in opentelekomcloud.cloud 0.13.1

Synopsis

• Add or Remove vpc peering 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
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	Provides supplementary information about the VPC peering connection.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
local_project string	Specifies the ID of the project to which a local VPC belongs. Can not be updated.
local_router string	Name or ID of the local router. Can not be updated.
name string / required	Name or ID of the vpc peering connection. Mandatory for creating. Can be updated.
region_name string	Name of the region.
remote_project string	Specifies the ID of the project to which a peer VPC belongs. Can not be updated.
remote_router string	ID of the remote router. Can not be updated.
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	Should the resource 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

# Create a vpc peering.
- opentelekomcloud.cloud.vpc_peering:
    name: "peering1"
    local_router: "local-router"
    local_project: "959db9b6017d4a1fa1c6fd17b6820f55"
    remote_router: "peer-router"
    remote_project: "959db9b6017d4a1fa1c6fd17b6820f55"

# Update vpc perring
- opentelekomcloud.cloud.vpc_peering:
    name: "peering1"
    description: "new description"
    local_router: "local-router"
    local_project: "959db9b6017d4a1fa1c6fd17b6820f55"
    remote_router: "peer-router"
    remote_project: "959db9b6017d4a1fa1c6fd17b6820f55"

# Delete a load balancer(and all its related resources)
- opentelekomcloud.cloud.vpc_peering:
    name: "peering2"
    state: absent

Return Values

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

Key	Description
vpc_peering complex	Dictionary describing VPC peering instance. Returned: On Success.
accept_vpc_info complex	Dictionary describing the local vpc. Returned: On success when state=present
project_id string	Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. Returned: success Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
vpc_id string	Specifies the ID of a VPC involved in a VPC peering connection. Returned: success Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
created_at string	Specifies the time (UTC) when the VPC peering connection is created. Returned: On success when state=present Sample: "2020-09-13T20:38:02"
description string	Provides supplementary information about the VPC peering connection. Returned: On success when state=present Sample: ""
id string	Specifies the VPC peering connection ID. Returned: On success when state=present Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
name string	Specifies the VPC peering connection name. Returned: On success when state=present Sample: "vpc_peering1"
request_vpc_info complex	Dictionary describing the local vpc. Returned: On success when state=present
project_id string	Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. Returned: success Sample: "45007a7e-ee4f-4d13-8283-b4da2e037c69"
vpc_id string	Specifies the ID of a VPC involved in a VPC peering connection. Returned: success Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
status string	Specifies the VPC peering connection status. Returned: On success when state=present Sample: "accepted"
updated_at string	Specifies the time (UTC) when the VPC peering connection is updated. Returned: On success when state=present Sample: "2020-09-13T20:38:02"

Authors

• Polina Gubina (@polina-gubina)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: UTC - commit: