Модуль community.vmware.vmware_custom_attribute – Управление определениями пользовательских атрибутов

Примечание

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

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

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

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

Новое в community.vmware 3.2.0

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

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

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

Параметры

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

Примечания

Примечание

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

Примеры

- name: Add VM Custom Attribute Definition
  community.vmware.vmware_custom_attribute:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: present
    object_type: VirtualMachine
    custom_attribute: custom_attr_def_1
  delegate_to: localhost
  register: defs

- name: Remove VM Custom Attribute Definition
  community.vmware.vmware_custom_attribute:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: absent
    object_type: VirtualMachine
    custom_attribute: custom_attr_def_1
  delegate_to: localhost
  register: defs

Авторы

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_module.html