Модуль cisco.dnac.tag_membership – Модуль ресурсов для членства в тегах

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.tag_membership.

Новое в cisco.dnac 3.1.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Управление обновлением операции ресурса «Членство в тегах».
Обновление членства в тегах. В качестве части полезной нагрузки запроса через этот API добавляются/сохраняются только указанные члены в заданные теги. Возможные значения атрибута memberType в полезной нагрузке запроса можно получить, используя API /tag/member/type.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
memberToTags dictionary	memberToTags членства в тегах.
key list / elements=string	Ключ членства в тегах.
memberType string	memberType членства в тегах.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: tag.Tag.update_tag_membership,
Используемые пути: put /dna/intent/api/v1/tag/member,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключения из Cisco DNAC SDK.
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения.

См. также

Документация Cisco DNA Center для UpdateTagMembership: Полное описание API UpdateTagMembership.

Примеры

- name: Update all
  cisco.dnac.tag_membership:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    memberToTags:
      key:
      - string
    memberType: string

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

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK. Возвращается: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/dnac/tag_membership_module.html