ngine_io.cloudstack.cs_securitygroup – Manages security groups on Apache CloudStack based clouds.
ngine_io.cloudstack.cs_securitygroup – Manages security groups 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_securitygroup
.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Create and remove security groups.
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 security group is related to. | |
api_http_method string |
|
HTTP method used to query the API endpoint. If not given, the |
api_key string / required |
API key of the CloudStack API. If not given, the | |
api_secret string / required |
Secret key of the CloudStack API. If not set, the | |
api_timeout integer |
Default: 10 |
HTTP timeout in seconds. If not given, the |
api_url string / required |
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the | |
api_verify_ssl_cert string |
Verify CA authority cert file. If not given, the | |
description string |
Description of the security group. | |
domain string |
Domain the security group is related to. | |
name string / required |
Name of the security group. | |
project string |
Name of the project the security group to be created in. | |
state string |
|
State of the security group. |
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 security group
ngine_io.cloudstack.cs_securitygroup:
name: default
description: default security group
- name: remove a security group
ngine_io.cloudstack.cs_securitygroup:
name: default
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
account string |
success |
Account the security group is related to.
Sample: example account |
description string |
success |
Description of security group.
Sample: application security group |
domain string |
success |
Domain the security group is related to.
Sample: example domain |
id string |
success |
UUID of the security group.
Sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
name string |
success |
Name of security group.
Sample: app |
project string |
success |
Name of project the security group is related to.
Sample: Production |
tags list / elements=string |
success |
List of resource tags associated with the security group.
Sample: [ { "key": "foo", "value": "bar" } ] |
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_securitygroup_module.html