check_point.mgmt.cp_mgmt_access_role 模块 – 通过 Web 服务 API 管理 Check Point 上的访问角色对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

  • 管理 Check Point 设备上的访问角色对象，包括创建、更新和删除对象。

  • 所有操作均通过 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"

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

machines

字符串

任何或所有已识别的。

选项

  • "any"

  • "all identified"

machines_list

列表 / 元素=字典

可以访问系统的机器。

base_dn

字符串

当源是“Active Directory”时，使用“base-dn”来细化 AD 数据库中的查询。

selection

列表 / 元素=字符串

从源中选择的对象的名称或 UID。

source

字符串

Active Directory 名称或 UID 或标识标签。

name

字符串 / 必需

对象名称。

networks

列表 / 元素=字符串

由名称或 UID 标识的可以访问系统的网络对象集合。

remote_access_clients

字符串

由名称或 UID 标识的远程访问客户端。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

users

字符串

任何或所有已识别的。

选项

  • "any"

  • "all identified"

users_list

列表 / 元素=字典

可以访问系统的用户。

base_dn

字符串

当源是“Active Directory”时，使用“base-dn”来细化 AD 数据库中的查询。

selection

列表 / 元素=字符串

从源中选择的对象的名称或 UID。

source

字符串

Active Directory 名称或 UID 或标识标签或内部用户组或 LDAP 组或访客。

version

字符串

检查点版本。如果未指定，则采用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-access-role
  cp_mgmt_access_role:
    name: New Access Role 1
    networks: any
    remote_access_clients: any
    state: present
    users: any

- name: set-access-role
  cp_mgmt_access_role:
    users_list:
        - source: "Internal User Groups"
          selection: usersGroup
    name: New Access Role 1
    state: present

- name: delete-access-role
  cp_mgmt_access_role:
    name: New Access Role 1
    state: absent

返回值

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

键

描述

cp_mgmt_access_role

字典

创建或更新的检查点对象。

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

作者

  • Or Soffer (@chkp-orso)