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

Примечание

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

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

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

Для использования в playbook укажите: community.vmware.vmware_custom_attribute_manager.

Новое в community.vmware 3.2.0

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

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

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

Параметры

Параметр	Комментарии
custom_attributes list / elements=dictionary / required	Список имен и значений пользовательских атрибутов, которыми нужно управлять. Значение пользовательского атрибута не обязательно и будет игнорироваться, если `state=absent`.
name string / required	Имя атрибута.
value string	Значение атрибута. По умолчанию: `""`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
object_name string / required	Имя объекта vSphere, с которым нужно работать.
object_type string / required	Тип объекта, с которым связан пользовательский атрибут. Варианты: `"Cluster"` `"Datacenter"` `"Datastore"` `"DistributedVirtualPortgroup"` `"DistributedVirtualSwitch"` `"Folder"` `"HostSystem"` `"ResourcePool"` `"VirtualMachine"`
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"`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_custom_attribute_manager_module.html