Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Добавлен в cisco.ise 1.0.0

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

Обзор

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

id

строка

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

ise_debug

логическое

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

Варианты:

  • 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 ERS ISE.

Если значение 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

логическое

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

Варианты:

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

link

словарь

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

href

строка

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

rel

строка

Атрибут rel правил доступа к сети.

type

строка

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

policyId

строка

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

profile

список / элементы=строка

Профиль/профили авторизации.

rule

словарь

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

condition

словарь

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

attributeId

строка

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

attributeName

строка

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

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

Конец времени Правил доступа к сети.

startTime

string

Начало времени Правил доступа к сети.

hoursRangeException

dictionary

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

endTime

string

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

startTime

string

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

id

string

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

isNegate

boolean

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

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

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

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

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

securityGroup

string

Группа безопасности, используемая в политиках авторизации.

Примечания

Примечание

  • Используемые методы SDK: network_access_authorization_rules.NetworkAccessAuthorizationRules.create_network_access_authorization_rule, network_access_authorization_rules.NetworkAccessAuthorizationRules.delete_network_access_authorization_rule_by_id, network_access_authorization_rules.NetworkAccessAuthorizationRules.update_network_access_authorization_rule_by_id,
  • Используемые пути: post /network-access/policy-set/{policyId}/authorization, delete /network-access/policy-set/{policyId}/authorization/{id}, put /network-access/policy-set/{policyId}/authorization/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений Cisco ISE SDK.
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения.

См. также

См. также

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

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

Примеры

- name: Create
  cisco.ise.network_access_authorization_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    link:
      href: string
      rel: string
      type: string
    policyId: string
    profile:
    - 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
    securityGroup: string

- name: Update by id
  cisco.ise.network_access_authorization_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    link:
      href: string
      rel: string
      type: string
    policyId: string
    profile:
    - 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
    securityGroup: string

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

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"link": {"href": "string", "rel": "string", "type": "string"}, "profile": ["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"}, "securityGroup": "string"}

ise_update_response

словарь

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

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

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

Пример: {"response": {"link": {"href": "string", "rel": "string", "type": "string"}, "profile": ["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"}, "securityGroup": "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_authorization_rules_module.html

Spec-Zone.ru

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