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

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

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

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

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

Параметры

Параметр	Комментарии
authentication_method string	Метод аутентификации. Варианты: `"undefined"` `"check point password"` `"os password"` `"securid"` `"radius"` `"tacacs"` `"ad authentication"` `"api key"`
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"`
email string	Адрес электронной почты администратора.
expiration_date string	Формат: YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.
ignore_errors boolean	Применить изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
multi_domain_profile string	Профиль администратора для нескольких доменов.
must_change_password boolean	Если значение равно True, администратор должен сменить пароль при следующем входе в систему. Варианты: `false` `true`
name string / обязательный	Имя объекта.
password string	Пароль администратора.
password_hash string	Хеш пароля администратора.
permissions_profile string	Профиль разрешений
permissions_profile_list list / elements=dictionary	Профиль разрешений администратора. Не указывайте профиль разрешений, если для multi-domain-profile задано значение «Multi-Domain Super User» или «Domain Super User». Используется только в MDS.
domain string	Домен.
profile string	Профиль разрешений.
phone_number string	Номер телефона администратора.
radius_server string	Объект RADIUS-сервера, определяемый по имени или UID. Необходимо задать, если в качестве метода аутентификации выбран «RADIUS».
state string	Состояние правила доступа (присутствует или отсутствует). Варианты: `"present"` ← (по умолчанию) `"absent"`
tacacs_server string	Объект TACACS-сервера, определяемый по имени или UID. Необходимо задать, если в качестве метода аутентификации выбран «TACACS».
tags list / elements=string	Список идентификаторов тегов.
version string	Версия Checkpoint. Если не указана, используется последняя версия.
wait_for_task boolean	Дождаться завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-administrator
  cp_mgmt_administrator:
    authentication_method: check point password
    email: admin@gmail.com
    must_change_password: false
    name: admin
    password: secret
    permissions_profile: read write all
    phone_number: 1800-800-800
    state: present

- name: set-administrator
  cp_mgmt_administrator:
    name: admin
    password: new secret
    permissions_profile: read only profile
    state: present

- name: delete-administrator
  cp_mgmt_administrator:
    name: admin
    state: absent

- name: add-administrator-in-MDS
  cp_mgmt_administrator:
    authentication_method: check point password
    email: admin@gmail.com
    must_change_password: false
    name: admin
    password: secret
    permissions_profile_list:
      profile: read write all
      domain: dom1
    phone_number: 1800-800-800
    state: present

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

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

Ключ	Описание
cp_mgmt_administrator 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_administrator_module.html