Модуль check_point.mgmt.cp_mgmt_voip_domain_sip_proxy — управление объектами voip-domain-sip-proxy на Checkpoint через 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_voip_domain_sip_proxy.

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

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Управляет объектами voip-domain-sip-proxy на устройствах Checkpoint, включая создание, обновление и удаление объектов.
Все операции выполняются через API веб-служб.
Доступно начиная с версии управления R82.10.

Параметры

Параметр	Описание
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"`
endpoints_domain string	Связанный домен конечных точек, к которому будет подключаться домен VoIP. Указывается по имени или UID.
ignore_errors boolean	Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применять изменения, игнорируя предупреждения. Варианты: `false` `true`
installed_at string	Компьютер, на котором установлен VoIP. Указывается по имени или UID.
name string / обязательный	Имя объекта.
state string	Состояние правила доступа (present или absent). Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / элементы=string	Список идентификаторов тегов.
version string	Версия Checkpoint. Если не указана, используется последняя версия.
wait_for_task boolean	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Время ожидания в минутах до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-voip-domain-sip-proxy
  cp_mgmt_voip_domain_sip_proxy:
    endpoints_domain: new_group
    installed_at: test_host
    name: sip1
    state: present

- name: set-voip-domain-sip-proxy
  cp_mgmt_voip_domain_sip_proxy:
    endpoints_domain: IPv6_Link_Local_Hosts
    name: sip1
    state: present

- name: delete-voip-domain-sip-proxy
  cp_mgmt_voip_domain_sip_proxy:
    name: sip1
    state: absent

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

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

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

Авторы

Eden Brillant (@chkp-edenbr)

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

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