ngine_io.cloudstack.cs_network_acl – Manages network access control lists (ACL) on Apache CloudStack based clouds.

From Get docs
Ansible/docs/2.11/collections/ngine io/cloudstack/cs network acl module


ngine_io.cloudstack.cs_network_acl – Manages network access control lists (ACL) on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.0.0).

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_network_acl.


New in version 0.1.0: of ngine_io.cloudstack


Synopsis

  • Create and remove network ACLs.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments

account

string

Account the network ACL rule is related to.

api_http_method

string

  • get

  • post

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

api_key

string / required

API key of the CloudStack API.

If not given, the CLOUDSTACK_KEY env variable is considered.

api_secret

string / required

Secret key of the CloudStack API.

If not set, the CLOUDSTACK_SECRET env variable is considered.

api_timeout

integer

Default:

10

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

api_url

string / required

URL of the CloudStack API e.g. https://cloud.example.com/client/api.

If not given, the CLOUDSTACK_ENDPOINT env variable is considered.

api_verify_ssl_cert

string

Verify CA authority cert file.

If not given, the CLOUDSTACK_VERIFY env variable is considered.

description

string

Description of the network ACL.

If not set, identical to name.

domain

string

Domain the network ACL rule is related to.

name

string / required

Name of the network ACL.

poll_async

boolean

  • no
  • yes

Poll async jobs until job has finished.

project

string

Name of the project the network ACL is related to.

state

string

  • present

  • absent

State of the network ACL.

vpc

string / required

VPC the network ACL is related to.

zone

string / required

Name of the zone the VPC is related to.



Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.


Examples

- name: create a network ACL
  ngine_io.cloudstack.cs_network_acl:
    name: Webserver ACL
    description: a more detailed description of the ACL
    vpc: customers
    zone: zone01

- name: remove a network ACL
  ngine_io.cloudstack.cs_network_acl:
    name: Webserver ACL
    vpc: customers
    zone: zone01
    state: absent

Return Values

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

Key Returned Description

description

string

success

Description of the network ACL.


Sample:

Example description of a network ACL

name

string

success

Name of the network ACL.


Sample:

customer acl

vpc

string

success

VPC of the network ACL.


Sample:

customer vpc

zone

string

success

Zone the VPC is related to.


Sample:

ch-gva-2




Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_network_acl_module.html