opentelekomcloud.cloud.vpc_route module -- Add/Delete vpc route from OpenTelekomCloud

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

New in opentelekomcloud.cloud 0.2.1

Synopsis

• Add or Remove VPC route from the OTC VPC Route service.

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.
destination string	Route destination address (CIDR).
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
nexthop string	The next hop. If type is peering, it is the VPC peering connection name or id.
region_name string	Name of the region.
route_id string	Route ID.
router string	ID or name of the router requesting for creating a route.
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	ID of the VPC ID requesting for creating a route. Choices: "present" ← (default) "absent"
timeout integer	How long should ansible wait for the requested resource. Default: 180
type string	Type of a route. Default: "peering"
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 route.
- opentelekomcloud.cloud.vpc_route:
    destination: "6ysa5bac-0925-6d5b-add8-cb6667b8"
    nexthop: "67sa5bac-0925-4p5b-add8-cb6667b8"
    router_id: "89sa5bac-0925-9h7b-add8-cb6667b8"
  register: vpc_route

# Delete vpc route
- opentelekomcloud.cloud.vpc_route:
    name: "peering2"
    state: absent

Return Values

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

Key	Description
vpc_route complex	Specifies the vpc route. Returned: On Success.
destination string	Destination address in the CIDR notation format. Returned: On success when state=present Sample: "192.168.200.0/24"
id string	Route ID. Returned: On success when state=present Sample: "4dae5bac-0925-4d5b-add8-cb6667b8"
nexthop string	The next hop. If type is peering, it is the VPC peering connection ID Returned: On success when state=present Sample: "7375f1cd-6fe1-4d47-8888-c5c5a64298d8"
project_id string	Project id. Returned: On success when state=present Sample: "6ysa5bac-0925-4d5b-add8-cb6667b8"
router_id string	The router of the route. Returned: On success when state=present Sample: "4dae5bac-0725-2d5b-add8-cb6667b8"
type string	The route type. Returned: On success when state=present Sample: "peering"

Authors

• Polina Gubina (@polina-gubina)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

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