Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.device_administration_policy_set.

Новая в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

condition

dictionary

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

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

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

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

ise_uses_api_gateway

boolean

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

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

См. также

См. также

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

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

Примеры

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

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

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

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

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

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

Spec-Zone.ru

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