Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_service_sctp — управление объектами service-sctp на Check Point через API веб-служб

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 6.9.0).

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

Для установки используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_service_sctp.

Добавлено в check_point.mgmt 1.0.0

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управляет объектами service-sctp на устройствах Check Point, включая создание, обновление и удаление объектов.
  • Все операции выполняются через API веб-служб.
  • Доступно начиная с версии системы управления R80.

Параметры

Параметр

Комментарии

aggressive_aging

словарь

Устанавливает короткие (агрессивные) тайм-ауты для неактивных подключений.

default_timeout

целое число

Тайм-аут агрессивного старения по умолчанию, в секундах.

enable

логическое значение

Н/Д

Допустимые значения:

  • false
  • true

timeout

целое число

Тайм-аут агрессивного старения в секундах.

use_default_timeout

логическое значение

Н/Д

Допустимые значения:

  • false
  • true

auto_publish_session

логическое значение

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

Допустимые значения:

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

color

строка

Цвет объекта. Должен быть одним из существующих цветов.

Допустимые значения:

  • "aquamarine"
  • "black"
  • "blue"
  • "crete blue"
  • "burlywood"
  • "cyan"
  • "dark green"
  • "khaki"
  • "orchid"
  • "dark orange"
  • "dark sea green"
  • "pink"
  • "turquoise"
  • "dark blue"
  • "firebrick"
  • "brown"
  • "forest green"
  • "gold"
  • "dark gold"
  • "gray"
  • "dark gray"
  • "light green"
  • "lemon chiffon"
  • "coral"
  • "sea green"
  • "sky blue"
  • "magenta"
  • "purple"
  • "slate blue"
  • "violet red"
  • "navy blue"
  • "olive"
  • "orange"
  • "red"
  • "sienna"
  • "yellow"

comments

строка

Строка с комментариями.

details_level

строка

Уровень детализации некоторых полей ответа: от отображения только значения UID объекта до его полного подробного представления.

Допустимые значения:

  • "uid"
  • "standard"
  • "full"

groups

список / элементы=строка

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

ignore_errors

логическое значение

Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться.

Допустимые значения:

  • false
  • true

ignore_warnings

логическое значение

Применять изменения, игнорируя предупреждения.

Допустимые значения:

  • false
  • true

keep_connections_open_after_policy_installation

логическое значение

Оставлять подключения открытыми после установки политики, даже если новая политика их не разрешает. Этот параметр переопределяет настройки на странице «Сохранение подключений». Изменение этого свойства не повлияет на открытые подключения, а будет применяться только к новым подключениям.

Допустимые значения:

  • false
  • true

match_for_any

логическое значение

Указывает, используется ли эта служба, когда в качестве службы правила задано значение «Any» и имеется несколько объектов службы с одинаковыми исходным портом и протоколом.

Допустимые значения:

  • false
  • true

name

строка / обязательный

Имя объекта.

port

строка

Номер порта. Чтобы указать диапазон портов, поставьте дефис между наименьшим и наибольшим номерами портов, например 44-45.

session_timeout

целое число

Время до истечения срока действия сеанса (в секундах).

source_port

строка

Номер исходного порта. Чтобы указать диапазон портов, поставьте дефис между наименьшим и наибольшим номерами портов, например 44-45.

state

строка

Состояние правила доступа (присутствует или отсутствует).

Допустимые значения:

  • "present" ← (по умолчанию)
  • "absent"

sync_connections_on_cluster

логическое значение

Включает синхронизацию состояния для обеспечения высокой доступности или балансировки нагрузки в кластере ClusterXL или кластере, сертифицированном OPSEC.

Допустимые значения:

  • false
  • true

tags

список / элементы=строка

Список идентификаторов тегов.

use_default_session_timeout

логическое значение

Использовать тайм-аут виртуального сеанса по умолчанию.

Доступно начиная с версии системы управления R80.10.

Допустимые значения:

  • false
  • true

version

строка

Версия Check Point. Если она не указана, используется последняя версия.

wait_for_task

логическое значение

Дождаться завершения задачи, например задачи публикации.

Допустимые значения:

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

wait_for_task_timeout

целое число

Время ожидания в минутах до возникновения ошибки тайм-аута.

По умолчанию: 30

Примеры

- name: add-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_SCTP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

- name: set-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      default_timeout: 3600
    color: green
    name: New_SCTP_Service_1
    port: 5656
    state: present

- name: delete-service-sctp
  cp_mgmt_service_sctp:
    name: New_SCTP_Service_2
    state: absent

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

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

Ключ

Описание

cp_mgmt_service_sctp

словарь

Созданный или обновлённый объект Check Point.

Возвращается: всегда, кроме случаев удаления объекта.

Авторы

  • Or Soffer (@chkp-orso)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/check_point/mgmt/cp_mgmt_service_sctp_module.html

Spec-Zone.ru

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