Модуль cisco.dnac.tag_member_info – Модуль информации для членов тега

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.tag_member_info.

Новое в cisco.dnac 3.1.0

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

Описание

Получение всех членов тега.
Возвращает членов тега, указанных по идентификатору.

Примечание

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

Требования

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

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"`
headers dictionary	Дополнительные заголовки.
id string	Параметр пути id. Идентификатор тега.
level string	Параметр запроса уровня.
limit float	Параметр запроса limit. Используется для ограничения количества возвращаемых членов в результате.
memberAssociationType string	Параметр запроса memberAssociationType. Указывает, как член связан с тегом. Возможные значения и описание. 1) DYNAMIC Член связан с тегом через правила. 2) STATIC – Член связан с тегом вручную. 3) MIXED – Член связан вручную и также соответствует правилу, определенному для тега.
memberType string	Параметр запроса memberType. Тип сущности члена. Возможные значения можно получить, используя API /tag/member/type.
offset float	Параметр запроса offset. Используется для пагинации. Он указывает начальный номер строки из доступных записей членов.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки запрошенных тел по схеме JSON. Выбои: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Tag Member
  cisco.dnac.tag_member_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    memberType: string
    offset: 0
    limit: 0
    memberAssociationType: string
    level: string
    id: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": [{"instanceUuid": "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_member_info_module.html