check_point.mgmt.cp_mgmt_administrator 模块 – 通过 Web Services 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_administrator。

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

authentication_method

字符串

身份验证方法。

选项

  • "undefined"

  • "check point password"

  • "os password"

  • "securid"

  • "radius"

  • "tacacs"

  • "ad authentication"

  • "api key"

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

字符串

管理员电子邮件。

expiration_date

字符串

格式，YYYY-MM-DD，YYYY-mm-ddThh,mm,ss。

ignore_errors

布尔值

应用更改时忽略错误。您将无法发布此类更改。如果省略了 ignore-warnings 标志，则也会忽略警告。

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

multi_domain_profile

字符串

管理员多域配置文件。

must_change_password

布尔值

如果管理员必须在下次登录时更改密码，则为 True。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

password

字符串

管理员密码。

password_hash

字符串

管理员密码哈希。

permissions_profile

字符串

权限配置文件

permissions_profile_list

列表 / 元素=字典

管理员权限配置文件。当 multi-domain-profile 设置为“Multi-Domain Super User”或“Domain Super User”时，不应提供权限配置文件。仅在 MDS 中使用。

domain

字符串

域。

profile

字符串

权限配置文件。

phone_number

字符串

管理员电话号码。

radius_server

字符串

通过名称或 UID 标识的 RADIUS 服务器对象。当“authentication-method”选择为“RADIUS”时必须设置。

state

字符串

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

选项

  • "present" ← （默认）

  • "absent"

tacacs_server

字符串

通过名称或 UID 标识的 TACACS 服务器对象。当“authentication-method”选择为“TACACS”时必须设置。

tags

列表 / 元素=字符串

标记标识符的集合。

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← （默认）

wait_for_task_timeout

整数

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

默认值： 30

示例

- name: add-administrator
  cp_mgmt_administrator:
    authentication_method: check point password
    email: [email protected]
    must_change_password: false
    name: admin
    password: secret
    permissions_profile: read write all
    phone_number: 1800-800-800
    state: present

- name: set-administrator
  cp_mgmt_administrator:
    name: admin
    password: new secret
    permissions_profile: read only profile
    state: present

- name: delete-administrator
  cp_mgmt_administrator:
    name: admin
    state: absent

- name: add-administrator-in-MDS
  cp_mgmt_administrator:
    authentication_method: check point password
    email: [email protected]
    must_change_password: false
    name: admin
    password: secret
    permissions_profile_list:
      profile: read write all
      domain: dom1
    phone_number: 1800-800-800
    state: present

返回值

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

键

描述

cp_mgmt_administrator

字典

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

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

作者

  • Or Soffer (@chkp-orso)