vmware.vmware_rest.vcenter_vm_guest_power 模块 – 向客户操作系统发出请求，要求其执行软关机、待机（挂起）或软重启

注意

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

vmware.vmware_rest 0.1.0 中的新增功能

概要 

向客户操作系统发出请求，要求其执行软关机、待机（挂起）或软重启。此请求立即返回，不会等待客户操作系统。

需求 

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

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

参数 

参数	注释
session_timeout 浮点数 vmware.vmware_rest 2.1.0 中新增	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
state 字符串 / 必需	选项 `"reboot"` `"shutdown"` `"standby"`
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 上测试过

另请参阅 

另请参阅

vmware.vmware_rest.vcenter_vm_power: 启动、强制关机和强制重置客户机的模块

示例 

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Shut down the VM
  vmware.vmware_rest.vcenter_vm_guest_power:
    state: shutdown
    vm: '{{ my_vm.id }}'

返回值 

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

键	描述
值字典	关闭虚拟机返回值：成功时示例：`{}`

作者

Ansible 云团队 (@ansible-collections)