Модуль cisco.ise.endpoints_bulk — Модуль ресурсов для массовой обработки конечных точек

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Описание

Управление операциями создания, обновления и удаления ресурсов массовой обработки конечных точек.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
connectedLinks словарь	Подключенные ссылки модуля Сводка конечных устройств.
customAttributes словарь	Пользовательские атрибуты модуля Сводка конечных устройств.
description строка	Описание модуля Сводка конечных устройств.
deviceType строка	Тип устройства модуля Сводка конечных устройств.
groupId строка	Идентификатор группы модуля Сводка конечных устройств.
hardwareRevision строка	Ревизия оборудования модуля Сводка конечных устройств.
id строка	Идентификатор модуля Сводка конечных устройств.
identityStore строка	Хранилище идентификаторов модуля Сводка конечных устройств.
identityStoreId строка	Идентификатор хранилища идентификаторов модуля Сводка конечных устройств.
ipAddress строка	IP-адрес модуля Сводка конечных устройств.
ise_debug логическое	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `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` ← (по умолчанию)
mac строка	MAC-адрес модуля Сводка конечных устройств.
mdmAttributes словарь	Атрибуты MDM модуля Сводка конечных устройств.
name строка	Имя модуля Сводка конечных устройств.

payload список / элементы=словарь	Данные для массовой обработки конечных устройств.
connectedLinks словарь	Связи подключенных устройств для массовой обработки.
customAttributes словарь	Настраиваемые атрибуты для массовой обработки конечных устройств.
description строка	Описание для массовой обработки конечных устройств.
deviceType строка	Тип устройства для массовой обработки.
groupId строка	Идентификатор группы для массовой обработки.
hardwareRevision строка	Ревизия аппаратного обеспечения для массовой обработки.
id строка	Идентификатор для массовой обработки.
identityStore строка	Хранилище идентификации для массовой обработки.
identityStoreId строка	Идентификатор хранилища идентификации для массовой обработки.
ipAddress строка	IP-адрес для массовой обработки.
mac строка	MAC-адрес для массовой обработки.
mdmAttributes словарь	Атрибуты MDM для массовой обработки.
name строка	Название для массовой обработки.
portalUser строка	Пользователь портала для массовой обработки.
productId строка	Идентификатор продукта для массовой обработки.
profileId строка	Идентификатор профиля для массовой обработки.
protocol строка	Протокол для массовой обработки.
serialNumber строка	Серийный номер для массовой обработки.
softwareRevision строка	Ревизия программного обеспечения для массовой обработки.
staticGroupAssignment булево	Флаг статического назначения группы. Варианты: `false` `true`
staticProfileAssignment булево	Флаг статического назначения профиля. Варианты: `false` `true`
vendor строка	Производитель для массовой обработки.
portalUser строка	Пользователь портала для массовой обработки.
productId строка	Идентификатор продукта для массовой обработки.
profileId строка	Идентификатор профиля для массовой обработки.
protocol строка	Протокол для массовой обработки.
serialNumber строка	Серийный номер для массовой обработки.
softwareRevision строка	Ревизия программного обеспечения для массовой обработки.

staticGroupAssignment boolean	Флаг staticGroupAssignment. Варианты: `false` `true`
staticProfileAssignment boolean	Флаг staticProfileAssignment. Варианты: `false` `true`
value string	Параметр пути значения. Идентификатор или MAC-адрес устройства.
vendor string	Производитель устройства в модуле Bulk.

Примечания

Примечание

Используемые методы SDK: endpoints.Endpoints.create_bulk_end_points, endpoints.Endpoints.delete_endpoint, endpoints.Endpoints.update_bulk_end_points, endpoints.Endpoints.update_endpoint,
Используемые пути: post /api/v1/endpoint, post /api/v1/endpoint/bulk, delete /api/v1/endpoint/bulk, delete /api/v1/endpoint/{value}, put /api/v1/endpoint/bulk, put /api/v1/endpoint/{value},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Create
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Update all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Delete all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent

- name: Update by id
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    value: string
    vendor: string

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

Возвращаемые значения

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

Ключ

Описание

ise_response

словарь

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

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

Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

ise_update_response

словарь

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

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

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

Авторы

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/endpoints_bulk_module.html