fortinet.fortimanager.fmgr_system_admin_radius 模块 – 配置 radius。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数

注释

access_token

string

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

bypass_validation

boolean

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

选择

  • false ←（默认）

  • true

enable_log

boolean

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

选择

  • false ←（默认）

  • true

forticloud_access_token

string

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

proposed_method

string

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

state

string / required

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

选择

  • "present"

  • "absent"

system_admin_radius

dictionary

设置的顶层参数。

auth_type

别名: auth-type

string

身份验证协议。

any - 使用任何支持的身份验证协议。

pap - PAP。

chap - CHAP。

mschap2 - MSCHAPv2。

选择

  • "any"

  • "pap"

  • "chap"

  • "mschap2"

name

string / required

名称。

nas_ip

别名: nas-ip

string

NAS IP 地址和被叫站 ID。

port

integer

服务器端口。

secondary_secret

别名: secondary-secret

any

（列表）辅助服务器密钥。

secondary_server

别名: secondary-server

string

辅助服务器名称/IP。

secret

any

（列表）服务器密钥。

server

string

服务器名称/IP。

workspace_locking_adom

string

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

workspace_locking_timeout

integer

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

默认值： 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure radius.
      fortinet.fortimanager.fmgr_system_admin_radius:
        bypass_validation: false
        state: present
        system_admin_radius:
          auth-type: pap # <value in [any, pap, chap, ...]>
          name: ansible-test-radius
          port: 1812
          server: "ALL"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the radius
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_radius"
          params:
            radius: "your_value"

返回值

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

键

描述

meta

dictionary

请求的结果。

返回值：总是

request_url

string

请求的完整 URL。

返回值：总是

示例： "/sys/login/user"

response_code

integer

api 请求的状态。

返回值：总是

示例： 0

response_data

list / elements=string

api 响应。

返回值：总是

response_message

string

api 响应的描述性消息。

返回值：总是

示例： "OK."

system_information

dictionary

目标系统的信息。

返回值：总是

rc

integer

请求的状态。

返回值：总是

示例： 0

version_check_warning

list / elements=string

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

返回值：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)