check_point.mgmt.cp_mgmt_tacacs_server 模块 – 通过 Web Services API 管理 Checkpoint 上的 tacacs-server 对象

注意

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

check_point.mgmt 5.0.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的 tacacs-server 对象,包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ← (默认)

  • true

颜色

字符串

对象的颜色。应为现有颜色之一。

选择

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "浅黄褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花紫"

  • "深橙色"

  • "深海绿色"

  • "粉红色"

  • "绿松石色"

  • "深蓝色"

  • "火砖色"

  • "棕色"

  • "森林绿色"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬薄纱色"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

响应中某些字段的详细程度可能会有所不同,从仅显示对象的 UID 值到对象的完整详细表示。

选择

  • "uid"

  • "standard"

  • "full"

encryption

布尔值

服务器上是否定义了密钥。当“服务器类型”选择为“TACACS+”时,必须设置为 true。

选择

  • false

  • true

groups

列表 / 元素=字符串

组标识符的集合。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

name

字符串 / 必需

对象名称。

priority

整数

如果 TACACS 服务器是 TACACS 组的成员,则它的优先级。

secret_key

字符串

服务器的密钥。<br><font color=”red”>仅当“服务器类型”选择为“TACACS+”时才必需。</font>

server

字符串

作为 TACACS 服务器的主机的 UID 或名称。

server_type

字符串

服务器类型,TACACS 或 TACACS+。

选择

  • "TACACS"

  • "TACACS+"

service

字符串

服务器服务,仅当“服务器类型”为 TACACS 时才相关。

state

字符串

访问规则的状态(存在或不存在)。

选择

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标记标识符的集合。

version

字符串

Checkpoint 的版本。如果未提供,则采用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间(分钟)直到抛出超时错误。

默认值: 30

示例

- name: add-tacacs-server
  cp_mgmt_tacacs_server:
    name: tacacs7
    server: h1
    state: present

- name: set-tacacs-server
  cp_mgmt_tacacs_server:
    encryption: 'true'
    name: tacacs server
    priority: '5'
    secret_key: '**secret**'
    server: d700e8d5-d010-4f37-ab14-f78f5a26426c
    server_type: TACACS
    state: present

- name: delete-tacacs-server
  cp_mgmt_tacacs_server:
    name: tacacs server
    state: absent

返回值

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

描述

cp_mgmt_tacacs_server

字典

创建或更新的 Checkpoint 对象。

返回:总是返回,删除对象时除外。

作者

  • Eden Brillant (@chkp-edenbr)