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_object_rename.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hostname string | The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead. | |
| new_name string / required | New name for VMware object. aliases: object_new_name | |
| object_moid string | Managed object id of the VMware object to work with. Mutually exclusive with object_name. | |
| object_name string | Name of the object to work with. Mutually exclusive with object_moid. | |
| object_type string / required | Type of object to work with. Valid options are Cluster, ClusterComputeResource, Datacenter, Datastore, Folder, ResourcePool, VM or VirtualMachine. | |
| password string | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.aliases: pass, pwd | |
| port integer | Default: 443 | The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead. |
| protocol string |
| The connection to protocol. |
| username string | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.aliases: admin, user | |
| validate_certs boolean |
| Allows connection when SSL certificates are not valid. Set to False when certificates are not trusted.If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead. |
Note
- name: Rename a virtual machine
community.vmware.vmware_object_rename:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
new_name: Fedora_31
object_name: Fedora_VM
object_type: VirtualMachine
delegate_to: localhost
- name: Rename a virtual machine using moid
community.vmware.vmware_object_rename:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
new_name: Fedora_31
object_moid: vm-14
object_type: VirtualMachine
delegate_to: localhost
- name: Rename a datacenter
community.vmware.vmware_object_rename:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
new_name: Asia_Datacenter
object_name: dc1
object_type: Datacenter
delegate_to: localhost
- name: Rename a folder with moid
community.vmware.vmware_object_rename:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
new_name: backup
object_moid: group-v46
object_type: Folder
delegate_to: localhost
- name: Rename a cluster with moid
community.vmware.vmware_object_rename:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
new_name: CCR_1
object_moid: domain-c33
object_type: Cluster
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| rename_status dictionary | on success | metadata about VMware object rename operation Sample: {'current_name': 'Fedora_31', 'desired_name': 'Fedora_31', 'previous_name': 'Fedora_VM'} |
© 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_object_rename_module.html