Spec-Zone.ru › Ansible

Модуль cisco.ise.network_access_authentication_rules – Модуль ресурсов для правил аутентификации доступа к сети

Примечание

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

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

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

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

Новая версия в cisco.ise 1.0.0

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

Обзор

  • Управление операциями создания, обновления и удаления ресурсов правил аутентификации доступа к сети.
  • Доступ к сети — Создание правила аутентификации.
  • Доступ к сети — Удаление правила.
  • Доступ к сети — Обновление правила.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

id

строка

Параметр пути id. Идентификатор правила.

identitySourceId

строка

Идентификатор источника идентификации из хранилищ идентификации.

identitySourceName

строка

Имя источника идентификации из хранилищ идентификации.

ifAuthFail

строка

Действие, выполняемое при неудачной авторизации, например, при неверных учетных данных, отключенном пользователе и т. д.

ifProcessFail

строка

Действие, выполняемое, когда ISE не может получить доступ к базе данных идентификации.

ifUserNotFound

строка

Действие, выполняемое, когда пользователь не найден ни в одном из хранилищ идентификации.

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 для отправки запросов.

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

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

Варианты:

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

ise_uses_csrf_token

булево

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

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

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

Если значение истинно, предполагается, что 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 ← (по умолчанию)

link

словарь

Ссылка правил доступа к сети по авторизации.

href

строка

Ссылка правил доступа к сети по авторизации.

rel

строка

Свойство rel правил доступа к сети по авторизации.

type

строка

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

policyId

строка

Параметр пути policyId. Идентификатор политики.

rule

dictionary

Общие атрибуты в правиле аутентификации/авторизации.

condition

dictionary

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

attributeId

string

Идентификатор атрибута словаря (необязательно), используется для дополнительной проверки.

attributeName

string

Имя атрибута словаря.

attributeValue

string

<ul><li>Значение атрибута для условия</li> <li>Тип значения указан в объекте словаря</li> <li>Если разрешено несколько значений, это указано в объекте словаря</li></ul>.

children

list / elements=dictionary

В случае, если тип — andBlock или orBlock, дополнительные условия будут агрегированы под этим логическим (ИЛИ/И) условием.

conditionType

string

<ul><li>Указывает, является ли запись условием (данные) или логической (или, и) агрегацией</li> <li>Перечисление типа данных (reference, single) указывает, что поля “conditonId” ИЛИ “ConditionAttrs” должны содержать данные условия, но не оба одновременно</li> <li>Логическая агрегация (и, или) перечисление указывает, что дополнительные условия присутствуют в поле children</li></ul>.

isNegate

boolean

Указывает, находится ли это условие в режиме отрицания.

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

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

conditionType

string

<ul><li>Указывает, является ли запись условием (данные) или логической (или, и) агрегацией</li> <li>Перечисление типа данных (reference, single) указывает, что поля “conditonId” ИЛИ “ConditionAttrs” должны содержать данные условия, но не оба одновременно</li> <li>Логическая агрегация (и, или) перечисление указывает, что дополнительные условия присутствуют в поле children</li></ul>.

datesRange

dictionary

<p>Определяет, для каких дат(ы) будет проверяться условие TimeAndDate или НЕ будет проверяться, если используется в свойстве exceptionDates<br> Варианты - Диапазон дат, для конкретной даты следует использовать одну и ту же дату для начальной/конечной даты <br> По умолчанию - нет конкретных дат<br> Чтобы сбросить даты, чтобы не было конкретных дат Формат даты - yyyy-mm-dd (MM = месяц, dd = день, yyyy = год)</p>.

endDate

string

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

startDate

string

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

datesRangeException

dictionary

<p>Определяет, для каких дат(ы) будет проверяться условие TimeAndDate или НЕ будет проверяться, если используется в свойстве exceptionDates<br> Варианты - Диапазон дат, для конкретной даты следует использовать одну и ту же дату для начальной/конечной даты <br> По умолчанию - нет конкретных дат<br> Чтобы сбросить даты, чтобы не было конкретных дат Формат даты - yyyy-mm-dd (MM = месяц, dd = день, yyyy = год)</p>.

endDate

string

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

startDate

string

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

description

string

Описание условия.

dictionaryName

string

Имя словаря.

dictionaryValue

string

Значение словаря.

hoursRange

dictionary

<p>Определяет, в течение каких часов условие TimeAndDate будет соответствовать или не соответствовать, если используется в свойстве exceptionHours<br> Формат времени - чч мм (ч = час, мм = минуты)<br> По умолчанию - весь день</p>.

endTime

string

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

startTime

string

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

hoursRangeException

dictionary

<p>Определяет, в течение каких часов условие TimeAndDate будет соответствовать или не соответствовать, если используется в свойстве exceptionHours<br> Формат времени - чч мм (ч = час, мм = минуты)<br> По умолчанию - весь день</p>.

endTime

string

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

startTime

string

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

id

string

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

isNegate

boolean

Указывает, находится ли это условие в режиме отрицания.

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

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

name

string

Имя условия.

operator

string

Оператор равенства.

weekDays

list / elements=string

<p>Определяет, для каких дней это условие будет соответствовать<br> Формат дней - массивы перечислений WeekDay<br> По умолчанию - список всех дней недели</p>.

