Модуль cisco.ise.egress_matrix_cell – Модуль ресурсов для ячейки матрицы исходящего трафика

Примечание

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

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

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

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

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

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

Описание

Управление операциями создания, обновления и удаления ресурса «Ячейка матрицы исходящего трафика».
Этот API создаёт ячейку матрицы исходящего трафика.
Этот API удаляет ячейку матрицы исходящего трафика.
Этот API позволяет клиенту обновить ячейку матрицы исходящего трафика.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
defaultRule строка	Допустимые значения - NONE, - DENY_IP, - PERMIT_IP.
description строка	Описание ячейки матрицы исходящего трафика.
destinationSGtId строка	destinationSGtId ячейки матрицы исходящего трафика.
id строка	Идентификатор ячейки матрицы исходящего трафика.
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 для отправки запросов. Если истинно, используется шлюз API ISE и запросы отправляются по адресу https://{{ise_hostname}}. Если ложно, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли токен CSRF в API ERS ISE. Если истинно, SDK предполагает, что проверка CSRF вашего ISE включена. Если истинно, предполагается, что 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` ← (по умолчанию)
matrixCellStatus строка	Допустимые значения - DISABLED, - ENABLED, - MONITOR.
name строка	Имя ячейки матрицы исходящего трафика.
sgacls список / элементы=строка	sgacls ячейки матрицы исходящего трафика.
sourceSGtId строка	sourceSGtId ячейки матрицы исходящего трафика.

Примечания

Примечание

Используемые методы SDK: egress_matrix_cell.EgressMatrixCell.create_egress_matrix_cell, egress_matrix_cell.EgressMatrixCell.delete_egress_matrix_cell_by_id, egress_matrix_cell.EgressMatrixCell.update_egress_matrix_cell_by_id,
Используемые пути: post /ers/config/egressmatrixcell, delete /ers/config/egressmatrixcell/{id}, put /ers/config/egressmatrixcell/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by id
  cisco.ise.egress_matrix_cell:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    defaultRule: string
    description: string
    destinationSgtId: string
    id: string
    matrixCellStatus: string
    name: string
    sgacls:
    - string
    sourceSgtId: string

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

- name: Create
  cisco.ise.egress_matrix_cell:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    defaultRule: string
    description: string
    destinationSgtId: string
    matrixCellStatus: string
    name: string
    sgacls:
    - string
    sourceSgtId: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"defaultRule": "string", "description": "string", "destinationSgtId": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "matrixCellStatus": "string", "name": "string", "sgacls": ["string"], "sourceSgtId": "string"}`
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"defaultRule": "string", "description": "string", "destinationSgtId": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "matrixCellStatus": "string", "name": "string", "sgacls": ["string"], "sourceSgtId": "string"}

ise_update_response

словарь

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

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

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

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/egress_matrix_cell_module.html