Steampunk Ansible Documentation - drmofu.fortimanager.fmgr_user_fsso (2.2.2) - module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - 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 Fortinet Single Sign On (FSSO) agents
      fmgr_fact:
        facts:
            selector: 'user_fsso'
            params:
                adom: 'ansible'
                fsso: 'your_value'

Scanned by Steampunk Spotter

 - 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 Fortinet Single Sign On (FSSO) agents.
      fmgr_user_fsso:
         bypass_validation: False
         adom: ansible
         state: present
         user_fsso:
            name: ansible-test-fsso
            password: fortinet
            port: 9000
            server: ansible

Inputs

adom:
description: the parameter (adom) in requested url
required: true
type: str

state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list

user_fsso:
description: the top level parameters set
required: false
suboptions:
_gui_meta:
description: _Gui_Meta.
type: str
dynamic_mapping:
description: Dynamic_Mapping.
elements: dict
suboptions:
_gui_meta:
description: _Gui_Meta.
type: str
_scope:
description: _Scope.
elements: dict
suboptions:
name:
description: Name.
type: str
vdom:
description: Vdom.
type: str
type: list
group-poll-interval:
description: Interval in minutes within to fetch groups from FSSO server,
or unset to disable.
type: int
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Specify how to select outgoing interface to reach server.
type: str
ldap-poll:
choices:
- disable
- enable
description: Enable/disable automatic fetching of groups from LDAP server.
type: str
ldap-poll-filter:
description: Filter used to fetch groups.
type: str
ldap-poll-interval:
description: Interval in minutes within to fetch groups from LDAP server.
type: int
ldap-server:
description: LDAP server to get group information.
type: str
logon-timeout:
description: Interval in minutes to keep logons after FSSO server down.
type: int
password:
description: Password of the first FSSO collector agent.
type: str
password2:
description: Password of the second FSSO collector agent.
type: str
password3:
description: Password of the third FSSO collector agent.
type: str
password4:
description: Password of the fourth FSSO collector agent.
type: str
password5:
description: Password of the fifth FSSO collector agent.
type: str
port:
description: Port of the first FSSO collector agent.
type: int
port2:
description: Port of the second FSSO collector agent.
type: int
port3:
description: Port of the third FSSO collector agent.
type: int
port4:
description: Port of the fourth FSSO collector agent.
type: int
port5:
description: Port of the fifth FSSO collector agent.
type: int
server:
description: Domain name or IP address of the first FSSO collector agent.
type: str
server2:
description: Domain name or IP address of the second FSSO collector agent.
type: str
server3:
description: Domain name or IP address of the third FSSO collector agent.
type: str
server4:
description: Domain name or IP address of the fourth FSSO collector agent.
type: str
server5:
description: Domain name or IP address of the fifth FSSO collector agent.
type: str
sni:
description: Server Name Indication.
type: str
source-ip:
description: Source IP for communications to FSSO agent.
type: str
source-ip6:
description: IPv6 source for communications to FSSO agent.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable use of SSL.
type: str
ssl-server-host-ip-check:
choices:
- disable
- enable
description: Enable/disable server host/IP verification.
type: str
ssl-trusted-cert:
description: Trusted server certificate or CA certificate.
type: str
type:
choices:
- default
- fortiems
- fortinac
- fortiems-cloud
description: Server type.
type: str
user-info-server:
description: LDAP server to get user information.
type: str
type: list
group-poll-interval:
description: Interval in minutes within to fetch groups from FSSO server, or unset
to disable.
type: int
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Specify how to select outgoing interface to reach server.
type: str
ldap-poll:
choices:
- disable
- enable
description: Enable/disable automatic fetching of groups from LDAP server.
type: str
ldap-poll-filter:
description: Filter used to fetch groups.
type: str
ldap-poll-interval:
description: Interval in minutes within to fetch groups from LDAP server.
type: int
ldap-server:
description: LDAP server to get group information.
type: str
logon-timeout:
description: Interval in minutes to keep logons after FSSO server down.
type: int
name:
description: Name.
type: str
password:
description: Password of the first FSSO collector agent.
type: str
password2:
description: Password of the second FSSO collector agent.
type: str
password3:
description: Password of the third FSSO collector agent.
type: str
password4:
description: Password of the fourth FSSO collector agent.
type: str
password5:
description: Password of the fifth FSSO collector agent.
type: str
port:
description: Port of the first FSSO collector agent.
type: int
port2:
description: Port of the second FSSO collector agent.
type: int
port3:
description: Port of the third FSSO collector agent.
type: int
port4:
description: Port of the fourth FSSO collector agent.
type: int
port5:
description: Port of the fifth FSSO collector agent.
type: int
server:
description: Domain name or IP address of the first FSSO collector agent.
type: str
server2:
description: Domain name or IP address of the second FSSO collector agent.
type: str
server3:
description: Domain name or IP address of the third FSSO collector agent.
type: str
server4:
description: Domain name or IP address of the fourth FSSO collector agent.
type: str
server5:
description: Domain name or IP address of the fifth FSSO collector agent.
type: str
sni:
description: Server Name Indication.
type: str
source-ip:
description: Source IP for communications to FSSO agent.
type: str
source-ip6:
description: IPv6 source for communications to FSSO agent.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable use of SSL.
type: str
ssl-server-host-ip-check:
choices:
- disable
- enable
description: Enable/disable server host/IP verification.
type: str
ssl-trusted-cert:
description: Trusted server certificate or CA certificate.
type: str
type:
choices:
- default
- fortiems
- fortinac
- fortiems-cloud
description: Server type.
type: str
user-info-server:
description: LDAP server to get user information.
type: str
type: dict

enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool

access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list