vmware.vmware_rest.vcenter_vm_hardware_adapter_sata 模块 – 向虚拟机添加虚拟 SATA 适配器。

注意

此模块是 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_adapter_sata。

vmware.vmware_rest 0.1.0 中的新增功能

概要 

向虚拟机添加虚拟 SATA 适配器。

要求 

执行此模块的主机需要以下要求。

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
adapter 字符串	虚拟 SATA 适配器标识符。此参数必须是 vmware.vmware_rest.vcenter_vm_hardware_adapter_sata 返回的资源的 ID。 state=[‘absent’] 时必填
bus 整数	SATA 总线编号。如果未设置，服务器将选择可用的总线编号；如果没有任何可用总线，请求将失败。默认值： `0`
label 字符串	项目的名称
pci_slot_number 整数	SATA 适配器在 PCI 总线上的地址。如果未设置，虚拟机启动时服务器将选择可用的地址。
session_timeout 浮点数 vmware.vmware_rest 2.1.0 中新增	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
state 字符串	选项 `"absent"` `"present"` ← (默认)
type 字符串	type 枚举类型定义了虚拟 SATA 适配器的有效仿真类型。选项 `"AHCI"`
vcenter_hostname 字符串 / 必填	vSphere vCenter 的主机名或 IP 地址如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
vcenter_password 字符串 / 必填	vSphere vCenter 密码如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
vcenter_rest_log_file 字符串	您可以使用此可选参数设置日志文件的位置。此文件将用于记录 HTTP REST 交互。该文件将存储在运行模块的主机上。如果任务中未指定此值，则将使用环境变量 `VMWARE_REST_LOG_FILE` 的值。
vcenter_username 字符串 / 必填	vSphere vCenter 用户名如果任务中未指定此值，则将使用环境变量 `VMWARE_USER` 的值。
vcenter_validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，设置为 `false`。如果任务中未指定此值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)
vm 字符串 / 必填	虚拟机标识符。此参数必须是 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: Create a SATA adapter at PCI slot 34
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 34
  register: _sata_adapter_result_1

- name: Remove SATA adapter at PCI slot 34
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 34
    state: absent

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
id 字符串	资源的 moid 返回：成功时示例： `"15000"`
value 字典	在 PCI 插槽 34 处创建 SATA 适配器返回：成功时示例： `{"bus": 0, "label": "SATA controller 0", "pci_slot_number": 34, "type": "AHCI"}`

作者

Ansible 云团队 (@ansible-collections)