fortinet.fortimanager.fmgr_user_tacacs 模块 – 配置 TACACS+ 服务器条目。

注意

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

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

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

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

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"

user_tacacs

字典

设置的顶层参数。

authen_type

别名：authen-type

字符串

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

选择

  • "auto"

  • "ascii"

  • "pap"

  • "chap"

  • "mschap"

authorization

字符串

启用/禁用 TACACS+ 授权。

选择

  • "disable"

  • "enable"

dynamic_mapping

列表 / 元素=字典

动态映射。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

虚拟域。

authen_type

别名：authen-type

字符串

身份验证类型。

选择

  • "auto"

  • "ascii"

  • "pap"

  • "chap"

  • "mschap"

authorization

字符串

授权。

选择

  • "disable"

  • "enable"

interface

字符串

接口。

interface_select_method

别名：interface-select-method

字符串

接口选择方法。

选择

  • "auto"

  • "sdwan"

  • "specify"

key

任意

（列表）密钥。

port

整数

端口。

secondary_key

别名：secondary-key

任意

（列表）辅助密钥。

secondary_server

别名：secondary-server

字符串

辅助服务器。

server

字符串

服务器。

source_ip

别名：source-ip

字符串

源 IP。

status_ttl

别名：status-ttl

整数

缓存服务器可达性的时间，以便当服务器不可达时，至少在此期间不会重试...

tertiary_key

别名：tertiary-key

任意

（列表）第三密钥。

tertiary_server

别名：tertiary-server

字符串

第三服务器。

interface

字符串

指定用于连接服务器的出站接口。

interface_select_method

别名：interface-select-method

字符串

指定如何选择用于连接服务器的出站接口。

选择

  • "auto"

  • "sdwan"

  • "specify"

key

任意

（列表）用于访问主服务器的密钥。

name

字符串 / 必需

TACACS+ 服务器条目名称。

port

整数

TACACS+ 服务器的端口号。

secondary_key

别名：secondary-key

任意

（列表）用于访问辅助服务器的密钥。

secondary_server

别名：secondary-server

字符串

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

server

字符串

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

source_ip

别名：source-ip

字符串

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

status_ttl

别名：status-ttl

整数

缓存服务器可达性的时间，以便当服务器不可达时，至少在此期间不会重试...

tertiary_key

别名：tertiary-key

任意

（列表）用于访问第三服务器的密钥。

tertiary_server

别名：tertiary-server

字符串

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

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是全局的，也可以是包括 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: Configure TACACS+ server entries.
      fortinet.fortimanager.fmgr_user_tacacs:
        # 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]>
        user_tacacs:
          authen_type: <value in [auto, ascii, pap, ...]>
          authorization: <value in [disable, enable]>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              authen_type: <value in [auto, ascii, pap, ...]>
              authorization: <value in [disable, enable]>
              key: <list or string>
              port: <integer>
              secondary_key: <list or string>
              secondary_server: <string>
              server: <string>
              source_ip: <string>
              tertiary_key: <list or string>
              tertiary_server: <string>
              interface: <string>
              interface_select_method: <value in [auto, sdwan, specify]>
              status_ttl: <integer>
          key: <list or string>
          name: <string>
          port: <integer>
          secondary_key: <list or string>
          secondary_server: <string>
          server: <string>
          source_ip: <string>
          tertiary_key: <list or string>
          tertiary_server: <string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          status_ttl: <integer>

返回值

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

键

描述

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 版本支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)