Модуль cisco.dnac.sda_port_assignments_info — Информационный модуль для Sda Portassignments

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.sda_port_assignments_info.

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

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

Описание

Получить все Sda Portassignments.
Возвращает список назначений портов, соответствующих заданным параметрам запроса.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dataVlanName строка	Параметр запроса dataVlanName. Имя VLAN данных назначения порта.
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"`
fabricId строка	Параметр запроса fabricId. Идентификатор фабрики, к которой принадлежит это устройство.
headers словарь	Дополнительные заголовки.
interfaceName строка	Параметр запроса interfaceName. Имя интерфейса назначения порта.
limit число с плавающей точкой	Параметр запроса limit. Максимальное количество записей для возврата.
networkDeviceId строка	Параметр запроса networkDeviceId. Идентификатор сетевого устройства назначения порта.
offset число с плавающей точкой	Параметр запроса offset. Запись начала для постраничной навигации.
validate_response_schema булево	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)
voiceVlanName строка	Параметр запроса voiceVlanName. Имя VLAN голоса назначения порта.

Примечания

Примечание

Используемые методы SDK — sda.Sda.get_port_assignments,
Используемые пути — get /dna/intent/api/v1/sda/portAssignments,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины соединения ansible, а вместо этого использует встроенный менеджер соединений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Sda Portassignments
  cisco.dnac.sda_port_assignments_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}}"
    fabricId: string
    networkDeviceId: string
    interfaceName: string
    dataVlanName: string
    voiceVlanName: string
    offset: 0
    limit: 0
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": [{"authenticateTemplateName": "string", "connectedDeviceType": "string", "dataVlanName": "string", "fabricId": "string", "id": "string", "interfaceDescription": "string", "interfaceName": "string", "networkDeviceId": "string", "scalableGroupName": "string", "voiceVlanName": "string"}], "version": "string"}`

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"authenticateTemplateName": "string", "connectedDeviceType": "string", "dataVlanName": "string", "fabricId": "string", "id": "string", "interfaceDescription": "string", "interfaceName": "string", "networkDeviceId": "string", "scalableGroupName": "string", "voiceVlanName": "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/sda_port_assignments_info_module.html