Модуль check_point.mgmt.cp_mgmt_vsx_provisioning_tool — запуск инструмента подготовки VSX с указанными параметрами.

add_physical_interface_params

dictionary

Параметры операции добавления физического интерфейса к шлюзу VSX или кластеру VSX.

name

string

Имя интерфейса.

vlan_trunk

boolean

True, если этот интерфейс является транком VLAN.

Варианты:

• false
• true

vsx_name

string

Имя объекта шлюза VSX или кластера.

add_route_params

dictionary

Параметры операции добавления маршрута в виртуальную систему или виртуальный маршрутизатор.

destination

string

Назначение маршрута. Чтобы указать маршрут по умолчанию, используйте ‘default’ для IPv4 и ‘default6’ для IPv6.

leads_to

string

Виртуальный маршрутизатор для этого маршрута<br/>Это VD должно иметь существующее подключение к VR.

netmask

string

Маска подсети для этого маршрута.

next_hop

string

IP-адрес следующего перехода.

prefix

string

Префикс CIDR для этого маршрута.

propagate

boolean

Распространять этот маршрут на соседние виртуальные устройства.

Варианты:

• false
• true

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

add_vd_interface_params

dictionary

Параметры операции добавления нового интерфейса к виртуальному устройству.

anti_spoofing

string

Настройка применения защиты от подмены IP-адреса для этого интерфейса.

Варианты:

• "prevent"
• "detect"
• "off"

anti_spoofing_tracking

string

Настройка отслеживания защиты от подмены IP-адреса для этого интерфейса.

Варианты:

• "none"
• "alert"
• "log"

ipv4_address

string

IPv4-адрес этого интерфейса с необязательным префиксом CIDR.<br/>Обязателен, если интерфейс принадлежит виртуальной системе или виртуальному маршрутизатору.

ipv4_netmask

string

Маска подсети IPv4 для этого интерфейса.

ipv4_prefix

string

Префикс CIDR IPv4 для этого интерфейса.

ipv6_address

string

IPv6-адрес этого интерфейса<br/>Обязателен, если интерфейс принадлежит виртуальной системе или виртуальному маршрутизатору.

ipv6_netmask

string

Маска подсети IPv6 для этого интерфейса.

ipv6_prefix

string

Префикс CIDR IPv6 для этого интерфейса.

leads_to

string

Виртуальный коммутатор или виртуальный маршрутизатор для этого интерфейса.

mtu

integer

MTU этого интерфейса.

name

string

Имя интерфейса.

propagate

boolean

Распространять маршрут IPv4 на соседние виртуальные устройства.

Варианты:

• false
• true

propagate6

boolean

Распространять маршрут IPv6 на соседние виртуальные устройства.

Варианты:

• false
• true

specific_group

string

Определённая группа для топологии интерфейса.<br/>Используется только с параметром топологии ‘internal_specific’.

topology

string

Топология этого интерфейса.<br/>Для этой VS необходимо отключить автоматический расчёт топологии на основе маршрутов.

Варианты:

• "external"
• "internal_undefined"
• "internal_this_network"
• "internal_specific"
• "defined_by_routes"

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

vti_settings

dictionary

Настройки VTI для этого интерфейса. На этой виртуальной системе должен быть включён компонент VPN.

local_ipv4_address

string

IPv4-адрес VPN-туннеля на этой виртуальной системе.

peer_name

string

Имя объекта удалённого узла, заданного в VPN-сообществе.

remote_ipv4_address

string

IPv4-адрес VPN-туннеля на удалённом VPN-узле.

tunnel_id

string

Необязательный уникальный идентификатор туннеля.<br/>Если значение не задано, система присвоит его автоматически.

add_vd_params

dictionary

Параметры операции добавления нового виртуального устройства (VS/VSB/VSW/VR).

calc_topology_auto

boolean

Автоматически рассчитывать топологию интерфейса на основе маршрутов.<br/>Применимо только к виртуальным системам.<br/>Не используйте для виртуальных устройств.

Варианты:

• false
• true

interfaces

list / elements=dictionary

Список интерфейсов для этого нового виртуального устройства.<br/>Необязателен, если новое VD является виртуальным коммутатором.

anti_spoofing

string

Настройка применения защиты от подмены IP-адреса для этого интерфейса.

Варианты:

• "prevent"
• "detect"
• "off"

anti_spoofing_tracking

string

Настройка отслеживания защиты от подмены IP-адреса для этого интерфейса.

Варианты:

• "none"
• "alert"
• "log"

ipv4_address

string

