cs_instance_password_reset – Allows resetting VM the default passwords on Apache CloudStack based clouds

From Get docs
Ansible/docs/2.8/modules/cs instance password reset module


cs_instance_password_reset – Allows resetting VM the default passwords on Apache CloudStack based clouds

New in version 2.8.


Synopsis

  • Resets the default user account’s password on an instance.
  • Requires cloud-init to be installed in the virtual machine.
  • The passwordenabled flag must be set on the template associated with the VM.

Requirements

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

  • python >= 2.6
  • cs >= 0.6.10

Parameters

Parameter Choices/Defaults Comments

account

string

Account the virtual machine belongs 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.

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

string

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

string

Default:

"cloudstack"

Name of the ini section in the cloustack.ini file.

If not given, the CLOUDSTACK_REGION env variable is considered.

api_secret

string

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

integer

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

string

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.

domain

string

Name of the domain the virtual machine belongs to.

poll_async

boolean

  • no
  • yes

Poll async jobs until job has finished.

project

string

Name of the project the virtual machine belongs to.

vm

string / required

Name of the virtual machine to reset the password on.

zone

string

Name of the zone in which the instance is deployed.

If not set, the default zone is used.



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.
  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.


Examples

- name: stop the virtual machine before resetting the password
  cs_instance:
    name: myvirtualmachine
    state: stopped
  delegate_to: localhost

- name: reset and get new default password
  cs_instance_password_reset:
    vm: myvirtualmachine
  register: root
  delegate_to: localhost
- debug:
    msg: "new default password is {{ root.password }}"

- name: boot the virtual machine to activate the new password
  cs_instance:
    name: myvirtualmachine
    state: started
  delegate_to: localhost
  when: root is changed

Return Values

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

Key Returned Description

id

string

success

ID of the virtual machine.


Sample:

a6f7a5fc-43f8-11e5-a151-feff819cdc9f

password

string

success

The new default password.


Sample:

ahQu5nuNge3keesh




Status

Authors

  • Gregor Riepl (@onitake)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/cs_instance_password_reset_module.html