Spec-Zone.ru › Ansible

Модуль cisco.ise.network_access_policy_set — Модуль ресурсов для набора правил доступа к сети

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.network_access_policy_set.

Добавлена в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

condition

словарь

Условие набора правил доступа к сети.

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

строка

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

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

string

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

startTime

string

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

hoursRangeException

dictionary

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

endTime

string

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

startTime

string

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

id

string

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

isNegate

boolean

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

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

Тип набора правил доступа к сети.

name

string

Имя условия.

operator

string

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

weekDays

list / elements=string

Определяет дни, в которые это условие будет выполняться.
Формат дней - массивы перечислений WeekDay.
По умолчанию - список всех дней недели.

weekDaysException

list / elements=string

Определяет дни, в которые это условие НЕ будет выполняться.
Формат дней - массивы перечислений WeekDay.
По умолчанию - функция отключена.

default

boolean

Флаг, указывающий, является ли этот набор правил стандартным.

Варианты:

  • false
  • true

description

string

Описание набора правил.

hitCounts

integer

Количество совпадений набора правил.

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 для аутентификации.
END_OF_DOCUMENT_MARKER

ise_uses_api_gateway

boolean

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

boolean

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

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

Варианты:

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

isProxy

boolean

Флаг, указывающий, является ли служба набора правил политики «Последовательность проксирования» или «Разрешенные протоколы».

Варианты:

  • false
  • true

link

dictionary

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

href

string

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

rel

string

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

type

string

Тип набора правил политики сетевого доступа.

name

string

Указанное имя набора правил. Допустимые символы: буквенно-цифровые, подчёркивание, тире, пробел, точка, скобки.

rank

integer

Ранг (приоритет) по отношению к другим наборам правил. Более низкий ранг соответствует более высокому приоритету.

serviceName

string

Идентификатор службы набора правил — Разрешенные протоколы, Последовательность серверов.

state_

string

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

Примечания

Примечание

  • Используемые методы SDK: network_access_policy_set.NetworkAccessPolicySet.create_network_access_policy_set, network_access_policy_set.NetworkAccessPolicySet.delete_network_access_policy_set_by_id, network_access_policy_set.NetworkAccessPolicySet.update_network_access_policy_set_by_id,
  • Используемые пути: post /network-access/policy-set, delete /network-access/policy-set/{id}, put /network-access/policy-set/{id},
  • Не поддерживает check_mode
  • Плагин выполняется на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

См. также

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

Полная справка по API наборов правил политики сетевого доступа.

Примеры

- name: Create
  cisco.ise.network_access_policy_set:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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
    description: string
    hitCounts: 0
    id: string
    isProxy: true
    link:
      href: string
      rel: string
      type: string
    name: string
    rank: 0
    serviceName: string
    state_: string

- name: Update by id
  cisco.ise.network_access_policy_set:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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
    description: string
    hitCounts: 0
    id: string
    isProxy: true
    link:
      href: string
      rel: string
      type: string
    name: string
    rank: 0
    serviceName: string
    state_: string

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

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

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

Ключ

Описание

ise_response

словарь

Словарь или список, содержащий ответ, возвращённый Python SDK Cisco ISE.

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

Пример: {"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, "description": "string", "hitCounts": 0, "id": "string", "isProxy": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "rank": 0, "serviceName": "string", "state": "string"}

ise_update_response

словарь

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

Словарь или список, содержащий ответ, возвращённый Python SDK Cisco ISE.

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

Пример: {"response": {"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, "description": "string", "hitCounts": 0, "id": "string", "isProxy": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "rank": 0, "serviceName": "string", "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/network_access_policy_set_module.html

Spec-Zone.ru

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