vmware.vmware_rest.vcenter_vm_libraryitem_info 模块 – 返回与虚拟机关联的库项目的相关信息。
注意
此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装它,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest
。要使用此模块,您需要满足其他要求,请参阅 要求 了解详情。
要在 playbook 中使用它,请指定:vmware.vmware_rest.vcenter_vm_libraryitem_info
。
vmware.vmware_rest 0.1.0 中的新增功能
概要
返回与虚拟机关联的库项目的相关信息。
要求
执行此模块的主机需要以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
参数
参数 |
注释 |
---|---|
客户端会话的超时设置。 整个操作(包括建立连接、发送请求和响应)的最大秒数。 默认值为 300 秒。 |
|
vSphere vCenter 的主机名或 IP 地址 如果任务中未指定此值,则将使用环境变量 |
|
vSphere vCenter 密码 如果任务中未指定此值,则将使用环境变量 |
|
您可以使用此可选参数设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果任务中未指定此值,则将使用 环境变量 |
|
vSphere vCenter 用户名 如果任务中未指定此值,则将使用环境变量 |
|
允许在 SSL 证书无效时连接。当证书不受信任时,设置为 如果任务中未指定此值,则将使用环境变量 选项
|
|
虚拟机的标识符。 此参数必须是 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。在 *state=[‘get’]* 时必需 |
备注
注意
在 vSphere 7.0.3 上测试
示例
- name: Look up the VM called test_vm1 in the inventory
register: search_result
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VM
vmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'
register: test_vm1_info
- name: Get the information from the library
vmware.vmware_rest.vcenter_vm_libraryitem_info:
vm: '{{ test_vm1_info.id }}'
register: _result
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
获取库中的信息 返回:成功时 示例: |