fortinet.fortimanager.fmgr_vpn_certificate_ca 模块 – CA 证书。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_vpn_certificate_ca。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

vpn_certificate_ca

字典

设置的顶级参数。

_private_key

字符串

私钥。

auto_update_days

别名：auto-update-days

整数

请求更新的 CA 证书之前要等待的天数

auto_update_days_warning

别名：auto-update-days-warning

整数

生成过期警告消息之前的天数

ca

字符串

作为 PEM 文件的 CA 证书。

ca_identifier

别名：ca-identifier

字符串

SCEP 服务器的 CA 标识符。

est_url

别名：est-url

字符串

EST 服务器的 URL。

fabric_ca

别名：fabric-ca

字符串

启用/禁用跨安全结构的 CA 同步。

选项

  • "disable"

  • "enable"

last_updated

别名：last-updated

整数

上次更新 CA 的时间。

name

字符串 / 必需

名称。

non_fabric_name

别名：non-fabric-name

字符串

成为安全结构同步 CA 之前的名称。

obsolete

字符串

启用/禁用此 CA 为已弃用。

选项

  • "disable"

  • "enable"

range

字符串

CA 证书的全局或 VDOM IP 地址范围。

选项

  • "global"

  • "vdom"

scep_url

别名：scep-url

字符串

SCEP 服务器的 URL。

source

字符串

CA 证书源类型。

选项

  • "factory"

  • "user"

  • "bundle"

  • "fortiguard"

source_ip

别名：source-ip

字符串

与 SCEP 服务器通信的源 IP 地址。

ssl_inspection_trusted

别名：ssl-inspection-trusted

字符串

启用/禁用此 CA 作为 SSL 检查的受信任 CA。

选项

  • "disable"

  • "enable"

trusted

字符串

启用/禁用为受信任的 CA。

选项

  • "disable"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是 global 和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（秒）。

默认值： 300

注释

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧参数名称仍然可用，但您会收到弃用警告。您可以在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: CA certificate.
      fortinet.fortimanager.fmgr_vpn_certificate_ca:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpn_certificate_ca:
          _private_key: <string>
          auto_update_days: <integer>
          auto_update_days_warning: <integer>
          ca: <string>
          last_updated: <integer>
          name: <string>
          range: <value in [global, vdom]>
          scep_url: <string>
          source: <value in [factory, user, bundle, ...]>
          source_ip: <string>
          trusted: <value in [disable, enable]>
          ssl_inspection_trusted: <value in [disable, enable]>
          ca_identifier: <string>
          obsolete: <value in [disable, enable]>
          est_url: <string>
          fabric_ca: <value in [disable, enable]>
          non_fabric_name: <string>

返回值

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

键

描述

meta

字典

请求的结果。

已返回：始终

request_url

字符串

请求的完整 URL。

已返回：始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

已返回：始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

已返回：始终

response_message

字符串

API 响应的描述性消息。

已返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

已返回：始终

rc

整数

请求的状态。

已返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑凌 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆洪滨 (@fgtdev-hblu)