W3cubDocs

/Ansible

cs_vpc - Manages VPCs on Apache CloudStack based clouds.

New in version 2.3.

Synopsis

  • Create, update and delete VPCs.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
Account the VPC is related to.
api_http_method
 no get
  • get
  • post
HTTP method used.
api_key
 no
API key of the CloudStack API.
api_region
 no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
 no
Secret key of the CloudStack API.
api_timeout
 no 10
HTTP timeout.
api_url
 no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
cidr
 no
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.
display_text
 no
Display text of the VPC.
If not set, name will be used for creating.
domain
 no
Domain the VPC is related to.
name
 yes
Name of the VPC.
network_domain
 no
Network domain for the VPC.
All networks inside the VPC will belong to this domain.
poll_async
 no True
Poll async jobs until job has finished.
project
 no
Name of the project the VPC is related to.
state
 no present
  • present
  • absent
  • restarted
State of the VPC.
tags
 no
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: [].
aliases: tag
vpc_offering
 no
Name of the VPC offering.
If not set, default VPC offering is used.
zone
 no
Name of the zone.
If not set, default zone is used.

Examples

# Ensure a VPC is present
- local_action:
    module: cs_vpc
    name: my_vpc
    display_text: My example VPC
    cidr: 10.10.0.0/16

# Ensure a VPC is absent
- local_action:
    module: cs_vpc
    name: my_vpc
    state: absent

# Ensure a VPC is restarted
- local_action:
    module: cs_vpc
    name: my_vpc
    state: restarted

Return Values

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

name description returned type sample
display_text
Display text of the VPC.
 success string My example VPC
domain
Domain the VPC is related to.
 success string example domain
name
Name of the VPC.
 success string my_vpc
zone
Name of zone the VPC is in.
 success string ch-gva-2
tags
List of resource tags associated with the VPC.
 success dict [ { "key": "foo", "value": "bar" } ]
region_level_vpc
Whether the VPC is region level or not.
 success boolean True
redundant_vpc_router
Whether the VPC has redundant routers or not.
 success boolean True
distributed_vpc_router
Whether the VPC uses distributed router or not.
 success boolean True
project
Name of project the VPC is related to.
 success string Production
state
State of the VPC.
 success string Enabled
restart_required
Whether the VPC router needs a restart or not.
 success boolean True
account
Account the VPC is related to.
 success string example account
cidr
CIDR of the VPC.
 success string 10.10.0.0/16
network_domain
Network domain of the VPC.
 success string example.com
id
UUID of the VPC.
 success string 04589590-ac63-4ffc-93f5-b698b8ac38b6

Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cs_vpc_module.html