community.general.xenserver_guest_powerstate 模块 – 管理在 Citrix Hypervisor/XenServer 主机或池上运行的虚拟机的电源状态
注意
此模块是 community.general 集合（版本 10.1.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：community.general.xenserver_guest_powerstate。
概要
此模块可用于开启、关闭、重启或挂起虚拟机，并正常重启或关闭虚拟机的客户操作系统。
要求
以下要求需要在执行此模块的主机上满足。
XenAPI
参数
参数 |
注释 |
|---|---|
XenServer 主机或 XenServer 池主机的 hostname 或 IP 地址。 如果任务中未指定该值，则将改为使用环境变量 默认值： |
|
要管理的虚拟机的名称。 在 XenServer 上运行的虚拟机不一定具有唯一的名称。如果找到多个具有相同名称的虚拟机，则模块将失败。 如果多个虚拟机的名称相同，请使用 此参数区分大小写。 |
|
用于连接到 XenServer 的密码。 如果任务中未指定该值，则将改为使用环境变量 |
|
默认情况下，如果 如果此参数设置为正值，则模块将改为等待指定的秒数以进行状态更改。 如果超时，模块将生成错误消息。 默认值： |
|
用于连接到 XenServer 的用户名。 如果任务中未指定该值，则将改为使用环境变量 默认值： |
|
如果要管理虚拟机的 UUID（如果已知）。这是 XenServer 的唯一标识符。 如果名称不是唯一的，则需要它。 |
|
允许在 SSL 证书无效时进行连接。当证书不受信任时，设置为 如果在任务中未指定该值，则将使用环境变量 选项
|
|
等待 XenServer 检测到虚拟机的 IP 地址。 这需要虚拟机上预先安装 XenServer Tools 才能正常工作。 选项
|
属性
属性 |
支持 |
描述 |
|---|---|---|
支持: 完全 |
可以在 |
|
支持: 无 |
在 diff 模式下，将返回已更改（或可能需要在 |
说明
注意
XenServer 的最低支持版本为 5.6。
该模块已使用 XenServer 6.5、7.1、7.2、7.6、Citrix Hypervisor 8.0、XCP-ng 7.6 和 8.0 进行测试。
要获取 XenAPI Python 库，只需在 Ansible 控制节点上运行
pip install XenAPI即可。该库也可以在 Citrix Hypervisor/XenServer SDK（可从 Citrix 网站下载）中找到。将 SDK 中的 XenAPI.py 文件复制到 Ansible 控制节点上的 Python site-packages 中以使用它。该库的最新版本也可以从 GitHub 获取：https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py如果未在
hostname中指定 scheme，则模块默认使用http://，因为https://在大多数设置中都存在问题。请确保在受信任的环境中访问 XenServer 主机，或者显式使用https://scheme。要为
hostname使用https://scheme，您必须将主机证书导入到操作系统证书存储中，或者使用validate_certs: no，这需要 XenServer 7.2 SDK 或更新版本中的 XenAPI 库以及 Python 2.7.9 或更新版本。
示例
- name: Power on VM
community.general.xenserver_guest_powerstate:
hostname: "{{ xenserver_hostname }}"
username: "{{ xenserver_username }}"
password: "{{ xenserver_password }}"
name: testvm_11
state: powered-on
delegate_to: localhost
register: facts
返回值
通用返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
有关虚拟机的元数据 返回: 总是 示例: |