Spec-Zone.ru › Ansible

Модуль cisco.ise.device_administration_authentication_rules – Модуль ресурсов для правил проверки подлинности управления устройствами

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.device_administration_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

string

Параметр пути 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>Логическая агрегация (and,or) указывает, что дополнительные условия присутствуют в поле children</li></ul>.

isNegate

boolean

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

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

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

conditionType

string

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

datesRange

dictionary

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

endDate

string

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

startDate

string

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

datesRangeException

dictionary

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

endDate

string

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

startDate

string

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

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: device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.create_device_admin_authentication_rule, device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.delete_device_admin_authentication_rule_by_id, device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.update_device_admin_authentication_rule_by_id,
  • Используемые пути: post /device-admin/policy-set/{policyId}/authentication, delete /device-admin/policy-set/{policyId}/authentication/{id}, put /device-admin/policy-set/{policyId}/authentication/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

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

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

Примеры

- name: Create
  cisco.ise.device_administration_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.device_administration_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.device_administration_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

словарь

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

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

Пример: {"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

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

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

Пример: {"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/device_administration_authentication_rules_module.html

Spec-Zone.ru

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