Documentation

cs_network_acl - Manages network access control lists (ACL) on Apache CloudStack based clouds.

New in version 2.4.

Synopsis

  • Create and remove network ACLs.

Options

parameter required default choices comments
account
 no
Account the network ACL rule 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.
description
 no
Description of the network ACL.
If not set, identical to name.
domain
 no
Domain the network ACL rule is related to.
name
 yes
Name of the network ACL.
poll_async
 no True
Poll async jobs until job has finished.
project
 no
Name of the project the network ACL is related to.
state
 no present
  • present
  • absent
State of the network ACL.
vpc
 yes
VPC the network ACL is related to.
zone
 no
Name of the zone the VPC is related to.
If not set, default zone is used.

Examples

# create a network ACL
local_action:
  module: cs_network_acl
  name: Webserver ACL
  description: a more detailed description of the ACL
  vpc: customers

# remove a network ACL
local_action:
  module: cs_network_acl
  name: Webserver ACL
  vpc: customers
  state: absent

Return Values

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

name description returned type sample
vpc
VPC of the network ACL.
 success string customer vpc
name
Name of the network ACL.
 success string customer acl
zone
Zone the VPC is related to.
 success string ch-gva-2
description
Description of the network ACL.
 success string Example description of a network ACL


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 preview which means that it is not guaranteed to have a backwards compatible interface.

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