community.vmware.vmware_guest_register_operation – VM inventory registration operation
community.vmware.vmware_guest_register_operation – VM inventory registration operation
Note
This plugin is part of the community.vmware collection (version 1.7.0).
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.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster string |
Specify a cluster name to register VM. | |
datacenter string |
Destination datacenter for the register/unregister operation. This parameter is case sensitive. | |
esxi_hostname string |
The ESXi hostname where the virtual machine will run. This parameter is case sensitive. | |
folder string |
Description folder, absolute path of the target folder. The folder should include the datacenter. ESX's datacenter is ha-datacenter. This parameter is case sensitive. Examples: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 | |
hostname string |
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. | |
name string / required |
Specify VM name to be registered in the inventory. | |
password string |
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.
| |
path string |
Specify the path of vmx file. Examples: [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx | |
port integer |
Default: 443 |
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. |
proxy_host string |
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 | |
proxy_port integer |
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 | |
resource_pool string |
Specify a resource pool name to register VM. This parameter is case sensitive. Resource pool should be child of the selected host parent. | |
state string |
|
Specify the state the virtual machine should be in. if set to if set to |
template boolean |
|
Whether to register VM as a template. |
username string |
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 string |
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. | |
validate_certs boolean |
|
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 |
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
Authors
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_register_operation_module.html