weekDaysException

list / elements=string

<p>Определяет, для каких дней это условие НЕ будет соответствовать<br> Формат дней - массивы перечислений WeekDay<br> По умолчанию - не включено</p>.

default

boolean

Указывает, является ли это правило правилом по умолчанию.

Варианты:

  • false
  • true

hitCounts

integer

Количество совпадений правила.

id

string

Идентификатор правила.

name

string

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

rank

integer

Ранг (приоритет) по отношению к другим правилам. Более низкий ранг означает более высокий приоритет.

state

string

Состояние правила. Отключенное правило не может быть сопоставлено.

Примечания

Примечание

  • Используемые методы SDK: network_access_authentication_rules.NetworkAccessAuthenticationRules.create_network_access_authentication_rule, network_access_authentication_rules.NetworkAccessAuthenticationRules.delete_network_access_authentication_rule_by_id, network_access_authentication_rules.NetworkAccessAuthenticationRules.update_network_access_authentication_rule_by_id,
  • Используемые пути: post /network-access/policy-set/{policyId}/authentication, delete /network-access/policy-set/{policyId}/authentication/{id}, put /network-access/policy-set/{policyId}/authentication/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

Документация Cisco ISE по правилам аутентификации сетевого доступа

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

Примеры

- name: Create
  cisco.ise.network_access_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    identitySourceId: string
    identitySourceName: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: string
    link:
      href: string
      rel: string
      type: string
    policyId: string
    rule:
      condition:
        attributeId: string
        attributeName: string
        attributeValue: string
        children:
        - conditionType: string
          isNegate: true
          link:
            href: string
            rel: string
            type: string
        conditionType: string
        datesRange:
          endDate: string
          startDate: string
        datesRangeException:
          endDate: string
          startDate: string
        description: string
        dictionaryName: string
        dictionaryValue: string
        hoursRange:
          endTime: string
          startTime: string
        hoursRangeException:
          endTime: string
          startTime: string
        id: string
        isNegate: true
        link:
          href: string
          rel: string
          type: string
        name: string
        operator: string
        weekDays:
        - string
        weekDaysException:
        - string
      default: true
      hitCounts: 0
      id: string
      name: string
      rank: 0
      state: string

- name: Update by id
  cisco.ise.network_access_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    identitySourceId: string
    identitySourceName: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: string
    link:
      href: string
      rel: string
      type: string
    policyId: string
    rule:
      condition:
        attributeId: string
        attributeName: string
        attributeValue: string
        children:
        - conditionType: string
          isNegate: true
          link:
            href: string
            rel: string
            type: string
        conditionType: string
        datesRange:
          endDate: string
          startDate: string
        datesRangeException:
          endDate: string
          startDate: string
        description: string
        dictionaryName: string
        dictionaryValue: string
        hoursRange:
          endTime: string
          startTime: string
        hoursRangeException:
          endTime: string
          startTime: string
        id: string
        isNegate: true
        link:
          href: string
          rel: string
          type: string
        name: string
        operator: string
        weekDays:
        - string
        weekDaysException:
        - string
      default: true
      hitCounts: 0
      id: string
      name: string
      rank: 0
      state: string

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

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"identitySourceId": "string", "identitySourceName": "string", "ifAuthFail": "string", "ifProcessFail": "string", "ifUserNotFound": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "rule": {"condition": {"attributeId": "string", "attributeName": "string", "attributeValue": "string", "children": [{"conditionType": "string", "isNegate": true, "link": {"href": "string", "rel": "string", "type": "string"}}], "conditionType": "string", "datesRange": {"endDate": "string", "startDate": "string"}, "datesRangeException": {"endDate": "string", "startDate": "string"}, "description": "string", "dictionaryName": "string", "dictionaryValue": "string", "hoursRange": {"endTime": "string", "startTime": "string"}, "hoursRangeException": {"endTime": "string", "startTime": "string"}, "id": "string", "isNegate": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "operator": "string", "weekDays": ["string"], "weekDaysException": ["string"]}, "default": true, "hitCounts": 0, "id": "string", "name": "string", "rank": 0, "state": "string"}}

ise_update_response

словарь

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

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

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

Пример: {"response": {"identitySourceId": "string", "identitySourceName": "string", "ifAuthFail": "string", "ifProcessFail": "string", "ifUserNotFound": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "rule": {"condition": {"attributeId": "string", "attributeName": "string", "attributeValue": "string", "children": [{"conditionType": "string", "isNegate": true, "link": {"href": "string", "rel": "string", "type": "string"}}], "conditionType": "string", "datesRange": {"endDate": "string", "startDate": "string"}, "datesRangeException": {"endDate": "string", "startDate": "string"}, "description": "string", "dictionaryName": "string", "dictionaryValue": "string", "hoursRange": {"endTime": "string", "startTime": "string"}, "hoursRangeException": {"endTime": "string", "startTime": "string"}, "id": "string", "isNegate": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "operator": "string", "weekDays": ["string"], "weekDaysException": ["string"]}, "default": true, "hitCounts": 0, "id": "string", "name": "string", "rank": 0, "state": "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/ise/network_access_authentication_rules_module.html

Spec-Zone.ru

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