Spec-Zone.ru › Ansible

Модуль cisco.ise.network_access_global_exception_rules – Модуль ресурсов для правил глобальных исключений доступа к сети

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурса «Правила глобальных исключений доступа к сети».
  • Доступ к сети – создание глобального правила авторизации исключений.
  • Доступ к сети – удаление глобального правила авторизации исключений.
  • Доступ к сети – обновление глобального правила авторизации исключений.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

id

строка

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

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 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

булево

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

Варианты:

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

link

словарь

Ссылка на глобальные исключения доступа к сети.

href

строка

Ссылка href на глобальные исключения доступа к сети.

rel

строка

Атрибут rel глобальных исключений доступа к сети.

type

строка

Тип глобальных исключений доступа к сети.

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>Логическая агрегация (и, или) перечисление указывает на наличие дополнительных условий в поле 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

Конечная дата для правил глобальных исключений сетевого доступа.

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

Свойство href правил глобальных исключений доступа к сети.

rel

string

Свойство rel правил глобальных исключений доступа к сети.

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_global_exception_rules.NetworkAccessAuthorizationGlobalExceptionRules.create_network_access_policy_set_global_exception_rule, network_access_authorization_global_exception_rules.NetworkAccessAuthorizationGlobalExceptionRules.delete_network_access_policy_set_global_exception_rule_by_id, network_access_authorization_global_exception_rules.NetworkAccessAuthorizationGlobalExceptionRules.update_network_access_policy_set_global_exception_rule_by_id,
  • Используемые пути: post /network-access/policy-set/global-exception, delete /network-access/policy-set/global-exception/{id}, put /network-access/policy-set/global-exception/{id},
  • Не поддерживает check_mode
  • Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

См. также

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

Полное описание API правил глобальных исключений авторизации доступа к сети.

Примеры

- name: Create
  cisco.ise.network_access_global_exception_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
    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_global_exception_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
    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_global_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

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

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

Ключ

Описание

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_global_exception_rules_module.html

Spec-Zone.ru

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