Модуль cisco.dnac.sda_fabric_border_device – Модуль ресурсов для устройства Sda Fabric Border Device

Примечание

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

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

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

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

Новая версия в cisco.dnac 3.1.0

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

Обзор

Управление операциями создания и удаления ресурса Sda Fabric Border Device.
Добавление устройства граничного шлюза в SDA Fabric.
Удаление устройства граничного шлюза из SDA Fabric.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceManagementIpAddress строка добавлено в cisco.dnac 4.0.0	Параметр запроса DeviceManagementIpAddress.
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"`
payload список / элементы=словарь	Полезная нагрузка устройства SD-Access Fabric Border.
borderPriority строка	Приоритет границы, связанный с данным устройством. Допустимый диапазон для приоритета границы — от 1 до 9. Более низкое значение указывает на более высокий приоритет. Например, приоритет 1 имеет преимущество перед 5. По умолчанию приоритет будет установлен в 10.
borderSessionType строка добавлено в cisco.dnac 4.0.0	Тип сеанса границы.
borderWithExternalConnectivity логическое	Граница с внешним подключением (Примечание: True для транзитной и False для нетранзитной границы). Варианты: `false` `true`
connectedToInternet логическое добавлено в cisco.dnac 4.0.0	Подключен к интернету. Варианты: `false` `true`
deviceManagementIpAddress строка добавлено в cisco.dnac 4.0.0	IP-адрес управления устройством.
deviceRole список / элементы=строка	Поддерживаемые роли устройств в ткани SD-Access. Допустимые роли: «Border_Node», «Control_Plane_Nod… Например, «Border_Node» или «Border_Node», «Control_Plane_Node» или «Border_Node», «Control_Plane_Node», «Edge_Node».
externalConnectivityIpPoolName строка добавлено в cisco.dnac 4.0.0	Имя пула IP-адресов внешнего подключения.
externalConnectivitySettings список / элементы=словарь добавлено в cisco.dnac 4.0.0	Настройки внешнего подключения устройства SD-Access Fabric Border.
externalAutonomouSystemNumber строка добавлено в cisco.dnac 4.0.0	Внешний номер автономной системы (например, 1-65535).
interfaceDescription строка	Описание интерфейса.
interfaceName строка добавлено в cisco.dnac 4.0.0	Имя интерфейса.

END_OF_DOCUMENT_MARKER

l2Handoff список / элементы=словарь	l2Handoff устройства SDA Fabric Border Device.
virtualNetworkName строка добавлен в cisco.dnac 4.0.0	Имя виртуальной сети, связанной с сайтом Fabric.
vlanName строка	Имя VLAN L2 Handoff.
l3Handoff список / элементы=словарь добавлен в cisco.dnac 4.0.0	l3Handoff устройства SDA Fabric Border Device.
virtualNetwork словарь добавлен в cisco.dnac 4.0.0	virtualNetwork устройства SDA Fabric Border Device.
virtualNetworkName строка добавлен в cisco.dnac 4.0.0	Имя виртуальной сети, связанной с сайтом Fabric.
vlanId строка добавлен в cisco.dnac 4.0.0	Идентификатор VLAN (например, 2-4096, за исключением зарезервированных VLAN (1002-1005, 2046, 4095)).
externalDomainRoutingProtocolName строка	Имя внешнего протокола маршрутизации домена.
internalAutonomouSystemNumber строка	Внутренний номер автономной системы.
routeDistributionProtocol строка	Протокол распределения маршрутов для устройства управления. Допустимые значения: «LISP_BGP» или «LISP_PUB_SUB». Значение по умолчанию: «LISP_BGP».
sdaTransitNetworkName строка	Имя транзитной сети SD-Access.
siteNameHierarchy строка	Иерархия имен сайтов подключенного устройства (сайт должен входить в состав сайта Fabric).
validate_response_schema логическое	Флаг для Cisco DNA Center SDK, разрешающий проверку тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: sda.Sda.adds_border_device, sda.Sda.deletes_border_device,
Используемые пути: post /dna/intent/api/v1/business/sda/border-device, delete /dna/intent/api/v1/business/sda/border-device,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Create
  cisco.dnac.sda_fabric_border_device:
    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
    payload:
    - borderPriority: string
      borderSessionType: string
      borderWithExternalConnectivity: true
      connectedToInternet: true
      deviceManagementIpAddress: string
      deviceRole:
      - string
      externalConnectivityIpPoolName: string
      externalConnectivitySettings:
      - externalAutonomouSystemNumber: string
        interfaceDescription: string
        interfaceName: string
        l2Handoff:
        - virtualNetworkName: string
          vlanName: string
        l3Handoff:
        - virtualNetwork:
            virtualNetworkName: string
            vlanId: string
      externalDomainRoutingProtocolName: string
      internalAutonomouSystemNumber: string
      routeDistributionProtocol: string
      sdaTransitNetworkName: string
      siteNameHierarchy: string

- name: Delete all
  cisco.dnac.sda_fabric_border_device:
    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
    deviceManagementIpAddress: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "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_fabric_border_device_module.html