Spec-Zone.ru › Ansible

Модуль cisco.ise.external_radius_server – Модуль ресурсов для внешнего сервера RADIUS

Примечание

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

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

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

Для использования в playbook укажите: cisco.ise.external_radius_server.

Новая функция в cisco.ise 1.0.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурса «Внешний сервер RADIUS».
  • Этот API создаёт внешний сервер RADIUS.
  • Этот API удаляет внешний сервер RADIUS.
  • Этот API позволяет клиенту обновить внешний сервер RADIUS.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

accountingPort

целое число

Допустимый диапазон от 1 до 65535.

authenticationPort

целое число

Допустимый диапазон от 1 до 65535.

authenticatorKey

строка

authenticatorKey требуется только в том случае, если enableKeyWrap равно true, в противном случае он должен быть проигнорирован или пустым. Максимальная длина составляет 20 символов ASCII или 40 шестнадцатеричных символов (зависит от выбора в поле «keyInputFormat»).

description

строка

Описание внешнего RADIUS-сервера.

enableKeyWrap

логическое значение

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

Варианты:

  • false
  • true

encryptionKey

строка

encryptionKey требуется только в том случае, если enableKeyWrap равно true, в противном случае он должен быть проигнорирован или пустым. Максимальная длина составляет 16 символов ASCII или 32 шестнадцатеричных символов (зависит от выбора в поле «keyInputFormat»).

hostIP

строка

IP-адрес хоста — должен быть допустимым IPv4-адресом.

id

строка

Идентификатор внешнего RADIUS-сервера.

ise_debug

логическое значение

Флаг для включения отладки Identity Services Engine SDK.

Варианты:

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

ise_hostname

строка / обязательно

Имя хоста Identity Services Engine.

ise_password

строка / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

целое число

добавлен в cisco.ise 3.0.0

Таймаут (в секундах) для запросов RESTful HTTP.

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

ise_username

строка / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

логическое значение

добавлен в cisco.ise 1.1.0

Флаг, информирующий SDK о том, следует ли использовать API-шлюз Identity Services Engine для отправки запросов.

Если значение true, используется API-шлюз ISE, и запросы отправляются на https://{{ise_hostname}}.

Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

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

ise_uses_csrf_token

логическое значение

добавлен в cisco.ise 3.0.0

Флаг, информирующий SDK о том, отправлять ли токен CSRF в API ISE ERS.

Если значение True, SDK предполагает, что проверка CSRF ISE включена.

Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

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

ise_verify

логическое значение

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

Варианты:

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

ise_version

строка

Указывает SDK, какую версию Identity Services Engine использовать.

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

ise_wait_on_rate_limit

логическое значение

Флаг для Identity Services Engine SDK для включения автоматической обработки лимита запросов.

Варианты:

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

keyInputFormat

строка

Указывает формат ввода для полей «encryptionKey» и «authenticatorKey». Допустимые значения — ASCII и HEXADECIMAL.

name

строка

Имя ресурса. Допустимые символы — буквенно-цифровые и _ (нижнее подчеркивание).

proxyTimeout

integer

Диапазон допустимых значений: от 1 до 600.

retries

integer

Диапазон допустимых значений: от 1 до 9.

sharedSecret

string

Максимальная длина общего секрета составляет 128 символов.

timeout

integer

Диапазон допустимых значений: от 1 до 120.

Примечания

Примечание

  • Используемые методы SDK: external_radius_server.ExternalRadiusServer.create_external_radius_server, external_radius_server.ExternalRadiusServer.delete_external_radius_server_by_id, external_radius_server.ExternalRadiusServer.update_external_radius_server_by_id,
  • Используемые пути: post /ers/config/externalradiusserver, delete /ers/config/externalradiusserver/{id}, put /ers/config/externalradiusserver/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by id
  cisco.ise.external_radius_server:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountingPort: 0
    authenticationPort: 0
    authenticatorKey: string
    description: string
    enableKeyWrap: true
    encryptionKey: string
    hostIP: string
    id: string
    keyInputFormat: string
    name: string
    proxyTimeout: 0
    retries: 0
    sharedSecret: string
    timeout: 0

- name: Delete by id
  cisco.ise.external_radius_server:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.external_radius_server:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountingPort: 0
    authenticationPort: 0
    authenticatorKey: string
    description: string
    enableKeyWrap: true
    encryptionKey: string
    hostIP: string
    keyInputFormat: string
    name: string
    proxyTimeout: 0
    retries: 0
    sharedSecret: string
    timeout: 0

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"accountingPort": 0, "authenticationPort": 0, "authenticatorKey": "string", "description": "string", "enableKeyWrap": true, "encryptionKey": "string", "hostIP": "string", "id": "string", "keyInputFormat": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "proxyTimeout": 0, "retries": 0, "sharedSecret": "string", "timeout": 0}

ise_update_response

словарь

добавлено в cisco.ise 1.1.0

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

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

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/ise/external_radius_server_module.html

Spec-Zone.ru

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