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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка	Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`.
new_name алиасы: object_new_name строка / обязательно	Новое имя для объекта VMware.
object_moid строка	Идентификатор управляемого объекта VMware для работы. Взаимоисключающее с `object_name`.
object_name строка	Имя объекта для работы. Взаимоисключающее с `object_moid`.
object_type строка / обязательно	Тип объекта для работы. Допустимые значения: Кластер, ClusterComputeResource, Центр данных, Хранилище данных, Папка, Ресурсный пул, VM или VirtualMachine. Выбор: `"ClusterComputeResource"` `"Cluster"` `"Datacenter"` `"Datastore"` `"Folder"` `"Network"` `"ResourcePool"` `"VM"` `"VirtualMachine"`
password алиасы: pass, pwd строка	Пароль сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`.
port целое число	Номер порта vSphere vCenter. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
protocol строка	Протокол подключения. Выбор: `"http"` `"https"` ← (по умолчанию)
...	...

Примечания

Примечание

Все модули требуют доступа к API для записи и поэтому не поддерживаются на бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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

END_OF_DOCUMENT_MARKER

Значения возврата

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

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

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на сборку

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