check_point.mgmt.cp_mgmt_interoperable_device модуль — Управляет объектами совместимых устройств на Checkpoint через API веб-служб
Примечание
Этот модуль является частью коллекции check_point.mgmt (версия 5.2.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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
Обзор
- Управляет объектами совместимых устройств на устройствах Checkpoint, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
Параметры
Параметр | Комментарии |
|---|---|
auto_publish_session boolean | Опубликовать текущую сессию, если после выполнения задачи были внесены изменения. Варианты:
|
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментариев. |
details_level string | Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
domains_to_process list / elements=string | Указывает, какие домены обрабатывать командами. Не может использоваться с детализацией full, должна выполняться только из домена системы и со значением ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. |
groups list / elements=string | Коллекция идентификаторов групп. |
ignore_errors boolean | Применять изменения, игнорируя ошибки. Такие изменения нельзя опубликовать. Если флаг ignore-warnings опущен, то предупреждения также будут проигнорированы. Варианты:
|
ignore_warnings boolean | Применять изменения, игнорируя предупреждения. Варианты:
|
interfaces list / elements=dictionary | Сетевые интерфейсы. |
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments string |
Строка комментариев. |
|
details_level string |
Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
|
domains_to_process list / elements=string |
Указывает, какие домены обрабатывать командами. Не может использоваться с детализацией full, должна выполняться только из домена системы и со значением ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. |
|
ignore_errors boolean |
Применять изменения, игнорируя ошибки. Такие изменения нельзя опубликовать. Если флаг ignore-warnings опущен, то предупреждения также будут проигнорированы. Варианты:
|
|
ignore_warnings boolean |
Применять изменения, игнорируя предупреждения. Варианты:
|
|
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 / elements=string |
Коллекция идентификаторов тегов. |
|
topology string |
Конфигурация топологии. Варианты:
|
|
topology_settings dictionary |
Внутренние настройки топологии. |
|
interface_leads_to_dmz boolean |
Указывает, ведет ли этот интерфейс в демилитаризованную зону (периферийную сеть). Варианты:
|
|
ip_address_behind_this_interface string |
Настройки сети за этим интерфейсом. Варианты:
|
|
specific_network string |
Сеть за этим интерфейсом. |
ip_address string | IPv4 или IPv6 адрес. |
ipv4_address string | IPv4 адрес взаимозаменяемого устройства. |
ipv6_address string | IPv6 адрес взаимозаменяемого устройства. |
name string / required | Имя объекта. |
state string | Состояние правила доступа (присутствует или отсутствует). Варианты:
|
tags list / elements=string | Коллекция идентификаторов тегов. |
version string | Версия Checkpoint. Если не указана, используется последняя версия. |
vpn_settings dictionary | Свойства VPN-домена для взаимозаменяемого устройства. |
|
vpn_domain string |
Группа сетей, представляющая настраиваемую область шифрования. Должна быть установлена, когда тип vpn-domain-type установлен в «manual». |
|
vpn_domain_exclude_external_ip_addresses boolean |
Исключить внешние IP-адреса из области VPN данного совместимого устройства. Варианты:
|
|
vpn_domain_type string |
Указывает область шифрования. Варианты:
|
wait_for_task boolean | Ожидать завершения задачи. Например, задачи публикации. Варианты:
|
wait_for_task_timeout integer | Количество минут ожидания перед выводом ошибки таймаута. По умолчанию: |
Примеры
- 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 | Созданный или обновлённый объект Checkpoint. Возвращаемое значение: всегда, за исключением удаления объекта. |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_interoperable_device_module.html