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

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

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

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

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

Параметры

Параметр	Комментарии
auto_publish_session логическое значение	Опубликовать текущий сеанс после завершения задачи, если были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
broadcast строка	Разрешить включение широковещательного адреса. Варианты: `"disallow"` `"allow"`
color строка	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"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 строка	Строка комментария.
details_level строка	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
groups список / элементы=строка	Набор идентификаторов групп.
ignore_errors логическое значение	Применить изменения, игнорируя ошибки. Опубликовать такие изменения будет невозможно. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings логическое значение	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
mask_length целое число	Длина маски сети IPv4 или IPv6. Если нужны обе маски, явно используйте поля mask-length4 и mask-length6. Вместо длины маски IPv4 можно указать саму маску IPv4 в поле subnet-mask.
mask_length4 целое число	Длина маски сети IPv4.
mask_length6 целое число	Длина маски сети IPv6.
name строка / обязательный	Имя объекта.
nat_settings словарь	Параметры NAT.
auto_rule логическое значение	Добавлять ли правила автоматической трансляции адресов. Варианты: `false` `true`
hide_behind строка	Метод сокрытия. Этот параметр не требуется, если параметр «method» имеет значение «static». Варианты: `"gateway"` `"ip-address"`
install_on строка	Шлюз, который должен выполнять трансляцию NAT.
ip_address строка	Адрес IPv4 или IPv6. Если нужны оба адреса, явно используйте поля ipv4-address и ipv6-address. Этот параметр не требуется, если параметр «method» имеет значение «hide», а параметр «hide-behind» — «gateway».
ipv4_address строка	Адрес IPv4.
ipv6_address строка	Адрес IPv6.
method строка	Метод трансляции NAT. Варианты: `"hide"` `"static"`
state строка	Состояние правила доступа (присутствует или отсутствует). Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet строка	Сетевой адрес IPv4 или IPv6. Если нужны оба адреса, явно используйте поля subnet4 и subnet6.
subnet4 строка	Сетевой адрес IPv4.
subnet6 строка	Сетевой адрес IPv6.
subnet_mask строка	Маска сети IPv4.
tags список / элементы=строка	Набор идентификаторов тегов.
version строка	Версия Check Point. Если она не указана, используется последняя версия.
wait_for_task логическое значение	Дождаться завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout целое число	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-network
  cp_mgmt_network:
    name: New Network 1
    state: present
    subnet: 192.0.2.0
    subnet_mask: 255.255.255.0

- name: set-network
  cp_mgmt_network:
    color: green
    mask_length: 16
    name: New Network 1
    new_name: New Network 2
    state: present
    subnet: 192.0.0.0

- name: delete-network
  cp_mgmt_network:
    name: New Network 2
    state: absent

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

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

Ключ	Описание
cp_mgmt_network словарь	Созданный или обновленный объект Check Point. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

Or Soffer (@chkp-orso)

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

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