ngine_io.cloudstack.cs_vpc – Manages VPCs on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).
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 ngine_io.cloudstack
.
To use it in a playbook, specify: ngine_io.cloudstack.cs_vpc
.
New in version 0.1.0: of ngine_io.cloudstack
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
Account the VPC is related to. |
|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: 10 |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
CIDR of the VPC, e.g. 10.1.0.0/16 All VPC guest networks’ CIDRs must be within this CIDR. Required on state=present. |
|
Whether to redeploy a VPC router or not when state=restarted Choices:
|
|
Display text of the VPC. If not set, name will be used for creating. |
|
Domain the VPC is related to. |
|
Name of the VPC. |
|
Network domain for the VPC. All networks inside the VPC will belong to this domain. Only considered while creating the VPC, can not be changed. |
|
Poll async jobs until job has finished. Choices:
|
|
Name of the project the VPC is related to. |
|
State of the VPC. The state The state Choices:
|
|
List of tags. Tags are a list of dictionaries having keys key and value. For deleting all tags, set an empty list e.g. tags: []. |
|
Name of the VPC offering. If not set, default VPC offering is used. |
|
Name of the zone. |
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: Ensure a VPC is present but not started after creating
ngine_io.cloudstack.cs_vpc:
name: my_vpc
zone: zone01
display_text: My example VPC
cidr: 10.10.0.0/16
state: stopped
- name: Ensure a VPC is present and started after creating
ngine_io.cloudstack.cs_vpc:
name: my_vpc
zone: zone01
display_text: My example VPC
cidr: 10.10.0.0/16
- name: Ensure a VPC is absent
ngine_io.cloudstack.cs_vpc:
name: my_vpc
zone: zone01
state: absent
- name: Ensure a VPC is restarted with clean up
ngine_io.cloudstack.cs_vpc:
name: my_vpc
zone: zone01
clean_up: yes
state: restarted
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Account the VPC is related to. Returned: success Sample: “example account” |
|
CIDR of the VPC. Returned: success Sample: “10.10.0.0/16” |
|
Display text of the VPC. Returned: success Sample: “My example VPC” |
|
Whether the VPC uses distributed router or not. Returned: success Sample: true |
|
Domain the VPC is related to. Returned: success Sample: “example domain” |
|
UUID of the VPC. Returned: success Sample: “04589590-ac63-4ffc-93f5-b698b8ac38b6” |
|
Name of the VPC. Returned: success Sample: “my_vpc” |
|
Network domain of the VPC. Returned: success Sample: “example.com” |
|
Name of project the VPC is related to. Returned: success Sample: “Production” |
|
Whether the VPC has redundant routers or not. Returned: success Sample: true |
|
Whether the VPC is region level or not. Returned: success Sample: true |
|
Whether the VPC router needs a restart or not. Returned: success Sample: true |
|
State of the VPC. Returned: success Sample: “Enabled” |
|
List of resource tags associated with the VPC. Returned: success Sample: “[ { \”key\”: \”foo\”, \”value\”: \”bar\” } ]” |
|
Name of zone the VPC is in. Returned: success Sample: “ch-gva-2” |
Authors
René Moser (@resmo)