IPv4-адрес этого интерфейса с необязательным префиксом CIDR.<br/>Обязателен, если интерфейс принадлежит виртуальной системе или виртуальному маршрутизатору.

ipv4_netmask

string

Маска подсети IPv4 для этого интерфейса.

ipv4_prefix

string

Префикс CIDR IPv4 для этого интерфейса.

ipv6_address

string

IPv6-адрес этого интерфейса<br/>Обязателен, если интерфейс принадлежит виртуальной системе или виртуальному маршрутизатору.

ipv6_netmask

string

Маска подсети IPv6 для этого интерфейса.

ipv6_prefix

string

Префикс CIDR IPv6 для этого интерфейса.

leads_to

string

Виртуальный коммутатор или виртуальный маршрутизатор для этого интерфейса.

mtu

integer

MTU этого интерфейса.

name

string

Имя интерфейса.

propagate

boolean

Распространять маршрут IPv4 на соседние виртуальные устройства.

Варианты:

• false
• true

propagate6

boolean

Распространять маршрут IPv6 на соседние виртуальные устройства.

Варианты:

• false
• true

specific_group

string

Определённая группа для топологии интерфейса.<br/>Используется только с параметром топологии ‘internal_specific’.

topology

string

Топология этого интерфейса.<br/>Для этой VS необходимо отключить автоматический расчёт топологии на основе маршрутов.

Варианты:

• "external"
• "internal_undefined"
• "internal_this_network"
• "internal_specific"
• "defined_by_routes"

ipv4_address

string

Основной IPv4-адрес.<br/>Обязателен, если это устройство является виртуальной системой.<br/>Не используйте для других виртуальных устройств.

ipv4_instances

integer

Количество экземпляров IPv4 для виртуальной системы.<br/>Значение должно быть не меньше 1.<br/>Применимо только к виртуальным системам и виртуальным системам в режиме моста.

ipv6_address

string

Основной IPv6-адрес.<br/>Обязателен, если это устройство является виртуальной системой.<br/>Не используйте для других виртуальных устройств.

ipv6_instances

integer

Количество экземпляров IPv6 для виртуальной системы.<br/>Применимо только к виртуальным системам и виртуальным системам в режиме моста.

routes

list / elements=dictionary

Список маршрутов для этого нового виртуального устройства (только VS или VR).

destination

string

Назначение маршрута. Чтобы указать маршрут по умолчанию, используйте ‘default’ для IPv4 и ‘default6’ для IPv6.

leads_to

string

Виртуальный маршрутизатор для этого маршрута<br/>Это VD должно иметь существующее подключение к VR.

netmask

string

Маска подсети для этого маршрута.

next_hop

string

IP-адрес следующего перехода.

prefix

string

Префикс CIDR для этого маршрута.

propagate

boolean

Распространять этот маршрут на соседние виртуальные устройства.

Варианты:

• false
• true

type

string

Тип виртуального устройства <br><br>vs — виртуальный межсетевой экран<br>vr — виртуальный маршрутизатор<br>vsw — виртуальный коммутатор<br>vsbm — виртуальный межсетевой экран в режиме моста.

Варианты:

• "vs"
• "vr"
• "vsw"
• "vsbm"

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

vs_mtu

integer

MTU виртуальной системы.<br/>Применяется только к виртуальным системам в режиме моста.<br/>Не используйте для других виртуальных устройств.

vsx_name

string

Имя объекта шлюза или кластера VSX.

add_vsx_cluster_params

dictionary

Параметры операции добавления нового кластера VSX.

cluster_type

string

Тип объекта кластера VSX.<br/>Начиная с R81.10, при создании кластера можно настроить только VSLS.<br/>Чтобы использовать режим высокой доступности («ha»), сначала создайте кластер как VSLS, а затем запустите vsx_util на сервере управления.

Варианты:

• "vsls"
• "ha"

ipv4_address

string

Основной IPv4-адрес объекта шлюза или кластера VSX.<br/>Необязательный, если указан основной IPv6-адрес.

ipv6_address

string

Основной IPv6-адрес объекта шлюза или кластера VSX.<br/>Необязательный, если указан основной IPv4-адрес.

members

list / elements=dictionary

Список участников нового кластера VSX. Не менее 2.

ipv4_address

string

Основной IPv4-адрес участника кластера VSX.<br/>Обязательный, если у кластера VSX есть IPv4-адрес.

ipv6_address

string

Основной IPv6-адрес участника кластера VSX.<br/>Обязательный, если у кластера VSX есть IPv6-адрес.

name

string

Имя нового участника кластера VSX.

sic_otp

string

Одноразовый пароль SIC для шлюза VSX или участника кластера.<br/>Длина пароля должна составлять от 4 до 127 символов.

