Documentation

cs_user - Manages users on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

Create, update, disable, lock, enable and remove users.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
    Account the user will be created under.
    Required on state=present.
    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.
              domain
              		 no ROOT
                Domain the user is related to.
                email
                		 no
                  Email of the user.
                  Required on state=present.
                  first_name
                  		 no
                    First name of the user.
                    Required on state=present.
                    last_name
                    		 no
                      Last name of the user.
                      Required on state=present.
                      password
                      		 no
                        Password of the user to be created.
                        Required on state=present.
                        Only considered on creation and will not be updated if user exists.
                        poll_async
                        		 no True
                          Poll async jobs until job has finished.
                          state
                          		 no present
                          • present
                          • absent
                          • enabled
                          • disabled
                          • locked
                          • unlocked
                          State of the user.
                          unlocked is an alias for enabled.
                          timezone
                          		 no
                            Timezone of the user.
                            username
                            		 yes
                              Username of the user.

                              Examples

                              # create an user in domain 'CUSTOMERS'
local_action:
  module: cs_user
  account: developers
  username: johndoe
  password: S3Cur3
  last_name: Doe
  first_name: John
  email: john.doe@example.com
  domain: CUSTOMERS

# Lock an existing user in domain 'CUSTOMERS'
local_action:
  module: cs_user
  username: johndoe
  domain: CUSTOMERS
  state: locked

# Disable an existing user in domain 'CUSTOMERS'
local_action:
  module: cs_user
  username: johndoe
  domain: CUSTOMERS
  state: disabled

# Enable/unlock an existing user in domain 'CUSTOMERS'
local_action:
  module: cs_user
  username: johndoe
  domain: CUSTOMERS
  state: enabled

# Remove an user in domain 'CUSTOMERS'
local_action:
  module: cs_user
  name: customer_xy
  domain: CUSTOMERS
  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
                              username Username of the user. success string johndoe
                              account Account name of the user. success string developers
                              last_name Last name of the user. success string Doe
                              account_type Type of the account. success string user
                              created Date the user was created. success string Doe
                              fist_name First name of the user. success string John
                              domain Domain the user is related. success string ROOT
                              id UUID of the user. success string 87b1e0ce-4e01-11e4-bb66-0050569e64b8
                              state State of the user. success string enabled
                              api_secret API secret of the user. success string FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
                              timezone Timezone of the user. success string enabled
                              api_key API key of the user. success string JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
                              email Emailof the user. success string john.doe@example.com


                              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.