Модуль check_point.mgmt.cp_mgmt_host — управление объектами узлов 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_host.
Добавлено в check_point.mgmt 1.0.0
Краткое описание
- Управляет объектами узлов на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
- Доступно начиная с версии управления R80.
Параметры
Параметр | Комментарии |
|---|---|
auto_publish_session boolean | Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты:
|
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментария. |
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
groups list / elements=string | Коллекция идентификаторов групп. |
host_servers dictionary | Конфигурация серверов. |
|
dns_server boolean |
Возвращает True, если этот сервер является DNS-сервером. Варианты:
|
|
mail_server boolean |
Возвращает True, если этот сервер является почтовым сервером. Варианты:
|
|
web_server boolean |
Возвращает True, если этот сервер является веб-сервером. Варианты:
|
|
web_server_config dictionary |
Конфигурация веб-сервера. |
|
additional_ports list / elements=string |
Дополнительные порты сервера. |
|
application_engines list / elements=string |
Модули приложений этого веб-сервера. |
|
listen_standard_port boolean |
Определяет, прослушивает ли сервер стандартный порт. Варианты:
|
|
operating_system string |
Операционная система. Варианты:
|
|
protected_by string |
Сетевой объект, защищающий этот сервер; указывается по имени или UID. |
ignore_errors boolean | Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применять изменения, игнорируя предупреждения. Варианты:
|
interfaces list / elements=dictionary | Интерфейсы узла. Доступно начиная с версии управления R80.10. |
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments string |
Строка комментария. |
|
details_level string |
Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
|
ignore_errors boolean |
Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
|
ignore_warnings boolean |
Применять изменения, игнорируя предупреждения. Варианты:
|
|
mask_length integer |
Длина маски сети IPv4 или IPv6. Если требуются обе маски, явно используйте поля mask-length4 и mask-length6. Вместо длины маски IPv4 можно указать саму маску IPv4 в поле subnet-mask. |
|
mask_length4 integer |
Длина маски сети IPv4. |
|
mask_length6 integer |
Длина маски сети IPv6. |
|
name string |
Имя интерфейса. |
|
subnet string |
Адрес сети IPv4 или IPv6. Если требуются оба адреса, явно используйте поля subnet4 и subnet6. |
|
subnet4 string |
Адрес сети IPv4. |
|
subnet6 string |
Адрес сети IPv6. |
|
subnet_mask string |
Маска сети IPv4. |
ip_address string | Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address. |
ipv4_address string | Адрес IPv4. |
ipv6_address string | Адрес IPv6. |
name string / обязательный | Имя объекта. |
nat_settings dictionary | Параметры NAT. |
|
auto_rule boolean |
Добавлять ли автоматические правила трансляции адресов. Варианты:
|
|
hide_behind string |
Метод сокрытия адреса. Этот параметр не требуется, если параметр «method» имеет значение «static». Варианты:
|
|
install_on string |
Шлюз, который должен выполнять трансляцию NAT. |
|
ip_address string |
Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address. Этот параметр не требуется, если параметр «method» имеет значение «hide», а параметр «hide-behind» — значение «gateway». |
|
ipv4_address string |
Адрес IPv4. |
|
ipv6_address string |
Адрес IPv6. |
|
method string |
Метод трансляции NAT. Варианты:
|
state string | Состояние правила доступа (присутствует или отсутствует). Варианты:
|
tags list / elements=string | Коллекция идентификаторов тегов. |
version string | Версия Check Point. Если она не указана, используется последняя версия. |
wait_for_task boolean | Дождаться завершения задачи, например задачи публикации. Варианты:
|
wait_for_task_timeout integer | Сколько минут ждать до возникновения ошибки тайм-аута. По умолчанию: |
Примеры
- name: add-host
cp_mgmt_host:
ip_address: 192.0.2.1
name: New Host 1
state: present
- name: set-host
cp_mgmt_host:
color: green
ipv4_address: 192.0.2.2
name: New Host 1
state: present
- name: delete-host
cp_mgmt_host:
name: New Host 1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_host dictionary | Созданный или обновлённый объект Check Point. Возвращается: всегда, кроме случаев удаления объекта. |
Ссылки на коллекцию
© 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_host_module.html