sync_ip

string

IP-адрес синхронизации для участника кластера VSX.

rule_drop

string

Добавить правило запрета по умолчанию в начальную политику шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_https

string

Добавить правило, разрешающее HTTPS-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ping

string

Добавить правило, разрешающее ping-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ping6

string

Добавить правило, разрешающее ping6-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_snmp

string

Добавить правило, разрешающее SNMP-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ssh

string

Добавить правило, разрешающее SSH-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

sync_if_name

string

Имя интерфейса синхронизации для кластера VSX.

sync_netmask

string

Маска подсети интерфейса синхронизации для кластера VSX.

vsx_name

string

Имя объекта шлюза или кластера VSX.

vsx_version

string

Версия объекта шлюза или кластера VSX.

add_vsx_gateway_params

dictionary

Параметры операции добавления нового шлюза VSX.

ipv4_address

string

Основной IPv4-адрес объекта шлюза или кластера VSX.<br/>Необязательный, если указан основной IPv6-адрес.

ipv6_address

string

Основной IPv6-адрес объекта шлюза или кластера VSX.<br/>Необязательный, если указан основной IPv4-адрес.

rule_drop

string

Добавить правило запрета по умолчанию в начальную политику шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_https

string

Добавить правило, разрешающее HTTPS-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ping

string

Добавить правило, разрешающее ping-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ping6

string

Добавить правило, разрешающее ping6-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_snmp

string

Добавить правило, разрешающее SNMP-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

rule_ssh

string

Добавить правило, разрешающее SSH-трафик в начальной политике шлюза или кластера VSX.

Варианты:

• "enable"
• "disable"

sic_otp

string

Одноразовый пароль SIC для шлюза VSX или участника кластера.<br/>Длина пароля должна составлять от 4 до 127 символов.

vsx_name

string

Имя объекта шлюза или кластера VSX.

vsx_version

string

Версия объекта шлюза или кластера VSX.

attach_bridge_params

dictionary

Параметры операции подключения нового интерфейса-моста к виртуальной системе.

ifs1

string

Имя первого интерфейса моста.

ifs2

string

Имя второго интерфейса моста.

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

auto_publish_session

boolean

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

Варианты:

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

operation

string

Имя операции подготовки к запуску. Для каждой операции предусмотрен свой набор параметров.<br> Доступны следующие операции:<ul><li><i>add-vsx-gateway</i> — добавляет новый шлюз VSX</li><li><i>add-vsx-cluster</i> — добавляет новый кластер VSX*</li><li><i>add-vsx-cluster-member</i> — добавляет нового участника кластера VSX*</li><li><i>add-vd</i> — добавляет новое виртуальное устройство (VS/VSB/VSW/VR) к шлюзу VSX или кластеру VSX</li><li><i>add-vd-interface</i> — добавляет новый виртуальный интерфейс к виртуальному устройству</li><li><i>add-physical-interface</i> — добавляет физический интерфейс к шлюзу VSX или кластеру VSX</li><li><i>add-route</i> — добавляет маршрут к виртуальному устройству</li><li><i>attach-bridge</i> — подключает интерфейс-мост к виртуальной системе</li><li><i>remove-vsx</i> — удаляет шлюз VSX или кластер VSX</li><li><i>remove-vd</i> — удаляет виртуальное устройство</li><li><i>remove-vd-interface</i> — удаляет интерфейс из виртуального устройства</li><li><i>remove-physical-interface</i> — удаляет физический интерфейс из шлюза VSX или кластера VSX</li><li><i>remove-route</i> — удаляет маршрут из виртуального устройства</li><li><i>set-vd</i> — изменяет виртуальное устройство</li><li><i>set-vd-interface</i> — изменяет интерфейс виртуального устройства</li><li><i>set-physical-interface</i> — изменяет физический интерфейс кластера VSX или шлюза VSX</li></ul><br> * При добавлении кластера VSX необходимо добавить не менее 2 участников кластера<br> * Добавление участников кластера разрешено только при создании нового кластера VSX<br> * Чтобы добавить участников в существующий кластер, используйте vsx-run-operation.

Варианты:

• "attach-bridge"
• "add-route"
• "add-physical-interface"
• "add-vd-interface"
• "add-vsx-gateway"
• "add-vsx-cluster"
• "add-vd"
• "remove-route"
• "remove-vd"
• "remove-vsx"
• "remove-physical-interface"
• "remove-vd-interface"
• "set-vd"
• "set-physical-interface"
• "set-vd-interface"

remove_physical_interface_params

dictionary

