Модуль community.vmware.vmware_object_rename — переименование объектов VMware

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.vmware.vmware_object_rename.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль можно использовать для переименования объектов VMware.
Переименование хостов и сетей не поддерживается API VMware.

Требования

На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

vSphere Automation SDK

Параметры

Параметр	Комментарии
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
new_name aliases: object_new_name string / обязательный	Новое имя объекта VMware.
object_moid string	Идентификатор управляемого объекта VMware, с которым нужно работать. Несовместим с `object_name`.
object_name string	Имя объекта, с которым нужно работать. Несовместим с `object_moid`.
object_type string / обязательный	Тип объекта, с которым нужно работать. Допустимые значения: Cluster, ClusterComputeResource, Datacenter, Datastore, Folder, ResourcePool, VM или VirtualMachine. Допустимые значения: `"ClusterComputeResource"` `"Cluster"` `"Datacenter"` `"Datastore"` `"Folder"` `"Network"` `"ResourcePool"` `"VM"` `"VirtualMachine"`
password aliases: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
proxy_protocol aliases: protocol string	Протокол подключения к прокси-серверу. Этот параметр используется, если невозможно автоматически определить подходящий протокол прокси-сервера. Допустимые значения: `"http"` `"https"` ← (по умолчанию)
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Для всех модулей требуется доступ на запись через API, поэтому они не поддерживаются бесплатной лицензией ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях параметр ‘validate_certs’ со значением ‘false’ может быть проигнорирован. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные только для этого модуля:

Ключ	Описание
rename_status dictionary	Метаданные операции переименования объекта VMware Возвращается: при успешном выполнении Пример: `{"current_name": "Fedora_31", "desired_name": "Fedora_31", "previous_name": "Fedora_VM"}`

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_object_rename_module.html