ngine_io.cloudstack.cs_instance_password_reset – Allows resetting VM the default passwords on Apache CloudStack based clouds.
ngine_io.cloudstack.cs_instance_password_reset – Allows resetting VM the default passwords 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_instance_password_reset
.
New in version 0.1.0: of ngine_io.cloudstack
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.9.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
account string |
Account the virtual machine belongs 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 | |
domain string |
Name of the domain the virtual machine belongs to. | |
poll_async boolean |
|
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 / required |
Name of the zone in which the instance is deployed. |
Notes
Note
- 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
ngine_io.cloudstack.cs_instance:
name: myvirtualmachine
zone: zone01
state: stopped
- name: reset and get new default password
ngine_io.cloudstack.cs_instance_password_reset:
vm: myvirtualmachine
zone: zone01
register: root
- debug:
msg: "new default password is {{ root.password }}"
- name: boot the virtual machine to activate the new password
ngine_io.cloudstack.cs_instance:
name: myvirtualmachine
zone: zone01
state: started
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 |
Authors
- Gregor Riepl (@onitake)
© 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_instance_password_reset_module.html