check_point.mgmt.cp_mgmt_user_group 模块 – 通过 Web 服务 API 管理 Checkpoint 上的用户组对象

注意

此模块是 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_user_group。

check_point.mgmt 5.0.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的用户组对象，包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

color

字符串

对象的颜色。应该是现有颜色之一。

选项

  • "aquamarine"

  • "black"

  • "blue"

  • "crete blue"

  • "burlywood"

  • "cyan"

  • "dark green"

  • "khaki"

  • "orchid"

  • "dark orange"

  • "dark sea green"

  • "pink"

  • "turquoise"

  • "dark blue"

  • "firebrick"

  • "brown"

  • "forest green"

  • "gold"

  • "dark gold"

  • "gray"

  • "dark gray"

  • "light green"

  • "lemon chiffon"

  • "coral"

  • "sea green"

  • "sky blue"

  • "magenta"

  • "purple"

  • "slate blue"

  • "violet red"

  • "navy blue"

  • "olive"

  • "orange"

  • "red"

  • "sienna"

  • "yellow"

comments

字符串

注释字符串。

details_level

字符串

响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完全详细表示形式不等。

选项

  • "uid"

  • "standard"

  • "full"

email

字符串

电子邮件地址。

groups

列表 / 元素=字符串

组标识符集合。

ignore_errors

布尔值

忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被忽略，则警告也将被忽略。

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

members

列表 / 元素=字符串

由名称或 UID 标识的用户组对象集合。

name

字符串 / 必需

对象名称。

state

字符串

访问规则的状态（存在或不存在）。

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-user-group
  cp_mgmt_user_group:
    email: [email protected]
    members:
    - myuser
    name: myusergroup
    state: present

- name: set-user-group
  cp_mgmt_user_group:
    email: [email protected]
    name: myusergroup
    state: present

- name: delete-user-group
  cp_mgmt_user_group:
    name: myusergroup
    state: absent

返回值

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

键

描述

cp_mgmt_user_group

字典

已创建或更新的 Checkpoint 对象。

返回：始终返回，除非删除对象时。

作者

  • Eden Brillant (@chkp-edenbr)