community / community.vmware / 4.2.0 / module / vmware_guest_register_operation VM inventory registration operation Authors: sky-joker (@sky-joker)community.vmware.vmware_guest_register_operation (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can register or unregister VMs to the inventory.
- 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
name: description: - Specify VM name to be registered in the inventory. required: true type: str path: description: - Specify the path of vmx file. - 'Examples:' - ' [datastore1] vm/vm.vmx' - ' [datastore1] vm/vm.vmtx' type: str port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int uuid: description: - 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. type: str state: choices: - present - absent default: present description: - Specify the state the virtual machine should be in. - if set to V(present), register VM in inventory. - if set to V(absent), unregister VM from inventory. type: str folder: description: - 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' type: str cluster: description: - Specify a cluster name to register VM. type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str template: default: false description: - Whether to register VM as a template. type: bool username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datacenter: default: ha-datacenter description: - Destination datacenter for the register/unregister operation. - This parameter is case sensitive. type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int esxi_hostname: description: - The ESXi hostname where the virtual machine will run. - This parameter is case sensitive. type: str resource_pool: description: - Specify a resource pool name to register VM. - This parameter is case sensitive. - Resource pool should be child of the selected host parent. type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool