check_point.mgmt.cp_mgmt_delete_api_key 模块 – 删除 API 密钥。要使密钥失效，需要发布。

注意

此模块是 check_point.mgmt 集合（版本 6.2.1）的一部分。

如果您使用的是 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 密钥。要使密钥失效，需要发布。

  • 所有操作都通过 Web Services API 执行。

参数

参数

注释

admin_name

字符串

要为其生成 API 密钥的管理员名称。

admin_uid

字符串

要为其生成 API 密钥的管理员 uid。

api_key

字符串

要删除的 API 密钥。

auto_publish_session

布尔值

如果任务完成后执行了更改，则发布当前会话。

选择

  • false ←（默认）

  • true

version

字符串

Check Point 的版本。 如果没有给出版本，则采用最新版本。

wait_for_task

布尔值

等待任务结束。 例如发布任务。

选择

  • false

  • true ←（默认）

wait_for_task_timeout

整数

等待多少分钟后抛出超时错误。

默认： 30

示例

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

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

cp_mgmt_delete_api_key

字典

Check Point delete-api-key 的输出。

返回： 始终。

作者

  • Or Soffer (@chkp-orso)