You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.hwc_network_vpc – Creates a Huawei Cloud VPC

Note

This plugin is part of the community.general collection (version 3.8.3).

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 community.general.

To use it in a playbook, specify: community.general.hwc_network_vpc.

Synopsis

• Represents an vpc resource.

Requirements

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

• requests >= 2.18.4

• keystoneauth1 >= 3.6.0

Parameters

Parameter	Comments
cidr string / required	The range of available subnets in the vpc.
domain string / required	The name of the Domain to scope to (Identity v3). (currently only domain names are supported, and not domain IDs).
id string	The id of resource to be managed.
identity_endpoint string / required	The Identity authentication URL.
name string / required	The name of vpc.
password string / required	The password to login with.
project string / required	The name of the Tenant (Identity v2) or Project (Identity v3). (currently only project names are supported, and not project IDs).
region string	The region to which the project belongs.
state string	Whether the given object should exist in vpc. Choices: present ← (default) absent
timeouts dictionary	The timeouts for each operations.
create string	The timeout for create operation. Default: “15m”
delete string	The timeout for delete operation. Default: “15m”
update string	The timeout for update operation. Default: “15m”
user string / required	The user name to login with (currently only user names are supported, and not user IDs).

Notes

Note

• For authentication, you can set identity_endpoint using the ANSIBLE_HWC_IDENTITY_ENDPOINT env variable.

• For authentication, you can set user using the ANSIBLE_HWC_USER env variable.

• For authentication, you can set password using the ANSIBLE_HWC_PASSWORD env variable.

• For authentication, you can set domain using the ANSIBLE_HWC_DOMAIN env variable.

• For authentication, you can set project using the ANSIBLE_HWC_PROJECT env variable.

• For authentication, you can set region using the ANSIBLE_HWC_REGION env variable.

• Environment variables values will only be used if the playbook values are not set.

Examples

- name: Create a vpc
  community.general.hwc_network_vpc:
      identity_endpoint: "{{ identity_endpoint }}"
      user: "{{ user }}"
      password: "{{ password }}"
      domain: "{{ domain }}"
      project: "{{ project }}"
      region: "{{ region }}"
      name: "vpc_1"
      cidr: "192.168.100.0/24"
      state: present

Return Values

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

Key	Description
cidr string	the range of available subnets in the vpc. Returned: success
enable_shared_snat boolean	show whether the shared snat is enabled. Returned: success
id string	the id of vpc. Returned: success
name string	the name of vpc. Returned: success
routes complex	the route information. Returned: success
destination string	the destination network segment of a route. Returned: success
next_hop string	the next hop of a route. If the route type is peering, it will provide VPC peering connection ID. Returned: success
status string	the status of vpc. Returned: success

Authors

• Huawei Inc. (@huaweicloud)