Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Если он истинный, используется шлюз 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

строка

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

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

См. также

См. также

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

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

Примеры

- name: Create
  cisco.ise.device_administration_authorization_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_authorization_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_authorization_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_authorization_rules_module.html

Spec-Zone.ru

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