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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.dnac.tag_info.

Добавлен в cisco.dnac 3.1.0

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

Описание

Получить все теги.
Получить тег по ID.
Возвращает тег, указанный по ID.
Возвращает теги, соответствующие заданным критериям фильтрации.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
additionalInfo_attributes string	Дополнительный параметр запроса AdditionalInfo.attributes.
additionalInfo_nameSpace string	Дополнительный параметр запроса AdditionalInfo.nameSpace.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. Значение по умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. Значение по умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. Значение по умолчанию: `"2.3.7.6"`
field string	Параметр запроса Field. Доступные имена полей: ‘name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.
headers dictionary	Дополнительные заголовки.
id string	Параметр пути Id. Идентификатор тега.
level string	Параметр запроса Level.
limit float	Параметр запроса Limit.
name string	Параметр запроса Name. Имя тега обязательно, когда используется операция фильтрации.
offset float	Параметр запроса Offset.
order string	Параметр запроса Order. Доступные значения: asc и des.
size string	Параметр запроса Size. Размер в килобайтах (KB).
sortBy string	Параметр запроса SortBy. Поддерживаемый атрибут - только name. SortyBy обязателен, когда используется order.
systemTag string	Параметр запроса SystemTag.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки текстов запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Tag
  cisco.dnac.tag_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}}"
    name: string
    additionalInfo_nameSpace: string
    additionalInfo_attributes: string
    level: string
    offset: 0
    limit: 0
    size: string
    field: string
    sortBy: string
    order: string
    systemTag: string
  register: result

- name: Get Tag by id
  cisco.dnac.tag_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}}"
    id: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"description": "string", "dynamicRules": [{"memberType": "string", "rules": {"items": [{}], "name": "string", "operation": "string", "value": "string", "values": ["string"]}}], "id": "string", "instanceTenantId": "string", "name": "string", "systemTag": true}, "version": "string"}`

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращенным Cisco DNAC Python SDK

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

Пример: {"response": {"description": "string", "dynamicRules": [{"memberType": "string", "rules": {"items": [{}], "name": "string", "operation": "string", "value": "string", "values": ["string"]}}], "id": "string", "instanceTenantId": "string", "name": "string", "systemTag": true}, "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_info_module.html