Модуль community.vmware.vmware_custom_attribute_manager — управление пользовательскими атрибутами VMware для указанного объекта vSphere

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

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

Добавлено в community.vmware 3.2.0

Краткое описание
Параметры
Примечания
Примеры

Краткое описание

Этот модуль позволяет добавлять, удалять и обновлять пользовательские атрибуты указанного объекта vSphere.

Параметры

Параметр	Описание
custom_attributes list / elements=dictionary / обязательный	Список имён и значений пользовательских атрибутов, которыми необходимо управлять. Значение пользовательского атрибута указывать необязательно; оно будет проигнорировано, если `state=absent`.
name string / обязательный	Имя атрибута.
value string	Значение атрибута. По умолчанию: `""`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
object_name string / обязательный	Имя объекта vSphere, с которым нужно работать.
object_type string / обязательный	Тип объекта, с которым связан пользовательский атрибут. Варианты: `"Cluster"` `"Datacenter"` `"Datastore"` `"DistributedVirtualPortgroup"` `"DistributedVirtualSwitch"` `"Folder"` `"HostSystem"` `"ResourcePool"` `"VirtualMachine"`
password псевдонимы: 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`.
state string	Если задано значение `present`, пользовательскому атрибуту присваивается указанное значение. Если задано значение `absent`, пользовательский атрибут очищается. В этом случае указанное значение игнорируется. Варианты: `"present"` ← (по умолчанию) `"absent"`
username псевдонимы: 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. Обратите внимание: если задана эта переменная, в некоторых случаях значение ‘false’ параметра ‘validate_certs’ может быть проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Add virtual machine custom attributes
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: present
    custom_attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost

- name: Add multiple virtual machine custom attributes
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: present
    custom_attributes:
      - name: MyAttribute
        value: MyValue
      - name: MyAttribute2
        value: MyValue2
  delegate_to: localhost

- name: Remove virtual machine Attribute
  community.vmware.vmware_custom_attribute_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    object_name: vm1
    object_type: VirtualMachine
    state: absent
    custom_attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

Авторы

Mario Lenz (@mariolenz)

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

© 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_custom_attribute_manager_module.html