Модуль check_point.mgmt.cp_mgmt_add_api_key — добавление ключа 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_add_api_key.
Добавлено в check_point.mgmt 2.0.0
Краткое описание
- Добавление ключа API для администратора, чтобы включить вход с его помощью. Чтобы ключ стал действительным, необходимо выполнить публикацию. <br>При использовании инструмента mgmt_cli добавьте -f json, чтобы получить ключ в выводе команды.
- Все операции выполняются через API веб-служб.
- Доступно начиная с версии управления R80.40.
Параметры
Параметр | Комментарии |
|---|---|
admin_name string | Имя администратора, для которого создается ключ API. |
admin_uid string | UID администратора, для которого создается ключ API. |
auto_publish_session boolean | Опубликовать текущий сеанс после завершения задачи, если в него вносились изменения. Варианты:
|
version string | Версия Check Point. Если версия не указана, используется последняя. |
wait_for_task boolean | Ожидать завершения задачи, например задачи публикации. Варианты:
|
wait_for_task_timeout integer | Количество минут ожидания до возникновения ошибки превышения времени ожидания. По умолчанию: |
Примеры
- name: add-api-key
cp_mgmt_add_api_key:
admin_name: admin
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_add_api_key dictionary | Результат выполнения команды Check Point add-api-key. Возвращается: всегда. |
Ссылки на коллекцию
© 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_add_api_key_module.html
