vmware.vmware_rest.vcenter_vm_hardware_parallel 模块 – 为虚拟机添加虚拟并行端口。
注意
此模块是 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_hardware_parallel
。
vmware.vmware_rest 0.1.0 中的新增功能
概要
为虚拟机添加虚拟并行端口。
要求
执行此模块的主机需要以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
参数
参数 |
注释 |
---|---|
指示客户机是否可以连接和断开设备的标志。 如果未设置,则值保持不变。 选项
|
|
虚拟并行端口的物理资源后端。 如果未设置,则默认为自动检测合适的宿主设备。 在 `state=[‘present’]` 时需要。 有效属性为
此键在 [‘present’] 时是必需的。
此字段是可选的,仅当 `type` 的值为 FILE 时才相关。([‘present’])
如果未设置,则虚拟并行端口将配置为自动检测合适的宿主设备。([‘present’]) |
|
项目的名称 |
|
虚拟并行端口标识符。 此参数必须是由 vmware.vmware_rest.vcenter_vm_hardware_parallel 返回的资源的 ID。在 `state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’]` 时需要。 |
|
客户端会话的超时设置。 整个操作(包括连接建立、请求发送和响应)的最大秒数。 默认值为 300 秒。 |
|
指示虚拟设备是否应在虚拟机每次启动时连接的标志。 如果未设置,则值保持不变。 选项
|
|
选项
|
|
vSphere vCenter 的主机名或 IP 地址 如果任务中未指定此值,则将使用环境变量 |
|
vSphere vCenter 密码 如果任务中未指定此值,则将使用环境变量 |
|
您可以使用此可选参数设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果任务中未指定此值,则将使用 环境变量 |
|
vSphere vCenter 用户名 如果任务中未指定此值,则将使用环境变量 |
|
当 SSL 证书无效时允许连接。当证书不受信任时,设置为 如果任务中未指定此值,则将使用环境变量 选项
|
|
虚拟机标识符。 此参数必须是由 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。此参数是必需的。 |
备注
注意
在 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: Turn on guest control on the parallel port
vmware.vmware_rest.vcenter_vm_hardware_parallel:
vm: '{{ test_vm1_info.id }}'
allow_guest_control: true
register: _result
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
资源的 moid 返回:成功时 示例: |
|
打开并行端口上的客户机控制 返回:成功时 示例: |