Модуль community.vmware.vmware_guest_custom_attributes — Управление пользовательскими атрибутами из VMware для данной виртуальной машины

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в книге задач укажите: community.vmware.vmware_guest_custom_attributes.

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

Обзор

Этот модуль можно использовать для добавления, удаления и обновления пользовательских атрибутов для данной виртуальной машины.

Параметры

Параметр	Комментарии
attributes list / elements=dictionary	Список имен и значений пользовательских атрибутов, которыми необходимо управлять. Значение пользовательского атрибута не обязательно и будет проигнорировано, если `state=absent`. По умолчанию: `[]`
name string / required	Имя атрибута.
value string	Значение атрибута. По умолчанию: `""`
datacenter string	Имя центра обработки данных, в котором находится виртуальная машина.
folder string	Абсолютный путь для поиска существующего гостевого компьютера. Этот параметр обязателен, если `name` указан и найдено несколько виртуальных машин с одинаковым именем.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
moid string	Идентификатор управляемого объекта экземпляра, которым необходимо управлять, если он известен; это уникальный идентификатор только в пределах одного экземпляра vCenter. Это необходимо, если `name` или `uuid` не указаны.
name string	Имя виртуальной машины, с которой нужно работать. Этот параметр обязателен, если `uuid` или `moid` не указаны.
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и передавать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт прокси-сервера HTTP, который будет получать все запросы HTTPS и передавать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
state string	Действие, которое нужно выполнить. Если установлено в `present`, то пользовательский атрибут добавляется или обновляется. Если установлено в `absent`, то значение пользовательского атрибута удаляется. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_instance_uuid boolean	Использовать ли UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
uuid string	UUID виртуальной машины, которой нужно управлять, если он известен. Это уникальный идентификатор VMware. Этот параметр обязателен, если `name` или `moid` не указаны.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Add virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost
  register: attributes

- name: Add multiple virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
      - name: MyAttribute2
        value: MyValue2
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute using Virtual Machine MoID
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: vm-42
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

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

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

Ключ	Описание
custom_attributes словарь	метаданные о свойствах виртуальной машины Возвращается: всегда Пример: `{"mycustom": "my_custom_value", "mycustom_2": "my_custom_value_2", "sample_1": "sample_1_value", "sample_2": "sample_2_value", "sample_3": "sample_3_value"}`

Авторы

Джимми Коннер (@cigamit)
Абхиджит Касурде (@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_guest_custom_attributes_module.html