Spec-Zone.ru › Ansible

cisco.dnac.ise_radius_integration_workflow_manager модуль — Модуль ресурсов для серверов аутентификации и политики

Примечание

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

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

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

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

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

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

Описание

  • Управление операциями на серверах аутентификации и политики.
  • API для создания конфигурации доступа к серверам аутентификации и политики.
  • API для обновления конфигурации доступа к серверам аутентификации и политики.
  • API для удаления конфигурации доступа к серверам аутентификации и политики.

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.9

Параметры

Параметр

Комментарии

config

list / elements=dictionary / required

Список подробностей серверов аутентификации и политик, находящихся под управлением.

authentication_policy_server

list / elements=dictionary

Управляет серверами аутентификации и политик.

accounting_port

integer

Порт учёта RADIUS-сервера.

Обновление порта учёта невозможно.

Порт учёта должен быть от 1 до 65535.

Default: 1813

authentication_port

integer

Порт аутентификации RADIUS-сервера.

Обновление порта аутентификации невозможно.

Порт аутентификации должен быть от 1 до 65535.

Default: 1812

cisco_ise_dtos

list / elements=dictionary

Список объектов передачи данных (DTO) Cisco ISE.

Требуется, когда server_type установлен в ISE.

description

string

Описание сервера Cisco ISE.

fqdn

string

Полностью квалифицированное доменное имя сервера Cisco ISE.

Требуется для передачи cisco_ise_dtos.

ip_address

string

IP-адрес сервера Cisco ISE.

Требуется для передачи cisco_ise_dtos.

password

string

Пароль сервера Cisco ISE.

Пароль должен содержать от 4 до 127 символов без пробелов и следующих символов - “<”.

Требуется для передачи cisco_ise_dtos.

ssh_key

string

SSH-ключ сервера Cisco ISE.

user_name

string

Имя пользователя сервера Cisco ISE.

Требуется для передачи cisco_ise_dtos.

encryption_key

string

Ключ шифрования, используемый для шифрования общего секрета.

Обновление схемы шифрования невозможно.

Требуется, если указана схема шифрования.

При выборе формата ASCII ключ шифрования может содержать буквенно-цифровые и специальные символы. Длина ключа должна составлять 16 символов.

encryption_scheme

string

Тип схемы шифрования для дополнительной безопасности.

Если указана схема шифрования, то код аутентификатора сообщений и ключи шифрования должны быть обязательными.

Обновление схемы шифрования невозможно.

KEYWRAP используется для безопасного обёртывания и распаковки ключей шифрования, обеспечивая их конфиденциальность во время передачи или хранения.

RADSEC - это расширение RADIUS, которое обеспечивает безопасную связь между клиентами и серверами RADIUS по протоколу TLS/SSL. Повышает конфиденциальность и целостность обмена данными аутентификации и учёта.

Choices:

  • "KEYWRAP"
  • "RADSEC"

external_cisco_ise_ip_addr_dtos

list / elements=dictionary

Внешние объекты передачи данных IP-адреса Cisco ISE для будущего использования.

external_cisco_ise_ip_addresses

list / elements=dictionary

Внешние IP-адреса Cisco ISE.

external_ip_address

string

Внешний IP-адрес Cisco ISE.

ise_type

string

Тип сервера аутентификации и политик.

ise_integration_wait_time

integer

Указывает время ожидания после инициации процесса интеграции Cisco ISE.

Максимальное время ожидания должно быть меньше или равно 120 секундам.

Default: 20

message_authenticator_code_key

string

Ключ сообщения, используемый для шифрования общего секрета.

Обновление ключа сообщения невозможно.

Требуется при указании encryption_scheme.

Ключ кода аутентификации сообщений может содержать буквенно-цифровые и специальные символы. Длина ключа должна быть 20 символов.

protocol

string

Тип протокола для сервера аутентификации и политики.

RADIUS предоставляет централизованные услуги (AAA) для пользователей в сценариях удаленного доступа.

TACACS фокусируется на контроле доступа и административной аутентификации для сетевых устройств.

Варианты:

  • "TACACS"
  • "RADIUS" ← (по умолчанию)
  • "RADIUS_TACACS"

pxgrid_enabled

boolean

