fortinet.fortimanager.fmgr_generic 模块 – 构建并发送通用的 FortiManager API 请求。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块用于通用的 FortiManager 请求。它接收原始的 json-rpc 数据，并将其发送到 FortiManager，最后将响应返回给用户。

  • 此模块还依赖于 FortiManager httpapi 插件作为传输方式。

  • payload 不包括会话，httpapi 插件稍后会自动填充会话。

  • 用户名和密码不是由模块管理，而是由插件管理。

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

启用/禁用任务日志记录

选择

  • false ← （默认）

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端

json

字符串

要发送到 FortiManager 的原始 JSON 格式 payload

method

字符串

json-rpc 的方法

它必须是 [get, add, set, update, delete, move, clone, exec] 中的一个

params

列表 / 元素=字典

参数集合。

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

workspace_locking_adom

字符串

无描述

workspace_locking_timeout

整数

无描述

默认值： 300

注释

注意

  • 支持两种参数方案，一种是原始 JSON 格式，另一种是 Ansible 可识别的顶层参数格式。

  • json 定义为字符串，用户负责使其为 JSON 格式

  • 如果不存在 'json'，则应由用户指定方法和参数

  • 如果提供了所有三个参数，则首选 'json'。

示例

- name: Generic module
  hosts: fortimanagers
  connection: httpapi
  vars:
    adom: "root"
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Login a user
      fortinet.fortimanager.fmgr_generic:
        method: "exec"
        params:
          - url: "sys/login/user"
            data:
              - user: "APIUser"
                passwd: "Fortinet1!e"
    - name: Login another user
      fortinet.fortimanager.fmgr_generic:
        json: |
          {
           "method":"exec",
           "params":[
            {
                 "url":"sys/login/user",
                 "data":[
                    {
                       "user":"APIUser",
                       "passwd":"Fortinet1!"
                    }
                  ]
             }
            ]
          }

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

api_result

字符串

完整的 API 响应，包括状态代码和消息

已返回： 始终

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Link Zheng (@zhengl)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)