check_point.mgmt.cp_mgmt_host – Управляет объектами хостов в Check Point через API веб-служб
Примечание
Этот плагин входит в коллекцию check_point.mgmt (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt.
Для использования в плейбуке укажите: check_point.mgmt.cp_mgmt_host.
Введено в версии 2.9: of check_point.mgmt
Описание
- Управляет объектами хостов на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| 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=string | Интерфейсы хоста. | |||
| 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 / required | Имя объекта. | |||
| nat_settings dictionary | Настройки NAT. | |||
| auto_rule boolean |
| Добавлять ли автоматические правила трансляции адресов. | ||
| hide_behind string |
| Метод скрытия. Этот параметр не требуется, если параметр «метод» равен «статический». | ||
| install_on string | Какой шлюз должен применять трансляцию NAT. | |||
| ip_address string | Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно. Этот параметр не требуется, если параметр «метод» равен «скрыть» и параметр «скрыть-за» равен «шлюз». | |||
| ipv4_address string | Адрес IPv4. | |||
| ipv6_address string | Адрес IPv6. | |||
| method string |
| Метод трансляции NAT. | ||
| state string |
| Состояние правила доступа (present или absent). По умолчанию present. | ||
| tags list / elements=string | Коллекция идентификаторов тегов. | |||
| version string | Версия контрольной точки. Если не указана, используется последняя версия. | |||
| wait_for_task boolean |
| Ожидать завершения задачи. Например, задачи публикации. | ||
| wait_for_task_timeout integer | По умолчанию: 30 | Сколько минут ждать, прежде чем сгенерировать ошибку таймаута. | ||
Примеры
- 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 словарь | всегда, за исключением удаления объекта. | Созданный или обновлённый объект контрольной точки. |
Авторы
- Ор Соффер (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_host_module.html
