Spec-Zone.ru › Ansible

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

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

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

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

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

Параметры

Параметр

Описание

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"

domains_assignment

list / elements=string

Домены, которые нужно добавить в этот профиль. Укажите только имя домена. См. пример ниже: «add-trusted-client (with domain)».

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

ip_address

string

Адрес IPv4 или IPv6. Если нужны оба адреса, явно используйте поля ipv4-address и ipv6-address.

ip_address_first

string

Первый IP-адрес диапазона. Если нужны диапазоны адресов IPv4 и IPv6, используйте вместо этого поля ipv4-address-first и ipv6-address-first.

ip_address_last

string

Последний IP-адрес диапазона. Если нужны диапазоны адресов IPv4 и IPv6, используйте вместо этого поля ipv4-address-first и ipv6-address-first.

ipv4_address

string

Адрес IPv4.

ipv4_address_first

string

Первый адрес IPv4 в диапазоне.

ipv4_address_last

string

Последний адрес IPv4 в диапазоне.

ipv6_address

string

Адрес IPv6.

ipv6_address_first

string

Первый адрес IPv6 в диапазоне.

ipv6_address_last

string

Последний адрес IPv6 в диапазоне.

mask_length

integer

Длина маски IPv4 или IPv6. Если нужны обе маски, явно используйте поля mask-length4 и mask-length6.

mask_length4

integer

Длина маски IPv4.

mask_length6

integer

Длина маски IPv6.

multi_domain_server_trusted_client

boolean

Разрешить этому доверенному клиенту подключаться ко всем серверам Multi-Domain в развертывании.

Варианты:

  • false
  • true

name

string / обязательный

Имя объекта.

state

string

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

Варианты:

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

tags

list / elements=string

Набор идентификаторов тегов.

type

string

Тип доверенного клиента.

Варианты:

  • "any"
  • "domain"
  • "ipv4 address"
  • "ipv4 address range"
  • "ipv4 netmask"
  • "ipv6 address"
  • "ipv6 address range"
  • "ipv6 netmask"
  • "name"
  • "wild cards (ip only)"

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

Количество минут ожидания до возникновения ошибки тайм-аута.

По умолчанию: 30

wild_card

string

Маска IP-адреса (например, 192.0.2.*).

Примеры

- name: add-trusted-client
  cp_mgmt_trusted_client:
    name: my client
    state: present
    type: ANY

- name: set-trusted-client
  cp_mgmt_trusted_client:
    ip_address: 192.0.2.1
    mask_length: '24'
    name: my client
    state: present
    type: NETMASK

- name: delete-trusted-client
  cp_mgmt_trusted_client:
    name: my client
    state: absent

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

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

Ключ

Описание

cp_mgmt_trusted_client

dictionary

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

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

Авторы

  • 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_trusted_client_module.html

Spec-Zone.ru

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