check_point.mgmt.cp_mgmt_add_api_key модуль — Добавление API ключа для администратора, для включения входа с ним. Для валидности ключа требуется публикация.
Примечание
Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 веб-сервисов.
Параметры
Параметр |
Комментарии |
|---|---|
admin_name строка |
Имя администратора для генерации API ключа. |
admin_uid строка |
Идентификатор администратора для генерации API ключа. |
auto_publish_session логическое значение |
Опубликовать текущую сессию, если изменения были внесены после завершения задачи. Варианты:
|
version строка |
Версия checkpoint. Если не указана, используется последняя версия. |
wait_for_task логическое значение |
Ожидать завершения задачи. Например, задачи публикации. Варианты:
|
wait_for_task_timeout целое число |
Сколько минут ждать перед выбросом ошибки таймаута. По умолчанию: |
Примеры
- name: add-api-key
cp_mgmt_add_api_key:
admin_name: admin
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ |
Описание |
|---|---|
cp_mgmt_add_api_key словарь |
Вывод checkpoint add-api-key. Возвращается: всегда. |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_add_api_key_module.html
