Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_if_map_server – управление объектами if-map-server на 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_if_map_server.

Новое в check_point.mgmt 6.5.0

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

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

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

Параметры

Параметр

Описание

authentication

dictionary

Настройки аутентификации для сервера IF-MAP.

authentication_method

string

Метод аутентификации для сервера IF-MAP.

Варианты:

  • "certificate_based"
  • "basic"

password

string

Имя пользователя для аутентификации на сервере IF-MAP. <font color=”red”>Требуется только, если</font> для ‘authentication-method’ задано значение ‘basic’.

username

string

Имя пользователя для аутентификации на сервере IF-MAP. <font color=”red”>Требуется только, если</font> для ‘authentication-method’ задано значение ‘basic’.

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_to_process

list / elements=string

Определяет, в каких доменах выполнять команды. Нельзя использовать со значением full для details-level; запускать можно только из системного домена и при значении true для ignore-warnings. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

host

string

Узел, на котором расположен сервер IF-MAP. Указывается по имени или UID.

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

monitored_ips

list / elements=dictionary

Диапазоны IP-адресов, отслеживаемые клиентом IF-MAP.

first_ip

string

Первый IPv4-адрес в отслеживаемом диапазоне.

last_ip

string

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

name

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

Имя объекта.

path

string

Н/Д

port

integer

Номер порта сервера IF-MAP.

query_whole_ranges

boolean

Определяет, следует ли запрашивать целые диапазоны вместо отдельных IP-адресов.

Варианты:

  • false
  • true

server_version

string

Версия IF-MAP.

Варианты:

  • "2.0"
  • "1.1"

state

string

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

Варианты:

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

tags

list / elements=string

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

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-if-map-server
  cp_mgmt_if_map_server:
    authentication:
      authentication_method: certificate_based
    host: TestHost
    monitored_ips:
    - first_ip: 1.1.1.1
      last_ip: 1.1.1.2
    - first_ip: 2.1.1.1
      last_ip: 2.1.1.2
    name: TestIfMapServer
    path: path
    port: 1
    state: present
    version: 2

- name: set-if-map-server
  cp_mgmt_if_map_server:
    host: TestHost2
    monitored_ips:
    - first_ip: 3.1.1.1
      last_ip: 3.1.1.2
    name: TestIfMapServer
    path: newPath
    port: 2
    query_whole_ranges: false
    state: present
    version: 1.1

- name: delete-if-map-server
  cp_mgmt_if_map_server:
    name: TestIdp
    state: absent

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

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

Ключ

Описание

cp_mgmt_if_map_server

dictionary

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

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

Авторы

  • Dor Berenstein (@chkp-dorbe)

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

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

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

Spec-Zone.ru

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