community.vmware.vmware_guest_register_operation module – VM inventory registration operation
Note
This module is part of the community.vmware collection (version 4.8.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_register_operation
.
Synopsis
This module can register or unregister VMs to the inventory.
Parameters
Parameter |
Comments |
---|---|
Specify a cluster name to register VM. |
|
Destination datacenter for the register/unregister operation. Default: |
|
The ESXi hostname where the virtual machine will run. |
|
Description folder, absolute path of the target folder. The folder should include the datacenter. ESX’s datacenter is ha-datacenter. Examples: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 |
|
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 |
|
Specify VM name to be registered in the inventory. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Specify the path of vmx file. Examples: [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
Specify a resource pool name to register VM. Resource pool should be child of the selected host parent. |
|
Specify the state the virtual machine should be in. if set to if set to Choices:
|
|
Whether to register VM as a template. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
UUID of the virtual machine to manage if known, this is VMware’s unique identifier. If virtual machine does not exists, then this parameter is ignored. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Register VM to inventory
community.vmware.vmware_guest_register_operation:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
folder: "/vm"
esxi_hostname: "{{ esxi_hostname }}"
name: "{{ vm_name }}"
template: false
path: "[datastore1] vm/vm.vmx"
state: present
- name: Register VM in resource pool
community.vmware.vmware_guest_register_operation:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
folder: "/vm"
resource_pool: "{{ resource_pool }}"
name: "{{ vm_name }}"
template: false
path: "[datastore1] vm/vm.vmx"
state: present
- name: Register VM in Cluster
community.vmware.vmware_guest_register_operation:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
folder: "/vm"
cluster: "{{ cluster_name }}"
name: "{{ vm_name }}"
template: false
path: "[datastore1] vm/vm.vmx"
state: present
- name: UnRegister VM from inventory
community.vmware.vmware_guest_register_operation:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter }}"
folder: "/vm"
name: "{{ vm_name }}"
state: absent