Установите True, чтобы включить Pxgrid, и False, чтобы отключить Pxgrid.

Pxgrid доступен только для серверов Cisco ISE.

PxGrid обеспечивает бесшовную интеграцию и обмен информацией между продуктами, повышая возможности обнаружения и реагирования на угрозы в экосистеме сети.

Варианты:

  • false
  • true ← (по умолчанию)

retries

integer

Количество попыток связи между устройствами и сервером аутентификации и политики.

Повторные попытки должны быть от 1 до 3.

По умолчанию: 3

role

string

Роль сервера аутентификации и политики.

Обновление роли невозможно

По умолчанию: "secondary"

server_ip_address

string / обязательно

IP-адрес сервера аутентификации и политики.

server_type

string

Тип сервера аутентификации и политики.

ISE для серверов Cisco ISE.

AAA для серверов, не являющихся серверами Cisco ISE.

Варианты:

  • "AAA" ← (по умолчанию)
  • "ISE"

shared_secret

string

Общий секрет между устройствами и сервером аутентификации и политики.

Общий секрет должен содержать от 4 до 100 символов без пробелов или следующих символов - [”<”, “?”].

Общий секрет является параметром только для чтения.

timeout

integer

Количество секунд до истечения времени ожидания между устройствами и сервером аутентификации и политики.

Время ожидания должно быть от 2 до 20.

По умолчанию: 4

trusted_server

boolean

Указывает, является ли сертификат доверенным для сервера.

Служит для проверки подлинности и надежности в защищенных подключениях.

Варианты:

  • false
  • true ← (по умолчанию)

use_dnac_cert_for_pxgrid

boolean

Установите True, чтобы использовать сертификат Cisco Catalyst Center для Pxgrid.

Варианты:

  • false ← (по умолчанию)
  • true

config_verify

boolean

Установите значение True, чтобы проверить Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_api_task_timeout

integer

Определяет время ожидания в секундах для вызовов API для получения подробностей о задаче. Если данные о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания.

По умолчанию: 1200

dnac_debug

boolean

Указывает, включено ли отладка в Cisco Catalyst Center SDK.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_host

string / обязательно

Имя хоста Cisco Catalyst Center.

dnac_log

boolean

Флаг для включения/отключения ведения журнала выполнения playbook.

Если true и указан dnac_log_file_path, - Создается файл журнала в месте выполнения с указанным именем.

Если true и dnac_log_file_path не указан, - Создается файл журнала в месте выполнения с именем ‘dnac.log’.

Если false, - Ведение журнала отключено.

Если файл журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”.

Если файл журнала существует, - Он перезаписывается или к нему добавляется информация в зависимости от флага “dnac_log_append”.

Варианты:

  • false ← (default)
  • true

dnac_log_append

boolean

Определяет режим файла. Установите True для режима ‘добавления’. Установите False для режима ‘записи’.

Варианты:

  • false
  • true ← (default)

dnac_log_file_path

string

Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True.

Если путь не указан, - Когда ‘dnac_log_append’ имеет значение True, ‘dnac.log’ создается в текущем каталоге Ansible; журналы добавляются. - Когда ‘dnac_log_append’ имеет значение False, ‘dnac.log’ создается; журналы перезаписываются.

Если путь указан, - Когда ‘dnac_log_append’ имеет значение True, файл открывается в режиме добавления. - Когда ‘dnac_log_append’ имеет значение False, файл открывается в режиме записи (w). - В сценариях с общим файлом, без режима добавления, содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите append в False для первого модуля (для перезаписи); для последующих модулей установите append в True.

Значение по умолчанию: "dnac.log"

dnac_log_level

string

Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG].

CRITICAL указывает на серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL.

ERROR указывает на проблемы, препятствующие работе функции. Отображаются сообщения ERROR и CRITICAL.

WARNING указывает на потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL.

INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL.

DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала.

Значение по умолчанию: "WARNING"

dnac_password

string

Пароль для аутентификации в центре Cisco Catalyst.

dnac_port

string

Указывает номер порта, связанного с центром Cisco Catalyst.

Значение по умолчанию: "443"

dnac_task_poll_interval

integer

Указывает интервал в секундах между последовательными вызовами API для получения сведений о задаче.

Значение по умолчанию: 2

dnac_username

