Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_interoperable_device — Управляет объектами совместимых устройств 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_interoperable_device.

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

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

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

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

Параметры

Параметр

Описание

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"

domains_to_process

list / элементы=string

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

groups

list / элементы=string

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

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

interfaces

list / элементы=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"

domains_to_process

list / элементы=string

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

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.

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 / элементы=string

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

topology

string

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

Варианты:

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

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

ip_address

string

Адрес IPv4 или IPv6.

ipv4_address

string

Адрес IPv4 совместимого устройства.

ipv6_address

string

Адрес IPv6 совместимого устройства.

name

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

Имя объекта.

state

string

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

Варианты:

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

tags

list / элементы=string

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

version

string

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

vpn_settings

dictionary

Свойства VPN-домена совместимого устройства.

vpn_domain

string

Сетевая группа, представляющая пользовательский домен шифрования. Необходимо задать, если для vpn-domain-type выбрано значение «manual».

vpn_domain_exclude_external_ip_addresses

boolean

Исключить внешние IP-адреса из VPN-домена этого совместимого устройства.

Варианты:

  • false
  • true

vpn_domain_type

string

Указывает домен шифрования.

Варианты:

  • "manual"
  • "addresses_behind_gw"

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-interoperable-device
  cp_mgmt_interoperable_device:
    ip_address: 192.168.1.6
    name: NewInteroperableDevice
    state: present

- name: set-interoperable-device
  cp_mgmt_interoperable_device:
    ip_address: 192.168.1.6
    name: NewInteroperableDevice
    state: present

- name: delete-interoperable-device
  cp_mgmt_interoperable_device:
    name: NewInteroperableDevice
    state: absent

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

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

Ключ

Описание

cp_mgmt_interoperable_device

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_interoperable_device_module.html

Spec-Zone.ru

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