community.general.hwc_vpc_route module – Creates a resource of Vpc/Route 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_route
.
New in community.general 0.2.0
Synopsis
vpc route management.
Aliases: cloud.huawei.hwc_vpc_route
Requirements
The below requirements are needed on the host that executes this module.
keystoneauth1 >= 3.6.0
Parameters
Parameter |
Comments |
---|---|
Specifies the destination IP address or CIDR block. |
|
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 next hop. The value is VPC peering connection ID. |
|
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 type of route. Default: |
|
The user name to login with. Currently only user names are supported, and not user IDs. |
|
Specifies the VPC ID to which route is added. |
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 overdestination
,vpc_id
,type
, andnext_hop
for route selection.destination
,vpc_id
,type
andnext_hop
are used for route selection. If more than one route 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 peering connect
- name: Create a local vpc
hwc_network_vpc:
cidr: "192.168.0.0/16"
name: "ansible_network_vpc_test_local"
register: vpc1
- name: Create a peering vpc
hwc_network_vpc:
cidr: "192.168.0.0/16"
name: "ansible_network_vpc_test_peering"
register: vpc2
- name: Create a peering connect
hwc_vpc_peering_connect:
local_vpc_id: "{{ vpc1.id }}"
name: "ansible_network_peering_test"
filters:
- "name"
peering_vpc:
vpc_id: "{{ vpc2.id }}"
register: connect
- name: Create a route
community.general.hwc_vpc_route:
vpc_id: "{{ vpc1.id }}"
destination: "192.168.0.0/16"
next_hop: "{{ connect.id }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Specifies the destination IP address or CIDR block. Returned: success |
|
UUID of the route. Returned: success |
|
Specifies the next hop. The value is VPC peering connection ID. Returned: success |
|
Specifies the type of route. Returned: success |
|
Specifies the VPC ID to which route is added. Returned: success |