модуль check_point.mgmt.cp_mgmt_delete_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_delete_api_key.

Новое в check_point.mgmt 2.0.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Удаление ключа API. Чтобы ключ стал недействительным, необходимо выполнить публикацию.
Все операции выполняются через API веб-служб.
Доступно начиная с версии управления R80.40.

Параметры

Параметр	Комментарии
admin_name string	Имя администратора, для которого создаётся ключ API.
admin_uid string	UID администратора, для которого создаётся ключ API.
api_key string	Ключ API, который необходимо удалить.
auto_publish_session boolean	Опубликовать текущий сеанс, если после выполнения задачи были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
version string	Версия Check Point. Если она не указана, используется последняя версия.
wait_for_task boolean	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: delete-api-key
  cp_mgmt_delete_api_key:
    # sgignore next_line
    api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
cp_mgmt_delete_api_key dictionary	Результат выполнения команды Check Point delete-api-key. Возвращается: всегда.

Авторы

Or Soffer (@chkp-orso)

Ссылки на коллекцию

© 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_delete_api_key_module.html