fortinet.fortimanager.fmgr_user_fssopolling 模块 – 配置轮询模式的 FSSO 活动目录服务器。

注意

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

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

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

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

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_fssopolling

字典

顶层参数集。

_gui_meta

字符串

Gui 元数据。

adgrp

列表 / 元素=字典

Adgrp。

name

字符串

名称。

default_domain

别名：default-domain

字符串

此活动目录服务器管理的默认域。

id

整数 / 必需

活动目录服务器 ID。

ldap_server

别名：ldap-server

字符串

LDAP 连接字符串中使用的 LDAP 服务器名称。

logon_history

别名：logon-history

整数

要保留的登录历史记录的小时数，0 表示保留所有历史记录。

password

任何

（列表）登录此活动目录服务器所需的密码

polling_frequency

别名：polling-frequency

整数

轮询频率

port

整数

与此活动目录服务器通信的端口。

server

字符串

活动目录服务器的主机名或 IP 地址。

smb_ntlmv1_auth

别名：smb-ntlmv1-auth

字符串

启用/禁用 Samba 身份验证对 NTLMv1 的支持。

选项

  • "disable"

  • "enable"

smbv1

字符串

启用/禁用 Samba 对 SMBv1 的支持。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用对此活动目录服务器状态的轮询。

选项

  • "disable"

  • "enable"

user

字符串

登录此活动目录服务器所需的用户名。

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FSSO active directory servers for polling mode.
      fortinet.fortimanager.fmgr_user_fssopolling:
        bypass_validation: false
        adom: ansible
        state: present
        user_fssopolling:
          id: 1
          password: fortinet
          port: 8000
          server: ansible
          status: disable

- 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 FSSO active directory servers for polling mode
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fssopolling"
          params:
            adom: "ansible"
            fsso-polling: "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)