Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.device_administration_global_exception_rules.

Новая в cisco.ise 1.0.0

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

Обзор

  • Управление операциями создания, обновления и удаления ресурса Правила глобальных исключений управления устройствами.
  • Администрирование устройств - Создание правила глобального исключения авторизации.
  • Администрирование устройств - Удаление правила глобального исключения авторизации.
  • Администрирование устройств - Обновление правила глобального исключения авторизации.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

commands

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

Наборы команд применяют указанный список команд, которые может выполнять администратор устройства.

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

строка

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

rel

строка

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

type

строка

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

profile

строка

Профили администратора устройства контролируют начальную сессию входа администратора устройства.

rule

словарь

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

condition

словарь

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

attributeId

строка

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

attributeName

string

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

attributeValue

string

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

children

list / elements=dictionary

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

conditionType

string

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

isNegate

boolean

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

Выбираемые значения:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

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

conditionType

string

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

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

Примечания

Примечание

  • Используемые методы SDK: device_administration_authorization_global_exception_rules.DeviceAdministrationAuthorizationGlobalExceptionRules.create_device_admin_policy_set_global_exception, device_administration_authorization_global_exception_rules.DeviceAdministrationAuthorizationGlobalExceptionRules.delete_device_admin_policy_set_global_exception_by_rule_id, device_administration_authorization_global_exception_rules.DeviceAdministrationAuthorizationGlobalExceptionRules.update_device_admin_policy_set_global_exception_by_rule_id,
  • Используемые пути: post /device-admin/policy-set/global-exception, delete /device-admin/policy-set/global-exception/{id}, put /device-admin/policy-set/global-exception/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

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

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

Примеры

- name: Create
  cisco.ise.device_administration_global_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    commands:
    - 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

- name: Update by id
  cisco.ise.device_administration_global_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    commands:
    - string
    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

- name: Delete by id
  cisco.ise.device_administration_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

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

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

ise_update_response

словарь

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

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

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

Пример: {"response": {"commands": ["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"}}, "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_global_exception_rules_module.html

Spec-Zone.ru

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