ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-29 19:50:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[PR #9513/7c54c703 backport][stable-10] xyz*: style adjustments (#9525)

Browse source 
xyz*: style adjustments (#9513)

(cherry picked from commit 7c54c70301)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2025-01-04 11:04:02 +01:00 • committed by GitHub
parent 8208e52c42
commit e2604e7533
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 188 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

28
plugins/modules/xenserver_guest_powerstate.py
View file

@ -11,20 +11,21 @@ __metaclass__ = type
DOCUMENTATION = r"""
module: xenserver_guest_powerstate
short_description: Manages power states of virtual machines running on Citrix Hypervisor/XenServer host or pool
description: This module can be used to power on, power off, restart or suspend virtual machine and gracefully reboot or shutdown guest OS of virtual machine.
description: This module can be used to power on, power off, restart or suspend virtual machine and gracefully reboot or shutdown
guest OS of virtual machine.
author:
- Bojan Vitnik (@bvitnik) <bvitnik@mainstream.rs>
notes:
- Minimal supported version of XenServer is 5.6.
- Module was tested with XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 and 8.0.
- 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside Citrix
Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK to your Python site-packages on your Ansible
Control Node to use it. Latest version of the library can also be acquired from GitHub:
U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).'
- 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you
are accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs:
no) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.'
- 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be
found inside Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK
to your Python site-packages on your Ansible Control Node to use it. Latest version of the library can also be acquired
from GitHub: U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).'
- If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups.
Make sure you are accessing XenServer host in trusted environment or use C(https://) scheme explicitly.
- 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or
use C(validate_certs: no) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.'
requirements:
- XenAPI
attributes:
@ -44,7 +45,8 @@ options:
name:
description:
- Name of the VM to manage.
- VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
- VMs running on XenServer do not necessarily have unique names. The module fails if multiple VMs with same name are
found.
- In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage.
- This parameter is case sensitive.
type: str
@ -62,9 +64,9 @@ options:
default: false
state_change_timeout:
description:
- 'By default, module will wait indefinitely for VM to change state or acquire an IP address if O(wait_for_ip_address=true).'
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
- In case of timeout, module will generate an error message.
- By default, module waits indefinitely for VM to change state or acquire an IP address if O(wait_for_ip_address=true).
- If this parameter is set to positive value, the module instead waits specified number of seconds for the state change.
- In case of timeout, module generates an error message.
type: int
default: 0
extends_documentation_fragment: