Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_tag_manager — Управление ассоциацией VMware тегов с VMware объектами

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

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

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

Описание

  • Этот модуль может использоваться для назначения/удаления VMware тегов для заданных VMware объектов.
  • Функция тегов была введена в vSphere версии 6, поэтому этот модуль не поддерживается в более ранних версиях vSphere.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • vSphere Automation SDK
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

hostname

строка

Имя хоста или IP-адрес сервера vCenter vSphere.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_HOST.

moid

строка

Идентификатор управляемого объекта для данного объекта.

Требуется, если object_name не задан.

object_name

строка

Имя объекта, с которым нужно работать.

Для DistributedVirtualPortgroups формат должен быть «switch_name:portgroup_name»

Требуется, если moid не задан.

object_type

строка / обязательно

Тип объекта, с которым нужно работать.

Варианты:

  • "VirtualMachine"
  • "Datacenter"
  • "ClusterComputeResource"
  • "HostSystem"
  • "DistributedVirtualSwitch"
  • "DistributedVirtualPortgroup"
  • "Datastore"
  • "DatastoreCluster"
  • "ResourcePool"
  • "Folder"

password

псевдонимы: pass, pwd

строка

Пароль сервера vCenter vSphere.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PASSWORD.

port

целое число

Номер порта сервера vCenter vSphere.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PORT.

По умолчанию: 443

protocol

строка

Протокол подключения.

Варианты:

  • "http"
  • "https" ← (по умолчанию)

proxy_host

строка

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

Формат — имя хоста или IP-адрес.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_HOST.

proxy_port

целое число

Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и перенаправлять их.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_PORT.

state

строка

Если установлено в add или present, добавятся теги в существующий список тегов данного объекта.

Если установлено в remove или absent, удалятся теги из существующего списка тегов данного объекта.

Если установлено в set, теги данного объекта будут заменены заданным списком тегов.

Варианты:

  • "present"
  • "absent"
  • "add" ← (по умолчанию)
  • "remove"
  • "set"

tag_names

список / элементы=любые / обязательно

Список тегов для управления.

Пользователь также может указать имя категории, указав значение, разделенное двоеточием. Например, «category_name:tag_name».

Пользователь также может указать тег и категорию в виде словаря, когда тег или категория содержит двоеточие. Дополнительную информацию см. в примере.

Имя категории можно опустить, если у вас есть уникальные имена тегов.

username

псевдонимы: admin, user

строка

Имя пользователя сервера vCenter vSphere.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_USER.

validate_certs

булево

Разрешает подключение, когда сертификаты SSL недействительны.

Установите в false, когда сертификаты не доверяются.

Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Add tags to a virtual machine
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0002
      - Category_0001:Sample_Tag_0003
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: add
  delegate_to: localhost

- name: Specify tag and category as dict
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - tag: tag_0001
        category: cat_0001
      - tag: tag_0002
        category: cat_0002
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: add
  delegate_to: localhost

- name: Remove a tag from a virtual machine
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0002
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: remove
  delegate_to: localhost

- name: Add tags to a distributed virtual switch
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0003
    object_name: Switch_0001
    object_type: DistributedVirtualSwitch
    state: add
  delegate_to: localhost

- name: Add tags to a distributed virtual portgroup
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0004
    object_name: Switch_0001:Portgroup_0001
    object_type: DistributedVirtualPortgroup
    state: add
  delegate_to: localhost


- name: Get information about folders
  community.vmware.vmware_folder_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: 'Asia-Datacenter1'
  delegate_to: localhost
  register: r
- name: Set Managed object ID for the given folder
  ansible.builtin.set_fact:
    folder_mo_id: "{{ (r.flat_folder_info | selectattr('path', 'equalto', '/Asia-Datacenter1/vm/tier1/tier2') | map(attribute='moid'))[0] }}"
- name: Add tags to a Folder using managed object id
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Cat_0004:Sample_Tag_0004
    object_type: Folder
    moid: "{{ folder_mo_id }}"
    state: add
  delegate_to: localhost

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

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

Ключ

Описание

tag_status

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

метаданные, относящиеся к тегам, связанным с конфигурацией объекта

Возвращается: при успешном выполнении

Пример: {"attached_tags": ["urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "current_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup", "urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "detached_tags": [], "previous_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup"]}

Авторы

  • Abhijeet Kasurde (@Akasurde)
  • Frederic Van Reet (@GBrawl)

Ссылки на сборку

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходные коды)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API