Модуль cisco.ise.px_grid_direct – Модуль ресурсов для Px Grid Direct

Примечание

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

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

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

Для использования его в книге задач, укажите: cisco.ise.px_grid_direct.

Новая в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление операциями создания, обновления и удаления ресурса Px Grid Direct.
PxGrid Direct - Настройка информации о конфигурации подключения.
PxGrid Direct - Удаление информации о конфигурации подключения на основе ConnectorName.
PxGrid Direct - Обновление информации о конфигурации подключения на основе ConnectorName.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
additionalProperties словарь	Дополнительные свойства Px Grid Direct.
attributes словарь	Имя соединителя.
attributeMapping список / элементы=словарь	<p>Список имён функций</p>.
dictionaryAttribute строка	dictionaryAttribute Px Grid Direct.
includeInDictionary булево	Флаг IncludeInDictionary. Варианты: `false` `true`
jsonAttribute строка	jsonAttribute Px Grid Direct.
correlationIdentifier строка	Уникальность для идентификации.
topLevelObject строка	Корневой уровень json.
uniqueIdentifier строка	Уникальность для идентификации.
versionIdentifier строка	Уникальность версии для идентификации.
connectorName строка	Имя соединителя.
connectorType строка	Список типов соединителей.
deltasyncSchedule словарь	deltasyncSchedule Px Grid Direct.
interval целое число	Запуск через интервал (часов).
intervalUnit строка	Единицы интервала.
startDate строка	Дата и время начала.
description строка	Описание.
enabled булево	Флаг включения. Варианты: `false` `true`
fullsyncSchedule словарь	fullsyncSchedule Px Grid Direct.
interval целое число	Запуск через интервал (часов).
intervalUnit строка	Единицы интервала.
startDate строка	Дата и время начала.
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 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` ← (по умолчанию)
protocol string	Протокол.
skipCertificateValidations boolean	Флаг skipCertificateValidations. Варианты: `false` `true`
url dictionary	URL Px Grid Direct.
authenticationType string	Список типов аутентификации.
bulkUrl string	BulkUrl.
incrementalUrl string	IncrementalUrl.
password string	Пароль.
userName string	Имя пользователя.

Примечания

Примечание

Используемые методы SDK: px_grid_direct.PxGridDirect.create_connector_config, px_grid_direct.PxGridDirect.delete_connector_config_by_connector_name, px_grid_direct.PxGridDirect.update_connector_config_by_connector_name,
Используемые пути: post /api/v1/pxgrid-direct/connector-config, delete /api/v1/pxgrid-direct/connector-config/{connectorName}, put /api/v1/pxgrid-direct/connector-config/{connectorName},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Create
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
      - dictionaryAttribute: string
        includeInDictionary: true
        jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string

- name: Update by name
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
      - dictionaryAttribute: string
        includeInDictionary: true
        jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string

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

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: {"connector": {"additionalProperties": {}, "attributes": {"attributeMapping": [{"dictionaryAttribute": "string", "includeInDictionary": true, "jsonAttribute": "string"}], "correlationIdentifier": "string", "topLevelObject": "string", "uniqueIdentifier": "string", "versionIdentifier": "string"}, "connectorName": "string", "connectorType": "string", "deltasyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "description": "string", "enabled": true, "fullsyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "protocol": "string", "skipCertificateValidations": true, "url": {"authenticationType": "string", "bulkUrl": "string", "incrementalUrl": "string", "password": "string", "userName": "string"}}}
ise_update_response строка добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `"\"'string'\"\n"`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"connector": {"additionalProperties": {}, "attributes": {"attributeMapping": [{"dictionaryAttribute": "string", "includeInDictionary": true, "jsonAttribute": "string"}], "correlationIdentifier": "string", "topLevelObject": "string", "uniqueIdentifier": "string", "versionIdentifier": "string"}, "connectorName": "string", "connectorType": "string", "deltasyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "description": "string", "enabled": true, "fullsyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "protocol": "string", "skipCertificateValidations": true, "url": {"authenticationType": "string", "bulkUrl": "string", "incrementalUrl": "string", "password": "string", "userName": "string"}}}

ise_update_response

строка

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

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

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

Пример: "\"'string'\"\n"

Авторы

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