Documentation

cs_securitygroup - Manages security groups on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

Create and remove security groups.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
no
    Account the security group 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 security group.
                domain
                no
                  Domain the security group is related to.
                  name
                  yes
                    Name of the security group.
                    project
                    no
                      Name of the project the security group to be created in.
                      state
                      no present
                      • present
                      • absent
                      State of the security group.

                      Examples

                      # Create a security group
                      - local_action:
                          module: cs_securitygroup
                          name: default
                          description: default security group
                      
                      # Remove a security group
                      - local_action:
                          module: cs_securitygroup
                          name: default
                          state: absent
                      

                      Return Values

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

                      name description returned type sample
                      project Name of project the security group is related to. success string Production
                      domain Domain the security group is related to. success string example domain
                      description Description of security group. success string application security group
                      name Name of security group. success string app
                      tags List of resource tags associated with the security group. success dict [ { "key": "foo", "value": "bar" } ]
                      account Account the security group is related to. success string example account
                      id UUID of the security group. success string a6f7a5fc-43f8-11e5-a151-feff819cdc9f


                      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.

                      Note

                      This module supports check mode.

                      This is an Extras Module

                      For more information on what this means please read Extras Modules

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