check_point.mgmt.cp_mgmt_add_api_key – Добавление API ключа для администратора, для включения входа с ним. Для валидности ключа требуется публикация.
Примечание
Этот плагин входит в коллекцию check_point.mgmt (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt.
Для использования в книге задач укажите: check_point.mgmt.cp_mgmt_add_api_key.
Новое в версии 2.9: модуля check_point.mgmt
Обзор
- Добавление API ключа для администратора, для включения входа с ним. Для валидности ключа требуется публикация. <br> При использовании инструмента mgmt_cli, добавьте -f json, чтобы получить ключ в выводе команды.
- Все операции выполняются через веб-сервисный API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_name строка | Имя администратора для генерации API ключа. | |
| admin_uid строка | UID администратора для генерации API ключа. | |
| version строка | Версия checkpoint. Если не указана, используется последняя версия. | |
| wait_for_task логический тип |
| Дождаться завершения задачи. Например, задачи публикации. |
| wait_for_task_timeout целое число | Значение по умолчанию: 30 | Количество минут ожидания перед выбросом ошибки таймаута. |
Примеры
- name: add-api-key
cp_mgmt_add_api_key:
admin_name: admin
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cp_mgmt_add_api_key словарь | всегда. | Вывод checkpoint add-api-key. |
Авторы
- Or Soffer (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_add_api_key_module.html
