check_point.mgmt.cp_mgmt_opsec_trusted_ca 模块 – 通过 Web 服务 API 管理 Checkpoint 上的 opsec-trusted-ca 对象

注意

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

check_point.mgmt 6.0.0 中的新增功能

概要

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

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

参数

参数

注释

allow_certificates_from_branches

布尔值

仅允许来自列出分支的证书。

选项

  • false

  • true

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

automatic_enrollment

字典

证书自动注册。

automatically_enroll_certificate

布尔值

是否自动注册证书。

选项

  • false

  • true

cmpv1_settings

字典

Cmpv1 协议设置。仅当“protocol”设置为“cmpv1”时可用。

direct_tcp_settings

字典

直接 tcp 传输层设置。

ip_address

字符串

证书颁发机构 IP 地址。

port

整数

端口号。

cmpv2_settings

字典

Cmpv2 协议设置。仅当“protocol”设置为“cmpv1”时可用。

direct_tcp_settings

字典

直接 tcp 传输层设置。

ip_address

字符串

证书颁发机构 IP 地址。

port

整数

端口号。

http_settings

字典

Http 传输层设置。

url

字符串

证书颁发机构 URL。

transport_layer

字符串

传输层。

选项

  • "http"

  • "direct-tcp"

protocol

字符串

与证书颁发机构通信的协议。仅当“automatically-enroll-certificate”参数设置为 true 时可用。

选项

  • "scep"

  • "cmpv2"

  • "cmpv1"

scep_settings

字典

Scep 协议设置。仅当“protocol”设置为“scep”时可用。

ca_identifier

字符串

证书颁发机构标识符。

url

字符串

证书颁发机构 URL。

base64_certificate

字符串

以 base64 编码的证书文件。

branches

列表 / 元素=字符串

允许来自的分支。仅当“allow-certificates-from-branches”设置为“true”时才需要。

cache_crl

布尔值

在安全网关上缓存证书吊销列表。

选项

  • 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

字符串

注释字符串。

crl_cache_method

字符串

证书过期后或固定时间段后是否检索新的证书吊销列表。

选项

  • "timeout"

  • "expiration date"

crl_cache_timeout

整数

何时获取新的证书吊销列表（以分钟为单位）。

details_level

字符串

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

选项

  • "uid"

  • "standard"

  • "full"

domains_to_process

列表 / 元素=字符串

指示在哪些域上处理命令。它不能与 details-level full 一起使用，必须仅从系统域运行并且 ignore-warnings 为 true。有效值为 CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

retrieve_crl_from_http_servers

布尔值

是否从 http 服务器检索证书吊销列表。

选项

  • false

  • true

retrieve_crl_from_ldap_servers

布尔值

是否从 ldap 服务器检索证书吊销列表。

选项

  • false

  • true

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间（分钟）后抛出超时错误。

默认值： 30

示例

- name: add-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    base64_certificate:
     "MIICwjCCAaqgAwIBAgIILdexblpVEMIwDQYJKoZIhvcNAQELBQAwGDEWMBQGA1UEAxMNd3d3Lm9wc2VjLmNvbTAeFw0yMzA2MjUwOTE3MDBaFw0yNTAzMzExNjAwMDBaMBgxFjAUBgNVBAMTDXd3dy5vcH
    lYy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCjpqCxDaVg+I1b+wqnmjjYtL3v7Tlu/YpMbsKnv+M1gRz6QFUOoSVnxKLo0A7Y4kCqa1OPcHO/LtXuok43F1YZPVKm3xWpY8FmqGqf5
    uGmSwm1HPObcMjwGOyFgwpwEDF5e0UMZ7xtJF8BZ5KKBh3ZfQ1FbmbVqSUPcmOi+NE4JspPlHxX+m6es/yeSGR1A2ezKY7KePTlwVtDe8hiLrYyKG92nka5rkD1QyEIVJ0W5wrnU4nGEDIHeOfT09zroQx
    NLkb51sl4Tog/qw+EraVGIBe/iFnSJoDF37i2mLJqI/t8bel+aGDAxgMx1pO85OClgjPSWL0UIXGI2xrR+JAgMBAAGjEDAOMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHTs1AutAmSLHF2
    RLJtrRNkso0lMyA7XI7k1TNpTk7TCZLNY0VbUliGbcl+POH4EG8ARUrftnwRDCTBd2BdJTqG2CyNADi+bw8aLvbxok7KH0GlQvGjyfq+sHK12wTl4ULNyYoAPZ01GhXOvkobROdSyjxvBVhxdVo90kj7mH
    v3N83huNhfstDFUBcQCmMkbLuzDUZrl2a1OtqlOdNC6mNvb7Jq9W9vRxGA514e7jqyoM+PwHu5fILx/jmGT8suOUnvbtcDdFhjqixAPer6uSPR0CSbiJvuDy72DPH5mjZK5dQKewNYOZ/BQEsRIBe+Q6eG
    oJqi+cD63cwlw0DCc="
    name: opsec_ca
    state: present

- name: set-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    name: opsec_ca
    automatic_enrollment:
      automatically_enroll_certificate: true
      protocol: "cmpv1"
      cmpv1_settings:
        direct_tcp_settings:
          ip_address: "1.1.1.1"
    state: present

- name: delete-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    name: opsec_ca
    state: absent

返回值

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

键

描述

cp_mgmt_opsec_trusted_ca

字典

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

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

作者

  • Eden Brillant (@chkp-edenbr)