opentelekomcloud.cloud.subnet module -- Manage VPC subnet¶

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

New in opentelekomcloud.cloud 0.11.0

Synopsis ¶

Manage (create, update or delete) Open Telekom Cloud VPC subnet.

Requirements ¶

The below requirements are needed on the host that executes this module.

openstacksdk
openstacksdk >= 0.36.0
otcextensions>=0.24.5
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.
availability_zone string	Specifies the AZ to which the subnet belongs.
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 subnet CIDR block. The value must be within the VPC CIDR block. The value must be in CIDR format. The subnet mask cannot be greater than 28.
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 subnet. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
dhcp_enable boolean	Specifies whether DHCP is enabled for the subnet. The value can be true (enabled) or false (disabled). If this parameter is left blank, the system automatically sets it to true by default. If this parameter is set to false, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Choices: `false` `true`
dns_list aliases: dnsList list / elements=string	Specifies the DNS server address list of a subnet. This field is required if use more than two DNS servers. This parameter value is the superset of both primary_dns and secondary_dns.
extra_dhcp_opts list / elements=dictionary	Specifies the NTP server address configured for the subnet.
opt_name string / required	Specifies the NTP server address name configured for the subnet. Choices: `"ntp"`
opt_value string	Specifies the NTP server address configured for the subnet. The option ntp for opt_name indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option null for opt_name indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.
gateway_ip string	Specifies the gateway of the subnet. The value must be an IP address in the subnet. The value must be a valid IP address.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: `"admin"` `"internal"` `"public"` ← (default)
name string / required	Specifies the subnet name or ID. When creating a new subnet, the value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
primary_dns string	Specifies the IP address of DNS server 1 on the subnet. The value must be an IP address.
region_name string	Name of the region.
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
secondary_dns string	Specifies the IP address of DNS server 2 on the subnet. The value must be an IP address.
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: `false` `true`
vpc aliases: vpc_id string / required	Specifies the name or ID of the VPC to which the subnet belongs.
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 ¶

- name: Create VPC
  opentelekomcloud.cloud.vpc:
    name: "vpc-test"
    cidr: "192.168.0.0/16"
  register: vpc

- name: Create subnet
  opentelekomcloud.cloud.subnet:
    name: "test-subnet"
    vpc_id: "{{ vpc.vpc.id }}"
    cidr: "192.168.0.0/16"
    gateway_ip: "192.168.0.1"
    dns_list:
      - "100.125.4.25"
      - "100.125.129.199"

- name: Update subnet
  opentelekomcloud.cloud.subnet:
    name: "test-subnet"
    vpc_id: "{{ vpc.vpc.id }}"
    dns_list:
      - "100.125.4.25"
      - "1.1.1.1"
    dhcp_enable: false

- name: Delete subnet
  opentelekomcloud.cloud.subnet:
    name: "test-subnet"
    vpc_id: "{{ vpc.vpc.id }}"
    state: absent

Return Values ¶

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

Key	Description
subnet complex	Created subnet resource. Returned: On success when state=present
availability_zone string	Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. Returned: success
cidr string	Specifies the subnet CIDR block. Returned: success
description string	Provides supplementary information about the subnet. Returned: success
dhcp_enable boolean	Specifies whether the DHCP function is enabled for the subnet. Returned: success
dns_list list / elements=string	Specifies the DNS server address list of a subnet. Returned: success
extra_dhcp_opts list / elements=dictionary	Specifies the NTP server address configured for the subnet. Returned: success Sample: `[{"opt_name": "ntp", "opt_value": "10.100.0.33,10.100.0.34"}]`
gateway_ip string	Specifies the gateway of the subnet. Returned: success
id string	Specifies the resource identifier in the form of UUID. Returned: success Sample: `"0f21367c-022d-433e-8ddb-1c31a65a05b8"`
name string	Specifies the subnet name. Returned: success Sample: `"test-subnet"`
neutron_network_id string	Specifies the ID of the corresponding network (OpenStack Neutron API). Returned: success Sample: `"0f21367c-022d-433e-8ddb-1c31a65a05b8"`
neutron_subnet_id string	Specifies the ID of the corresponding subnet (OpenStack Neutron API). Returned: success Sample: `"235f5393-a5e0-4b7a-9655-70eb3c13e2fe"`
primary_dns string	Specifies the IP address of DNS server 1 on the subnet. Returned: success
secondary_dns string	Specifies the IP address of DNS server 2 on the subnet. Returned: success
vpc_id string	Specifies the ID of the VPC to which the subnet belongs. Returned: success

Authors¶

Anton Kachurin (@outcatcher)

Collection links¶

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

opentelekomcloud.cloud.subnet module -- Manage VPC subnet¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