fortinet.fortios.fortios_user_tacacsplus 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 TACACS+ 服务器条目。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定: fortinet.fortios.fortios_user_tacacsplus

在 fortinet.fortios 2.0.0 中新增

概要

  • 此模块能够通过允许用户设置和修改用户功能和 tacacsplus 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整为数据源。 使用 FOS v6.0.0 测试

要求

执行此模块的主机需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

user_tacacsplus

字典

配置 TACACS+ 服务器条目。

authen_type

字符串

允许的身份验证协议/方法。

选项

  • "mschap"

  • "chap"

  • "pap"

  • "ascii"

  • "auto"

authorization

字符串

启用/禁用 TACACS+ 授权。

选项

  • "enable"

  • "disable"

interface

字符串

指定用于连接服务器的传出接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择传出接口以连接服务器。

选项

  • "auto"

  • "sdwan"

  • "specify"

key

字符串

访问主服务器的密钥。

name

字符串 / 必需

TACACS+ 服务器条目名称。

port

整数

TACACS+ 服务器的端口号。

secondary_key

字符串

访问辅助服务器的密钥。

secondary_server

字符串

辅助 TACACS+ 服务器 CN 域名或 IP 地址。

server

字符串

主 TACACS+ 服务器 CN 域名或 IP 地址。

source_ip

字符串

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

status_ttl

整数

缓存服务器可达性的时间,以便当服务器不可达时,至少在此时间段内不会重试(0 = 禁用缓存)。

tertiary_key

字符串

访问第三服务器的密钥。

tertiary_server

字符串

第三 TACACS+ 服务器 CN 域名或 IP 地址。

vdom

字符串

虚拟域,在先前定义的那些域中。 vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。

默认值: "root"

注释

注意

  • 旧的 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure TACACS+ server entries.
  fortinet.fortios.fortios_user_tacacsplus:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_tacacsplus:
          authen_type: "mschap"
          authorization: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          key: "<your_own_value>"
          name: "default_name_8"
          port: "49"
          secondary_key: "<your_own_value>"
          secondary_server: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status_ttl: "300"
          tertiary_key: "<your_own_value>"
          tertiary_server: "<your_own_value>"

返回值

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

描述

build

字符串

fortigate 映像的构建编号

返回: 总是

示例: "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回: 总是

示例: "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥(id)

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回: 总是

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回: 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回: 总是

示例: "root"

版本

字符串

FortiGate 的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)