check_point.mgmt.cp_mgmt_delete_api_key – Удаление ключа API. Для того, чтобы ключ стал недействительным, необходимо опубликовать.
Примечание
Этот плагин является частью коллекции check_point.mgmt (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt.
Для использования в книге задач укажите: check_point.mgmt.cp_mgmt_delete_api_key.
Новое в версии 2.9: модуля check_point.mgmt
Описание
- Удалить ключ API. Для того, чтобы ключ стал недействительным, необходимо опубликовать.
- Все операции выполняются через API веб-служб.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_name строка | Имя администратора для генерации ключа API. | |
| admin_uid строка | Идентификатор администратора для генерации ключа API. | |
| api_key строка | Ключ API, который требуется удалить. | |
| version строка | Версия Checkpoint. Если не указана, используется последняя версия. | |
| wait_for_task логическое значение |
| Дождаться завершения задачи. Например, задачи публикации. |
| wait_for_task_timeout целое число | По умолчанию: 30 | Сколько минут ждать, прежде чем сгенерировать ошибку таймаута. |
Примеры
- name: delete-api-key
cp_mgmt_delete_api_key:
api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cp_mgmt_delete_api_key словарь | всегда. | Вывод Checkpoint по удалению ключа API. |
Авторы
- 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_delete_api_key_module.html
