Модуль community.vmware.vmware_object_custom_attributes_info — Сбор пользовательских атрибутов объекта

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
hostname строка	Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта экземпляра (если известен), это уникальный идентификатор только в пределах одного экземпляра vCenter. Требуется, если `object_name` не указано.
object_name псевдонимы: name строка	Имя объекта для работы.
object_type строка / обязательно	Тип объекта для работы. Варианты: `"Datacenter"` `"Cluster"` `"HostSystem"` `"ResourcePool"` `"Folder"` `"VirtualMachine"` `"DistributedVirtualSwitch"` `"DistributedVirtualPortgroup"` `"Datastore"`
password псевдонимы: pass, pwd строка	Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`

Примечания

Примечание

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

Примеры

- name: Gather custom attributes of a virtual machine
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    object_name: "{{ object_name }}"
  register: vm_attributes

- name: Gather custom attributes of a virtual machine with moid
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    moid: "{{ moid }}"
  register: vm_attributes

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

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

Ключ	Описание
custom_attributes список / элементы=строка	список пользовательских атрибутов объекта. Возвращается: всегда Пример: ["[\n {\n \"attribute\": \"example01\"", "\n \"key\": 132", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"10\"\n }", "\n {\n \"attribute\": \"example02\"", "\n \"key\": 131", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"20\"\n }", "\n {\n \"attribute\": \"example03\"", "\n \"key\": 130", "\n \"type\": \"VirtualMachine\"", "\n \"value\": null\n }\n]"]

Ключ

Описание

custom_attributes

список / элементы=строка

список пользовательских атрибутов объекта.

Возвращается: всегда

Пример: ["[\n {\n \"attribute\": \"example01\"", "\n \"key\": 132", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"10\"\n }", "\n {\n \"attribute\": \"example02\"", "\n \"key\": 131", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"20\"\n }", "\n {\n \"attribute\": \"example03\"", "\n \"key\": 130", "\n \"type\": \"VirtualMachine\"", "\n \"value\": null\n }\n]"]

Авторы

sky-joker (@sky-joker)

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

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