Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_lsm_gateway — управление объектами lsm-gateway в 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_lsm_gateway.

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

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

Обзор

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

Параметры

Параметр

Комментарии

auto_publish_session

boolean

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

Варианты:

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

color

string

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

Варианты:

  • "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

string

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

details_level

string

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

Варианты:

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

device_id

string

добавлено в check_point.mgmt 6.3.0

Идентификатор устройства.

Доступно начиная с версии управления R81.20.

dynamic_objects

list / elements=dictionary

добавлено в check_point.mgmt 6.3.0

Динамические объекты.

Доступно начиная с версии управления R81.20.

name

string

Имя объекта. Должно быть уникальным в домене.

resolved_ip_addresses

list / elements=dictionary

Один IP-адрес или диапазон адресов.

ipv4_address

string

IPv4-адрес.

ipv4_address_range

dictionary

Диапазон IPv4-адресов.

from_ipv4_address

string

to_ipv4_address

string

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

name

string / обязательный

Имя объекта.

provisioning_settings

dictionary

Параметры подготовки.

provisioning_profile

string

Профиль подготовки.

provisioning_state

string

Состояние подготовки. По умолчанию используется состояние «manual» — подготовка включена, но профиль не назначен.

Если указано состояние «using-profile», в параметре provisioning-settings необходимо указать профиль подготовки.

Варианты:

  • "off"
  • "manual"
  • "using-profile"

security_profile

string

Профиль LSM.

sic

dictionary

Защищённая внутренняя связь.

ip_address

string

IP-адрес. Если IP-адрес указан, немедленно инициировать доверенное соединение с использованием этого IP-адреса.

one_time_password

string

Одноразовый пароль. Если одноразовый пароль указан без IP-адреса, доверенное соединение будет автоматически инициировано при первом подключении шлюза к серверу управления безопасностью.

state

string

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

Варианты:

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

tags

list / elements=string

добавлено в check_point.mgmt 6.3.0

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

topology

dictionary

добавлено в check_point.mgmt 6.3.0

Топология.

Доступно начиная с версии управления R81.20.

manual_vpn_domain

list / elements=dictionary

Список диапазонов IP-адресов, определяющих сеть сообщества VPN.

Это поле учитывается только при установленном флажке параметра vpn-domain «manual».

comments

string

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

from_ipv4_address

string

Первый IPv4-адрес диапазона IP-адресов.

to_ipv4_address

string

Последний IPv4-адрес диапазона IP-адресов.

vpn_domain

string

Тип домена VPN. Параметр «external-interfaces-only» применим только к устройствам Gaia. Параметр «hide-behind-gateway-external-ip-address» применим только к устройствам SMB.

Варианты:

  • "not-defined"
  • "external-ip-addresses-only"
  • "hide-behind-gateway-external-ip-address"
  • "all-ip-addresses-behind-the-gateway"
  • "manual"

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present

- name: set-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present

- name: delete-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    state: absent

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

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

Ключ

Описание

cp_mgmt_lsm_gateway

dictionary

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

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

Авторы

  • Shiran Golzar (@chkp-shirango)

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

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

© 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_lsm_gateway_module.html

Spec-Zone.ru

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