Модуль cisco.dnac.tag — Модуль ресурсов для тега

Примечание

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

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

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

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

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

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

Обзор

Управление операциями создания, обновления и удаления ресурса Тег.
Создает тег со значениями указанных атрибутов тега.
Удаляет тег, указанный по идентификатору.
Обновляет тег, указанный по идентификатору.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
description строка	Описание тега.
dnac_debug логический	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логический	Флаг для включения или выключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
dynamicRules список / элементы=словарь	dynamicRules тега.
memberType строка	Тип члена тега (например, Networkdevice, интерфейс).
rules словарь	Правила тега.
items список / элементы=словарь	Подробности элементов, несколько правил могут быть определены с помощью элементов (например, «items» {«operation» «ILIKE», «name» «managementIpAddress», «value» «%10%»}, {«operation» «ILIKE», «name» «hostname», «value» «%NA%»} ).
name строка	Имя параметра (например, для интерфейса portName,adminStatus,speed,status,description. Для networkdevice family,series,hostname,managementIpAddress,groupNameHierarchy,softwareVersion).
operation строка	Операция, используемая в правилах (например, OR,IN,EQ,LIKE,ILIKE,AND).
value строка	Значение параметра (например, для portName 1/0/1, для adminStatus,status включено/выключено, для скорости любое целое значение, для описания любая допустимая строка, для семейства коммутаторы, для серии C3650, для managementIpAddress 10.197.124.90, groupNameHierarchy Global, softwareVersion 16.9.1).
values список / элементы=строка	Значения параметра, только одно из значений или значений может быть использовано для данного параметра. (для managementIpAddress например, «10.197.124.90», «10.197.124.91»).
id строка	Обязательный instanceUuid тега, который необходимо обновить.
instanceTenantId строка	InstanceTenantId, сгенерированный для тега.
name строка	Название тега.
systemTag логический	Истина для системных тегов, ложь для определенных пользователем тегов. Варианты: `false` `true`
validate_response_schema логический	Флаг для Cisco DNA Center SDK для включения валидации тел запросов по отношению к схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Методы SDK, используемые, это tag.Tag.create_tag, tag.Tag.delete_tag, tag.Tag.update_tag,
Используемые пути — post /dna/intent/api/v1/tag, delete /dna/intent/api/v1/tag/{id}, put /dna/intent/api/v1/tag,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Update all
  cisco.dnac.tag:
    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}}"
    state: present
    description: string
    dynamicRules:
    - memberType: string
      rules:
        items:
        - {}
        name: string
        operation: string
        value: string
        values:
        - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true

- name: Create
  cisco.dnac.tag:
    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}}"
    state: present
    description: string
    dynamicRules:
    - memberType: string
      rules:
        items:
        - {}
        name: string
        operation: string
        value: string
        values:
        - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true

- name: Delete by id
  cisco.dnac.tag:
    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}}"
    state: absent
    id: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным 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_module.html