Spec-Zone.ru › Ansible

Модуль cisco.ise.network_access_conditions – Модуль ресурсов для Условий доступа к сети

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.ise.network_access_conditions.

Новая версия в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

attributeId

строка

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

attributeName

строка

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

attributeValue

строка

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

children

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

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

conditionType

строка

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

isNegate

логическое

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

Варианты:

  • false
  • true

link

словарь

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

href

строка

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

rel

строка

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

type

строка

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

conditionType

строка

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

datesRange

словарь

<p>Определяет, для каких дат будет соответствовать или не соответствовать условие TimeAndDate, если используется в свойстве exceptionDates<br> Варианты — диапазон дат, для конкретной даты, должна использоваться та же дата для начальной/конечной даты <br> По умолчанию — нет конкретных дат<br> Для сброса дат до отсутствия конкретных дат формат даты — yyyy-mm-dd (MM = месяц, dd = день, yyyy = год)</p>.

endDate

строка

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

startDate

строка

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

datesRangeException

словарь

<p>Определяет, для каких дат будет соответствовать или не соответствовать условие TimeAndDate, если используется в свойстве exceptionDates<br> Варианты — диапазон дат, для конкретной даты, должна использоваться та же дата для начальной/конечной даты <br> По умолчанию — нет конкретных дат<br> Для сброса дат до отсутствия конкретных дат формат даты — yyyy-mm-dd (MM = месяц, dd = день, yyyy = год)</p>.

endDate

строка

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

startDate

строка

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

description

строка

Описание условия.

dictionaryName

строка

Имя словаря.

dictionaryValue

строка

Значение словаря.

hoursRange

словарь

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

endTime

строка

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

startTime

строка

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

hoursRangeException

dictionary

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

endTime

string

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

startTime

string

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

id

string

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

ise_debug

boolean

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

Варианты:

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

ise_hostname

string / обязательно

Имя хоста Identity Services Engine.

ise_password

string / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

integer

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

Таймаут (в секундах) для RESTful HTTP-запросов.

По умолчанию: 60

ise_username

string / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

boolean

добавлен в 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

boolean

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

Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE.

Если значение true, SDK предполагает, что проверка CSRF вашего ISE включена.

Если значение true, предполагается, что вам нужен SDK для автоматического управления токеном CSRF.

Варианты:

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

ise_verify

boolean

Флаг для включения или отключения проверки сертификатов SSL.

Варианты:

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

ise_version

string

Сообщает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

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

Варианты:

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

isNegate

boolean

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

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

Свойство rel условий сетевого доступа.

type

string

Тип условий сетевого доступа.

name

string

Имя условия.

operator

string

Оператор равенства.
END_OF_DOCUMENT_MARKER

weekDays

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

<p>Определяет, для каких дней будет соответствовать данному условию<br> Формат дней - Массивы перечислений WeekDay<br> По умолчанию - Список всех дней недели</p>.

weekDaysException

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

<p>Определяет, для каких дней данному условию НЕ будет соответствовать<br> Формат дней - Массивы перечислений WeekDay<br> По умолчанию - Не включено</p>.

Примечания

Примечание

  • Используемые методы SDK: network_access_conditions.NetworkAccessConditions.create_network_access_condition, network_access_conditions.NetworkAccessConditions.delete_network_access_condition_by_id, network_access_conditions.NetworkAccessConditions.delete_network_access_condition_by_name, network_access_conditions.NetworkAccessConditions.update_network_access_condition_by_id, network_access_conditions.NetworkAccessConditions.update_network_access_condition_by_name,
  • Используемые пути: post /network-access/condition, delete /network-access/condition/condition-by-name/{name}, delete /network-access/condition/{id}, put /network-access/condition/condition-by-name/{name}, put /network-access/condition/{id},
  • Не поддерживает check_mode
  • Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

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

Полное описание API условий сетевого доступа.

Примеры

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

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

- name: Delete by name
  cisco.ise.network_access_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: string

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

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

Возвращаемое значение: всегда

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

ise_update_response

словарь

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

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

Возвращаемое значение: всегда

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

Spec-Zone.ru

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