алиасы: user

string

Имя пользователя для аутентификации в центре Cisco Catalyst.

Значение по умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (default)

dnac_version

string

Указывает версию центра Cisco Catalyst, которую должен использовать SDK.

Значение по умолчанию: "2.2.3.3"

state

string

Состояние центра Cisco Catalyst после завершения работы модуля.

Варианты:

  • "merged" ← (default)
  • "deleted"

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK для включения проверки тел запросов на соответствие схеме JSON.

Варианты:

  • false
  • true ← (default)

Примечания

Примечание

  • Используемые методы SDK: system_settings.SystemSettings.add_authentication_and_policy_server_access_configuration, system_settings.SystemSettings.edit_authentication_and_policy_server_access_configuration, system_settings.SystemSettings.accept_cisco_ise_server_certificate_for_cisco_ise_server_integration, system_settings.SystemSettings.delete_authentication_and_policy_server_access_configuration, system_settings.SystemSettings.get_authentication_and_policy_servers, system_settings.SystemSettings.cisco_ise_server_integration_status,
  • Используемые пути: post /dna/intent/api/v1/authentication-policy-servers, put /dna/intent/api/v1/authentication-policy-servers/${id}, put /dna/intent/api/v1/integrate-ise/${id}, delete /dna/intent/api/v1/authentication-policy-servers/${id} get /dna/intent/api/v1/authentication-policy-servers get /dna/intent/api/v1/ise-integration-status
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco Catalyst Center SDK
  • Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: Create an AAA server.
  cisco.dnac.ise_radius_integration_workflow_manager:
    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}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - authentication_policy_server:
      - server_type: AAA
        server_ip_address: 10.0.0.1
        shared_secret: "12345"
        protocol: RADIUS_TACACS
        encryption_scheme: KEYWRAP
        encryption_key: "1234567890123456"
        message_authenticator_code_key: asdfghjklasdfghjklas
        authentication_port: 1812
        accounting_port: 1813
        retries: 3
        timeout: 4
        role: secondary

- name: Create an Cisco ISE server.
  cisco.dnac.ise_radius_integration_workflow_manager:
    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}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - authentication_policy_server:
      - server_type: ISE
        server_ip_address: 10.0.0.2
        shared_secret: "12345"
        protocol: RADIUS_TACACS
        encryption_scheme: KEYWRAP
        encryption_key: "1234567890123456"
        message_authenticator_code_key: asdfghjklasdfghjklas
        authentication_port: 1812
        accounting_port: 1813
        retries: 3
        timeout: 4
        role: primary
        use_dnac_cert_for_pxgrid: False
        pxgrid_enabled: True
        cisco_ise_dtos:
        - user_name: Cisco ISE
          password: "12345"
          fqdn: abs.cisco.com
          ip_address: 10.0.0.2
          description: Cisco ISE
        trusted_server: True
        ise_integration_wait_time: 20

- name: Update an AAA server.
  cisco.dnac.ise_radius_integration_workflow_manager:
    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}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - authentication_policy_server:
      - server_type: AAA
        server_ip_address: 10.0.0.1
        protocol: RADIUS_TACACS
        retries: 3
        timeout: 5

- name: Update an Cisco ISE server.
  cisco.dnac.ise_radius_integration_workflow_manager:
    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}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - authentication_policy_server:
      - server_type: ISE
        server_ip_address: 10.0.0.2
        protocol: RADIUS_TACACS
        retries: 3
        timeout: 5
        use_dnac_cert_for_pxgrid: False
        pxgrid_enabled: True
        cisco_ise_dtos:
        - user_name: Cisco ISE
          password: "12345"
          fqdn: abs.cisco.com
          ip_address: 10.0.0.2
          description: Cisco ISE

- name: Delete an Authentication and Policy server.
  cisco.dnac.ise_radius_integration_workflow_manager:
    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}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: deleted
    config_verify: True
    config:
    - authentication_policy_server:
      - server_ip_address: 10.0.0.1

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

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

Ключ

Описание

response_1

словарь

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_2

словарь

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_3

словарь

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Авторы

  • Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel)

Ссылки на коллекцию

  • Система отслеживания задач
  • Репозиторий (исходный код)

© 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/ise_radius_integration_workflow_manager_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API