check_point.mgmt.cp_mgmt_add_api_key 模块 – 为管理员添加 API 密钥，以便使用该密钥登录。密钥生效需要发布。

注意

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

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install check_point.mgmt。

要在剧本中使用它，请指定： check_point.mgmt.cp_mgmt_add_api_key。

check_point.mgmt 2.0.0 中的新增功能

概要

  • 为管理员添加 API 密钥，以便使用该密钥登录。密钥生效需要发布。
    使用 mgmt_cli 工具时，添加 -f json 以在命令输出中获取密钥。

  • 所有操作均通过 Web 服务 API 执行。

参数

参数

注释

admin_name

字符串

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

admin_uid

字符串

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

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

version

字符串

Checkpoint 的版本。如果未指定，则使用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

在抛出超时错误之前等待多少分钟。

默认值： 30

示例

- name: add-api-key
  cp_mgmt_add_api_key:
    admin_name: admin

返回值

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

键

描述

cp_mgmt_add_api_key

字典

Checkpoint add-api-key 输出。

返回： 始终。

作者

  • Or Soffer (@chkp-orso)