Spec-Zone.ru › Ansible

check_point.mgmt.cp_mgmt_host модуль — Управляет объектами хостов в Check Point через 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_host.

Новое в check_point.mgmt 1.0.0

  • УСТАРЕВШИЙ
  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕВШИЙ

Удален в:

главной версии после 2024-11-01

Почему:

Выпущены новые и обновлённые модули с более широкими функциональными возможностями.

Альтернатива:

cp_mgmt_hosts

Описание

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

Параметры

Параметр

Комментарии

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"

groups

list / elements=string

Коллекция идентификаторов групп.

host_servers

dictionary

Настройка серверов.

dns_server

boolean

Возвращает True, если этот сервер является DNS-сервером.

Выбор:

  • false
  • true

mail_server

boolean

Возвращает True, если этот сервер является почтовым сервером.

Выбор:

  • false
  • true

web_server

boolean

Возвращает True, если этот сервер является веб-сервером.

Выбор:

  • false
  • true

web_server_config

dictionary

Настройка веб-сервера.

additional_ports

list / elements=string

Дополнительные порты сервера.

application_engines

list / elements=string

Прикладные движки этого веб-сервера.

listen_standard_port

boolean

Слушает ли сервер стандартный порт.

Выбор:

  • false
  • true

operating_system

string

Операционная система.

Выбор:

  • "sparc linux"
  • "windows"
  • "other"
  • "x86 linux"
  • "sparc solaris"

protected_by

string

Сеть объект, который защищает этот сервер, идентифицированный по имени или UID.

ignore_errors

boolean

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

Выбор:

  • false
  • true

ignore_warnings

boolean

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

Выбор:

  • false
  • true

interfaces

list / elements=dictionary

Интерфейсы хоста.

END_OF_DOCUMENT_MARKER

color

string

Цвет объекта. Должен быть одним из существующих цветов.

Choices:

  • "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 объекта до полностью подробного представления объекта.

Choices:

  • "uid"
  • "standard"
  • "full"

ignore_errors

boolean

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

Choices:

  • false
  • true

ignore_warnings

boolean

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

Choices:

  • false
  • true

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

Добавлять ли правила автоматического преобразования адресов.

Choices:

  • false
  • true

hide_behind

string

Метод скрытия. Этот параметр не требуется, если параметр «method» равен «static».

Choices:

  • "gateway"
  • "ip-address"

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.

Варианты:

  • "hide"
  • "static"

state

string

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

Варианты:

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

tags

list / elements=string

Коллекция идентификаторов тегов.

version

string

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

wait_for_task

boolean

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

Варианты:

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

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

dictionary

Объект Checkpoint, созданный или обновлённый.

Возвращается: всегда, кроме случаев удаления объекта.

Статус

  • Этот модуль будет удалён в следующей версии после 2024-11-01. [устаревший]
  • Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

  • Or Soffer (@chkp-orso)

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (Исходные файлы)

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

Spec-Zone.ru

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