opentelekomcloud.cloud.vpc module – Create or delete vpc from Open Telekom Cloud

Note

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

You might already have this collection installed if you are using the ansible package. 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.

To use it in a playbook, specify: opentelekomcloud.cloud.vpc.

New in version 0.10.0: of opentelekomcloud.cloud

Synopsis

  • Create or Delete vpc from OpenStack.

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.

cidr

string

Specifies the available IP address ranges for subnets in the VPC.

If cidr is not specified, the default value is left blank.

The value must be in CIDR format, for example, 192.168.0.0/16.

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

raw

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.

enable_shared_snat

boolean

Specifies whether the shared SNAT function is enabled.

Choices:

  • no

  • yes

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

name

string

Name to be give to the router.

region_name

string

Name of the region.

routes

list / elements=dictionary

Specifies the route list.

destination

string

Specifies the destination network segment of a route.

The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.

nexthop

string

Specifies the next hop of a route.

The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.

state

string

Indicate desired state of the resource

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:

  • no ← (default)

  • yes

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (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

- name: Create vpc
  opentelekomcloud.cloud.vpc:
    name: "vpc-test"
    cidr: "192.168.0.0/24"
    state: present

- name: Update vpc
  opentelekomcloud.cloud.vpc:
    name: "vpc-test"
    description: "New description"

- name: Delete vpc
  opentelekomcloud.cloud.vpc:
    name: "vpc-test"
    state: absent

Return Values

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

Key

Description

vpc

complex

Dictionary describing the vpc.

Returned: On success when state is ‘present’

cidr

string

Specifies the available IP address ranges for subnets in the VPC.

Possible values are 10.0.0.0/8~24, 172.16.0.0/12~24, 192.168.0.0/16~24.

Must be in CIDR format.

Returned: success

Sample: “192.168.0.0/24”

description

string

Provides supplementary information about the VPC.

Returned: success

Sample: “”

id

string

Vpc ID.

Returned: success

Sample: “474acfe5-be34-494c-b339-50f06aa143e4”

name

string

Vpc name.

Returned: success

Sample: “vpc-test”

routes

list / elements=dictionary

Specifies the route information.

Returned: success

destination

string

Specifies the destination network segment of a route.

The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.

Returned: success

nexthop

string

Specifies the next hop of a route.

The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.

Returned: success

status

string

The vpc status. Can be ‘CREATING’ or ‘OK’.

Returned: success

Sample: “OK”

Authors

  • Polina Gubina (@polina-gubina)

Whats next

last updated: 2022-02-25 12:26