Модуль check_point.mgmt.cp_mgmt_user — управление объектами пользователей на устройствах 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_user.

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

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

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

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

Параметры

Параметр	Комментарии
allowed_locations словарь	Разрешённые местоположения пользователя.
destinations список / элементы=строка	Список разрешённых местоположений назначения, указанных по имени или UID.
sources список / элементы=строка	Список разрешённых исходных местоположений, указанных по имени или UID.
authentication_method строка	Метод аутентификации. Варианты: `"undefined"` `"check point password"` `"os password"` `"securid"` `"radius"` `"tacacs"`
auto_publish_session логическое значение	Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
color строка	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"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 строка	Строка комментария.
connect_daily логическое значение	Подключаться каждый день. Варианты: `false` `true`
connect_on_days список / элементы=строка	Дни, в которые пользователям разрешено подключаться.
details_level строка	Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до полного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
email строка
encryption словарь	Шифрование пользователя. Общий секрет не поддерживается.
ike логическое значение	Включить шифрование IKE для пользователей. Варианты: `false` `true`
public_key логическое значение	Включить открытый ключ IKE. Варианты: `false` `true`
expiration_date строка	Дата истечения срока действия в формате yyyy-MM-dd.
from_hour строка	Разрешить пользователям подключаться начиная с указанного часа.
groups список / элементы=строка	Список идентификаторов групп.
ignore_errors логическое значение	Применить изменения, игнорируя ошибки. Такие изменения нельзя будет опубликовать. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings логическое значение	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
name строка / обязательный	Имя объекта.
password строка	Метод аутентификации по паролю Check Point, указанный по имени или UID. Необходимо задать, если для параметра «authentication-method» выбран вариант «Check Point Password».
phone_number строка	Номер телефона пользователя.
radius_server строка	Объект сервера RADIUS, указанный по имени или UID. Необходимо задать, если для параметра «authentication-method» выбран вариант «RADIUS».
state строка	Состояние правила доступа (присутствует или отсутствует). Варианты: `"present"` ← (по умолчанию) `"absent"`
tacacs_server строка	Объект сервера TACACS, указанный по имени или UID. Необходимо задать, если для параметра «authentication-method» выбран вариант «TACACS».
tags список / элементы=строка	Список идентификаторов тегов.
template строка	Имя или UID шаблона пользователя.
to_hour строка	Разрешить пользователям подключаться до указанного часа.
version строка	Версия Check Point. Если она не указана, используется последняя версия.
wait_for_task логическое значение	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout целое число	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-user
  cp_mgmt_user:
    authentication_method: securid
    connect_daily: 'True'
    email: myuser@email.com
    encryption:
      enable_ike: 'True'
      enable_public_key: 'True'
    expiration_date: '2030-05-30'
    from_hour: 08:00
    name: myuser
    phone_number: '0501112233'
    state: present
    to_hour: '17:00'

- name: set-user
  cp_mgmt_user:
    authentication_method: undefined
    expiration_date: '2035-01-15'
    from_hour: '12:00'
    name: myuser
    state: present

- name: delete-user
  cp_mgmt_user:
    name: myuser
    state: absent

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

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

Ключ	Описание
cp_mgmt_user словарь	Созданный или обновлённый объект 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_user_module.html