community.general.hwc_vpc_private_ip module – Creates a resource of Vpc/PrivateIP in Huawei Cloud
Note
This module is part of the community.general collection (version 8.6.4).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.hwc_vpc_private_ip
.
New in community.general 0.2.0
Synopsis
vpc private ip management.
Aliases: cloud.huawei.hwc_vpc_private_ip
Requirements
The below requirements are needed on the host that executes this module.
keystoneauth1 >= 3.6.0
Parameters
Parameter |
Comments |
---|---|
The name of the Domain to scope to (Identity v3). Currently only domain names are supported, and not domain IDs. |
|
The ID of resource to be managed. |
|
The Identity authentication URL. |
|
Specifies the target IP address. The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. Cannot be changed after creating the private ip. |
|
The password to login with. |
|
The name of the Tenant (Identity v2) or Project (Identity v3). Currently only project names are supported, and not project IDs. |
|
The region to which the project belongs. |
|
Whether the given object should exist in Huawei Cloud. Choices:
|
|
Specifies the ID of the subnet from which IP addresses are assigned. Cannot be changed after creating the private ip. |
|
The user name to login with. Currently only user names are supported, and not user IDs. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
If
id
option is provided, it takes precedence oversubnet_id
,ip_address
for private ip selection.subnet_id
,ip_address
are used for private ip selection. If more than one private ip with this options exists, execution is aborted.No parameter support updating. If one of option is changed, the module will create a new resource.
For authentication, you can set identity_endpoint using the
ANSIBLE_HWC_IDENTITY_ENDPOINT
environment variable.For authentication, you can set user using the
ANSIBLE_HWC_USER
environment variable.For authentication, you can set password using the
ANSIBLE_HWC_PASSWORD
environment variable.For authentication, you can set domain using the
ANSIBLE_HWC_DOMAIN
environment variable.For authentication, you can set project using the
ANSIBLE_HWC_PROJECT
environment variable.For authentication, you can set region using the
ANSIBLE_HWC_REGION
environment variable.Environment variables values will only be used if the playbook values are not set.
Examples
# create a private ip
- name: Create vpc
hwc_network_vpc:
cidr: "192.168.100.0/24"
name: "ansible_network_vpc_test"
register: vpc
- name: Create subnet
hwc_vpc_subnet:
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: true
vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26"
register: subnet
- name: Create a private ip
community.general.hwc_vpc_private_ip:
subnet_id: "{{ subnet.id }}"
ip_address: "192.168.100.33"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Specifies the target IP address. The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. Returned: success |
|
Specifies the ID of the subnet from which IP addresses are assigned. Returned: success |