New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
account
|
Default:
None
|
Account the network ACL rule is related to.
|
api_http_method
|
|
HTTP method used to query the API endpoint.
If not given, the
CLOUDSTACK_METHOD env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is
get if not specified. |
api_key
|
|
API key of the CloudStack API.
If not given, the
CLOUDSTACK_KEY env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
api_region
|
Default:
cloudstack
|
Name of the ini section in the
cloustack.ini file.If not given, the
CLOUDSTACK_REGION env variable is considered. |
api_secret
|
|
Secret key of the CloudStack API.
If not set, the
CLOUDSTACK_SECRET env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
api_timeout
|
|
HTTP timeout in seconds.
If not given, the
CLOUDSTACK_TIMEOUT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
|
api_url
|
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the
CLOUDSTACK_ENDPOINT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
description
|
Default:
None
|
Description of the network ACL.
If not set, identical to
name . |
domain
|
Default:
None
|
Domain the network ACL rule is related to.
|
name
required |
|
Name of the network ACL.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
project
|
Default:
None
|
Name of the project the network ACL is related to.
|
state
|
|
State of the network ACL.
|
vpc
required |
|
VPC the network ACL is related to.
|
zone
|
Default:
None
|
Name of the zone the VPC is related to.
If not set, default zone is used.
|
Note
# 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
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
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.