fortinet.fortimanager.fmgr_user_fssopolling module – Configure FSSO active directory servers for polling mode.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_fssopolling.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

user_fssopolling

dictionary

the top level parameters set

_gui_meta

string

_Gui_Meta.

adgrp

list / elements=string

Adgrp.

name

string

Name.

default-domain

string

Default domain managed by this Active Directory server.

id

integer

Active Directory server ID.

ldap-server

string

LDAP server name used in LDAP connection strings.

logon-history

integer

Number of hours of logon history to keep, 0 means keep all history.

password

string

Password required to log into this Active Directory server

polling-frequency

integer

Polling frequency (every 1 to 30 seconds).

port

integer

Port to communicate with this Active Directory server.

server

string

Host name or IP address of the Active Directory server.

smb-ntlmv1-auth

string

Enable/disable support of NTLMv1 for Samba authentication.

Choices:

  • disable

  • enable

smbv1

string

Enable/disable support of SMBv1 for Samba.

Choices:

  • disable

  • enable

status

string

Enable/disable polling for the status of this Active Directory server.

Choices:

  • disable

  • enable

user

string

User name required to log into this Active Directory server.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  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
     fmgr_fact:
       facts:
           selector: 'user_fssopolling'
           params:
               adom: 'ansible'
               fsso-polling: ''

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  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.
     fmgr_user_fssopolling:
        bypass_validation: False
        adom: ansible
        state: present
        user_fssopolling:
           id: 1
           password: fortinet
           port: 8000
           server: ansible
           status: disable

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)