fortinet.fortimanager.fmgr_user_fsso_dynamicmapping 模块 – 配置 Fortinet 单点登录

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_fsso_dynamicmapping。

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 客户端。

fsso

字符串 / 必填

请求 URL 中的参数 (fsso)。

proposed_method

字符串

用于底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

user_fsso_dynamicmapping

字典

顶层参数集。

_gui_meta

字符串

GUI 元数据。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

Vdom。

group_poll_interval

别名: group-poll-interval

整数

组轮询间隔。

interface

字符串

接口。

interface_select_method

别名: interface-select-method

字符串

接口选择方法。

选项

  • "auto"

  • "sdwan"

  • "specify"

ldap_poll

别名: ldap-poll

字符串

LDAP 轮询。

选项

  • "disable"

  • "enable"

ldap_poll_filter

别名: ldap-poll-filter

字符串

LDAP 轮询筛选器。

ldap_poll_interval

别名: ldap-poll-interval

整数

LDAP 轮询间隔。

ldap_server

别名: ldap-server

字符串

LDAP 服务器。

logon_timeout

别名: logon-timeout

整数

FSSO 服务器关闭后保留登录的分钟数。

password

任意

(列表) 密码。

password2

任意

(列表) 密码2。

password3

任意

(列表) 密码3。

password4

任意

(列表) 密码4。

password5

任意

(列表) 密码5。

port

整数

端口。

port2

整数

端口2。

port3

整数

端口3。

port4

整数

端口4。

port5

整数

端口5。

server

字符串

服务器。

server2

字符串

服务器2。

server3

字符串

服务器3。

server4

字符串

服务器4。

server5

字符串

服务器5。

sni

字符串

服务器名称指示。

source_ip

别名: source-ip

字符串

源 IP。

source_ip6

别名: source-ip6

字符串

源 IPv6。

ssl

字符串

SSL。

选项

  • "disable"

  • "enable"

ssl_server_host_ip_check

别名: ssl-server-host-ip-check

字符串

启用/禁用服务器主机/IP 验证。

选项

  • "disable"

  • "enable"

ssl_trusted_cert

别名: ssl-trusted-cert

字符串

SSL 受信任证书。

type

字符串

类型。

选项

  • "default"

  • "fortiems"

  • "fortinac"

  • "fortiems-cloud"

user_info_server

别名: user-info-server

任意

(列表或字符串) 用户信息服务器。

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of Fortinet Single Sign On (FSSO) agent
      fortinet.fortimanager.fmgr_user_fsso_dynamicmapping:
        bypass_validation: false
        adom: ansible
        fsso: ansible-test-fsso # name
        state: present
        user_fsso_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          password: fortinet
          port: 9000
          server: ansible

- 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 dynamic mappings of Fortinet Single Sign On (FSSO) agent
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fsso_dynamicmapping"
          params:
            adom: "ansible"
            fsso: "ansible-test-fsso" # name
            dynamic_mapping: "your_value"

返回值

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

键

描述

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)