community.vmware.vmware_guest_tpm – Add or remove vTPM device for specified VM.
Note
This plugin is part of the community.vmware collection (version 1.17.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_guest_tpm
.
New in version 1.16.0: of community.vmware
Synopsis
This module is used for adding or removing Virtual Trusted Platform Module(vTPM) device for an existing Virtual Machine. You must create a key provider on vCenter before you can add a vTPM. The ESXi hosts running in your environment must be ESXi 6.7 or later (Windows guest OS), or 7.0 Update 2 (Linux guest OS).
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
Parameters
Parameter |
Comments |
---|---|
The vCenter datacenter name used to get specified cluster or host. This parameter is case sensitive. |
|
VM folder, absolute or relative path to find an existing VM. This parameter is not required, only when multiple VMs are found with the same name. The folder should include the datacenter name. Examples:
|
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if |
|
Name of the virtual machine. This is required if parameter |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
State of vTPM device. If set to ‘absent’, vTPM device will be removed from VM. If set to ‘present’, vTPM device will be added if not present. Virtual machine should be turned off before add or remove vTPM device. Virtual machine should not contain snapshots before add vTPM device. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
UUID of the instance to manage if known, this is VMware’s unique identifier. This is required if parameter |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
Tested on vSphere 6.7
Tested on vSphere 7.0
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Add vTPM to specified VM
community.vmware.vmware_guest_tpm:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
name: "Test_VM"
state: present
delegate_to: localhost
- name: Remove vTPM from specified VM
community.vmware.vmware_guest_tpm:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
name: "Test_VM"
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about the VM vTPM device Returned: always Sample: “None” |
Authors
Diane Wang (@Tomorrow9) <dianew@vmware.com>