модуль check_point.mgmt.cp_mgmt_lsm_cluster — управление объектами lsm-cluster на Checkpoint через 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_cluster.
Добавлено в check_point.mgmt 2.3.0
Краткое описание
- Управляет объектами lsm-cluster на устройствах Checkpoint, в том числе создаёт, обновляет и удаляет объекты.
- Все операции выполняются через API веб-служб.
- Доступно начиная с версии системы управления R81.10.
Параметры
Параметр | Комментарии |
|---|---|
auto_publish_session логическое значение | Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты:
|
color строка | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments строка | Строка с комментариями. |
details_level строка | Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до полного представления объекта. Варианты:
|
dynamic_objects список / элементы=словарь добавлено в check_point.mgmt 6.3.0 | Динамические объекты. Доступно начиная с версии системы управления R81.20. |
|
name строка |
Имя объекта. Должно быть уникальным в домене. |
|
resolved_ip_addresses список / элементы=словарь |
Один IP-адрес или диапазон адресов. |
|
ipv4_address строка |
IPv4-адрес. |
|
ipv4_address_range словарь |
Диапазон IPv4-адресов. |
|
from_ipv4_address строка |
Первый IPv4-адрес диапазона IP-адресов. |
|
to_ipv4_address строка |
Последний IPv4-адрес диапазона IP-адресов. |
ignore_errors логическое значение | Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings логическое значение | Применять изменения, игнорируя предупреждения. Варианты:
|
interfaces список / элементы=словарь | Интерфейсы. |
|
ip_address_override строка |
Переопределение IP-адреса. Маска сети задаётся подключённым профилем LSM. |
|
member_network_override строка |
Переопределение сети участника. Маска сети задаётся подключённым профилем LSM. |
|
name строка |
Имя интерфейса. |
main_ip_address строка | Основной IP-адрес. |
members список / элементы=словарь | Участники. |
|
color строка |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments строка |
Строка с комментариями. |
|
name строка |
Имя объекта. |
|
provisioning_settings словарь |
Параметры подготовки. Это поле используется только для кластеров SMB. |
|
provisioning_profile строка |
Профиль подготовки. |
|
provisioning_state строка |
Состояние подготовки. Это поле используется только для кластеров SMB. По умолчанию состояние — «manual»: подготовка включена, но профиль не подключён. Если указано состояние «using-profile», в provisioning-settings необходимо указать профиль подготовки. Варианты:
|
|
sic словарь |
Безопасный внутренний обмен данными. |
|
ip_address строка |
IP-адрес. Если указан IP-адрес, немедленно инициируется доверенное соединение с использованием этого IP-адреса. |
|
one_time_password строка |
Одноразовый пароль. Если одноразовый пароль указан без IP-адреса, доверенное соединение автоматически инициируется при первом подключении шлюза к серверу управления безопасностью. |
|
tags список / элементы=строка |
Набор идентификаторов тегов. |
name_prefix строка | Префикс, добавляемый к имени профиля для создания имени кластера LSM. |
name_suffix строка | Суффикс, добавляемый к имени профиля для создания имени кластера LSM. |
security_profile строка / обязательный | Профиль LSM. |
state строка | Состояние правила доступа (present или absent). Варианты:
|
tags список / элементы=строка добавлено в check_point.mgmt 6.3.0 | Набор идентификаторов тегов. |
topology словарь добавлено в check_point.mgmt 6.3.0 | Топология. Доступно начиная с версии системы управления R81.20. |
|
manual_vpn_domain список / элементы=словарь |
Список диапазонов IP-адресов, определяющих сеть сообщества VPN. Это поле используется только при выборе параметра «manual» для vpn-domain. |
|
comments строка |
Строка с комментариями. |
|
from_ipv4_address строка |
Первый IPv4-адрес диапазона IP-адресов. |
|
to_ipv4_address строка |
Последний IPv4-адрес диапазона IP-адресов. |
|
vpn_domain строка |
Тип домена VPN. «external-interfaces-only» применим только к устройствам Gaia. «hide-behind-gateway-external-ip-address» применим только к устройствам SMB. Варианты:
|
version строка | Версия Checkpoint. Если она не указана, используется последняя версия. |
wait_for_task логическое значение | Дождаться завершения задачи, например задачи публикации. Варианты:
|
wait_for_task_timeout целое число | Сколько минут ожидать до возникновения ошибки тайм-аута. По умолчанию: |
Примеры
- name: add-lsm-cluster
cp_mgmt_lsm_cluster:
interfaces:
- ip_address_override: 192.168.8.197
member_network_override: 192.168.8.0
name: eth0
new_name: WAN
- ip_address_override: 10.8.197.1
member_network_override: 10.8.197.0
name: eth1
new_name: LAN1
- member_network_override: 10.10.10.0
name: eth2
main_ip_address: 192.168.8.197
members:
- name: Gaia_gw1
sic:
ip_address: 192.168.8.200
one_time_password: aaaa
- name: Gaia_gw2
sic:
ip_address: 192.168.8.202
one_time_password: aaaa
name_prefix: Gaia_
security_profile: gaia_cluster
state: present
- name: set-lsm-cluster
cp_mgmt_lsm_cluster:
interfaces:
- ip_address_override: 192.168.8.197
member_network_override: 192.168.8.0
name: eth0
new_name: WAN
- ip_address_override: 10.8.197.1
member_network_override: 10.8.197.0
name: eth1
new_name: LAN1
- member_network_override: 10.10.10.0
name: eth2
members:
- name: Gaia_gw1
sic:
ip_address: 192.168.8.200
one_time_password: aaaa
- name: Gaia_gw2
sic:
ip_address: 192.168.8.202
one_time_password: aaaa
name: Gaia_gaia_cluster
state: present
- name: delete-lsm-cluster
cp_mgmt_lsm_cluster:
name: lsm_cluster
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_lsm_cluster словарь | Созданный или обновлённый объект Checkpoint. Возвращается: всегда, кроме случаев удаления объекта. |
Ссылки на коллекцию
© 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_cluster_module.html