Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.device_administration_local_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

строка

Тип правил исключений локальной администрацией устройства.

policyId

строка

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

profile

строка

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

rule

словарь

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

condition

словарь

Условие правил исключений локальной администрацией устройства.
END_OF_DOCUMENT_MARKER

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

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

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

См. также

См. также

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

Полная справка по API управления устройствами Cisco ISE — Правила исключения авторизации.

Примеры

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

- name: Update by id
  cisco.ise.device_administration_local_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
    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

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

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

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

Spec-Zone.ru

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