Модуль check_point.mgmt.cp_mgmt_delete_api_key – Удаление API ключа. Для того, чтобы ключ стал недействительным, требуется публикация.
Примечание
Этот модуль является частью коллекции check_point.mgmt (версия 5.2.3).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install check_point.mgmt.
Чтобы использовать ее в playbook, укажите: check_point.mgmt.cp_mgmt_delete_api_key.
Новая функция в check_point.mgmt 2.0.0
Обзор
- Удаление API ключа. Для того, чтобы ключ стал недействительным, требуется публикация.
- Все операции выполняются через API веб-служб.
Параметры
Параметр | Комментарии |
|---|---|
admin_name строка | Имя администратора для генерации API ключа. |
admin_uid строка | Идентификатор администратора для генерации API ключа. |
api_key строка | API ключ, который нужно удалить. |
auto_publish_session логическое | Опубликовать текущую сессию, если после выполнения задачи были внесены изменения. Вызовы:
|
version строка | Версия checkpoint. Если не указана, используется последняя версия. |
wait_for_task логическое | Дождаться завершения задачи. Например, задачи публикации. Вызовы:
|
wait_for_task_timeout целое число | Сколько минут ждать, прежде чем возникнет ошибка таймаута. По умолчанию: |
Примеры
- name: delete-api-key
cp_mgmt_delete_api_key:
#sgignore next_line
api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_delete_api_key словарь | Вывод модуля checkpoint delete-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_delete_api_key_module.html
