Spec-Zone.ru › Ansible 2.7

vmware_tag – Управление тэгами VMware

Новое в версии 2.6.

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

Обзор

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

Требования

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

  • python >= 2.6
  • PyVmomi
  • vSphere Automation SDK
  • vCloud Suite SDK

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
category_id
-
Следует использовать уникальный идентификатор, сгенерированный vCenter.
Пользователь может получить этот уникальный идентификатор из модуля фактов.
hostname
-
Имя хоста или IP-адрес сервера vSphere vCenter.
Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST.
password
-
Пароль сервера vSphere vCenter.
Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD.

псевдонимы: pass, pwd
protocol
-
    Варианты:
  • https ←
  • http
Протокол подключения.
state
-
    Варианты:
  • present ←
  • absent
Состояние тега.
Если установлено present, и тег не существует, то тег создается.
Если установлено present, и тег существует, то тег обновляется.
Если установлено absent, и тег существует, то тег удаляется.
Если установлено absent, и тег не существует, никаких действий не выполняется.
tag_description
-
По умолчанию:
""
Описание тега.
Требуется только если state установлено в present.
Этот параметр игнорируется, когда state установлено в absent.
Процесс обновления тега позволяет изменять только описание.
tag_name
- / обязательно
Имя тега для управления.
username
-
Имя пользователя сервера vSphere vCenter.
Если значение не указано в задаче, используется значение переменной среды VMWARE_USER.

псевдонимы: user, admin
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в false, когда сертификаты не доверяются.
Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS.

Примечания

Примечание

  • Проверено на vSphere 6.5

Примеры

- name: Create a tag
  vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    category_id: 'urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL'
    tag_name: Sample_Tag_0002
    tag_description: Sample Description
    state: present
  delegate_to: localhost

- name: Update tag description
  vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_name: Sample_Tag_0002
    tag_description: Some fancy description
    state: present
  delegate_to: localhost

- name: Delete tag
  vmware_tag:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_name: Sample_Tag_0002
    state: absent
  delegate_to: localhost

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
results
словарь
при успехе
Словарь метаданных тега

Пример:
{'msg': "Тег 'Sample_Tag_0002' создан.", 'tag_id': 'urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL'}


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Abhijeet Kasurde (@Akasurde)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_tag_module.html

Spec-Zone.ru

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