Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_interface — управление объектами интерфейсов 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_interface.

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

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

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

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

Параметры

Параметр

Комментарии

anti_spoofing

boolean

Включить защиту от подмены адреса.

Варианты:

  • false
  • true

anti_spoofing_settings

dictionary

Настройки защиты от подмены адреса.

action

string

Отклонять ли пакеты (параметр Prevent) или отслеживать их (параметр Detect).

Варианты:

  • "prevent"
  • "detect"

exclude_packets

boolean

Не проверять пакеты из исключённой сети.

Варианты:

  • false
  • true

excluded_network_name

string

Имя исключённой сети.

excluded_network_uid

string

UID исключённой сети.

spoof_tracking

string

Отслеживание подмены адреса.

Варианты:

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

auto_publish_session

boolean

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

Варианты:

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

cluster_members

list / elements=dictionary

Настройки сетевого интерфейса для участников кластера.

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"

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

ip_address

string

Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address.

ipv4_address

string

Адрес IPv4.

ipv4_mask_length

string

Длина маски сети IPv4.

ipv4_network_mask

string

Адрес сети IPv4.

ipv6_address

string

Адрес IPv6.

ipv6_mask_length

string

Длина маски сети IPv6.

ipv6_network_mask

string

Адрес сети IPv6.

mask_length

string

Длина маски сети IPv4 или IPv6.

member_name

string

Имя объекта участника кластера.

name

string

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

network_mask

string

Маска сети IPv4 или IPv6. Если требуются обе маски, явно используйте поля ipv4-network-mask и ipv6-network-mask. Вместо указания самой маски можно задать длину маски IPv4 или IPv6 в поле mask-length. Если требуются длины обеих масок, явно используйте поля ipv4-mask-length и ipv6-mask-length.

tags

list / elements=string

Коллекция идентификаторов тегов.

cluster_network_type

string

Тип интерфейса кластера.

Варианты:

  • "cluster"
  • "sync"
  • "cluster + sync"
  • "private"

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"

domains_to_process

list / elements=string

Указывает, в каких доменах выполнять команды. Нельзя использовать вместе со значением full для параметра details-level; запускать команду следует только из системного домена и со значением true для ignore-warnings. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

dynamic_ip

boolean

Включить динамический интерфейс.

Варианты:

  • false
  • true

gateway_uid

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

UID объекта шлюза или кластера, которому принадлежит интерфейс.

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

ipv4_address

string

Адрес сети IPv4.

ipv4_mask_length

integer

Длина маски IPv4.

ipv4_network_mask

string

Маска сети IPv4.

ipv6_address

string

Адрес IPv6.

ipv6_mask_length

integer

Длина маски IPv6.

ipv6_network_mask

string

Маска сети IPv6.

monitored_by_cluster

boolean

Если в качестве типа интерфейса кластера выбрано Private, кластер может отслеживать или не отслеживать этот интерфейс.

Варианты:

  • false
  • true

name

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

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

network_interface_type

string

Тип сетевого интерфейса.

Варианты:

  • "alias"
  • "bond"
  • "bridge"
  • "bridge member"
  • "ethernet"
  • "loopback"
  • "6 in 4 tunnel"
  • "pppoe"
  • "vpn tunnel"
  • "vlan"

security_zone_settings

dictionary

Настройки зоны безопасности.

auto_calculated

boolean

Зона безопасности определяется автоматически в зависимости от того, куда ведёт интерфейс.

Варианты:

  • false
  • true

specific_security_zone_enabled

boolean

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

Указывает, следует ли включить указанную зону безопасности.

Варианты:

  • false
  • true

specific_zone

string

Зона безопасности, указанная вручную.

state

string

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

Варианты:

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

tags

list / elements=string

Коллекция идентификаторов тегов.

topology

string

Конфигурация топологии.

Варианты:

  • "automatic"
  • "external"
  • "internal"

topology_settings

dictionary

Настройки топологии.

interface_leads_to_dmz

boolean

Указывает, ведёт ли этот интерфейс в демилитаризованную зону (периметровую сеть).

Варианты:

  • false
  • true

ip_address_behind_this_interface

string

Настройки сети за этим интерфейсом.

Варианты:

  • "not defined"
  • "network defined by the interface ip and net mask"
  • "network defined by routing"
  • "specific"

specific_network

string

Сеть за этим интерфейсом.

specific_network_uid

string

Н/Д

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-interface
  cp_mgmt_interface:
    anti_spoofing: true
    anti_spoofing_settings:
      action: detect
      exclude_packets: false
      spoof_tracking: log
    cluster_members:
      - ipv4_address: 2.2.2.1
        ipv4_mask_length: 24
        ipv4_network_mask: 255.255.255.0
        member_name: member1
        name: eth4
      - ipv4_address: 2.2.2.2
        ipv4_mask_length: 24
        ipv4_network_mask: 255.255.255.0
        member_name: member2
        name: eth4
    cluster_network_type: cluster
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17
    ignore_warnings: false
    ipv4_address: 1.1.1.111
    ipv4_mask_length: 24
    name: eth0
    security_zone_settings:
      auto_calculated: false
      specific_zone: InternalZone
    state: present
    topology: internal
    topology_settings:
      interface_leads_to_dmz: false
      ip_address_behind_this_interface: network defined by routing

- name: set-interface
  cp_mgmt_interface:
    cluster_members:
      - ipv4_address: 4.4.4.1
        ipv4_mask_length: 22
        member_name: memberReal1
        uid: db4f8a63-5a94-46d8-b9e0-a63870bded3d
      - ipv4_address: 4.4.4.2
        ipv4_mask_length: 22
        member_name: memberReal2
        uid: baca571e-8ada-4be9-8966-145388f8e238
    cluster_network_type: cluster + sync
    ipv4_address: 4.4.4.111
    ipv4_mask_length: 22
    state: present
    topology: internal
    topology_settings:
      ip_address_behind_this_interface: network defined by routing
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17

- name: delete-interface
  cp_mgmt_interface:
    state: absent
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17

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

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

Ключ

Описание

cp_mgmt_interface

dictionary

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

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

Авторы

  • Eden Brillant (@chkp-edenbr)

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

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

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

Spec-Zone.ru

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