Параметры операции удаления физического интерфейса из VSX (шлюза или кластера).

name

string

Имя интерфейса.

vsx_name

string

Имя объекта шлюза или кластера VSX.

remove_route_params

dictionary

Параметры операции удаления маршрута из виртуальной системы или виртуального маршрутизатора.

destination

string

Назначение маршрута. Чтобы указать маршрут по умолчанию, используйте «default» для IPv4 и «default6» для IPv6.

netmask

string

Маска подсети для этого маршрута.

prefix

string

Префикс CIDR для этого маршрута.

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

remove_vd_interface_params

dictionary

Параметры операции удаления логического интерфейса из виртуального устройства.

leads_to

string

Виртуальный коммутатор или виртуальный маршрутизатор для этого интерфейса.

name

string

Имя интерфейса.

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

remove_vd_params

dictionary

Параметры операции удаления виртуального устройства.

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

remove_vsx_params

dictionary

Параметры операции удаления шлюза VSX или кластера VSX.

vsx_name

string

Имя объекта шлюза VSX или кластера.

set_physical_interface_params

dictionary

Параметры операции изменения конфигурации физического интерфейса.

name

string

Имя интерфейса.

vlan_trunk

boolean

Значение True, если этот интерфейс является транком VLAN.

Варианты:

• false
• true

vsx_name

string

Имя объекта шлюза VSX или кластера.

set_vd_interface_params

dictionary

Параметры операции изменения конфигурации логического интерфейса.

anti_spoofing

string

Настройка защиты от подмены адреса для этого интерфейса.

Варианты:

• "prevent"
• "detect"
• "off"

anti_spoofing_tracking

string

Настройка отслеживания защиты от подмены адреса для этого интерфейса.

Варианты:

• "none"
• "alert"
• "log"

ipv4_address

string

IPv4-адрес этого интерфейса с необязательным префиксом CIDR.<br/>Обязателен, если этот интерфейс относится к виртуальной системе или виртуальному маршрутизатору.

ipv6_address

string

IPv6-адрес этого интерфейса<br/>Обязателен, если этот интерфейс относится к виртуальной системе или виртуальному маршрутизатору.

leads_to

string

Виртуальный коммутатор или виртуальный маршрутизатор для этого интерфейса.

mtu

integer

MTU этого интерфейса.

name

string

Имя интерфейса.

new_leads_to

string

Новый виртуальный коммутатор или виртуальный маршрутизатор для этого интерфейса.

propagate

boolean

Распространять маршрут IPv4 на соседние виртуальные устройства.

Варианты:

• false
• true

propagate6

boolean

Распространять маршрут IPv6 на соседние виртуальные устройства.

Варианты:

• false
• true

specific_group

string

Определённая группа для топологии интерфейса.<br/>Используется только с параметром топологии ‘internal_specific’.

topology

string

Топология этого интерфейса.<br/>Для этой виртуальной системы необходимо отключить автоматическое вычисление топологии на основе маршрутов.

Варианты:

• "external"
• "internal_undefined"
• "internal_this_network"
• "internal_specific"
• "defined_by_routes"

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

set_vd_params

dictionary

Параметры операции изменения конфигурации виртуального устройства.

calc_topology_auto

boolean

Автоматически вычислять топологию интерфейса на основе маршрутов.<br/>Применимо только для виртуальных систем.<br/>Не используйте для виртуальных устройств.

Варианты:

• false
• true

ipv4_address

string

Основной IPv4-адрес.<br/>Применимо только в том случае, если это устройство является виртуальной системой.<br/>Не используйте для других виртуальных устройств.

ipv4_instances

integer

Количество экземпляров IPv4 для виртуальной системы.<br/>Должно быть не меньше 1.<br/>Применимо только для виртуальных систем и виртуальных систем в режиме моста.

ipv6_address

string

Основной IPv6-адрес.<br/>Применимо только в том случае, если это устройство является виртуальной системой.<br/>Не используйте для других виртуальных устройств.

ipv6_instances

integer

Количество экземпляров IPv6 для виртуальной системы.<br/>Применимо только для виртуальных систем и виртуальных систем в режиме моста.

vd

string

Имя виртуальной системы, виртуального коммутатора или виртуального маршрутизатора.

vs_mtu

integer

MTU виртуальной системы.<br/>Применимо только для виртуальных систем в режиме моста.<br/>Не используйте для других виртуальных устройств.

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

Количество минут ожидания до возникновения ошибки тайм-аута.

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

cp_mgmt_vsx_provisioning_tool

dictionary

Вывод инструмента checkpoint vsx-provisioning-tool.

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