fortinet.fortios.fortios_system_sso_admin module – Configure SSO admin users in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.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.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_system_sso_admin.

New in fortinet.fortios 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sso_admin category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

system_sso_admin

dictionary

Configure SSO admin users.

accprofile

string

SSO admin user access profile. Source system.accprofile.name.

gui_dashboard

list / elements=dictionary

GUI dashboards.

columns

integer

Number of columns.

id

integer / required

Dashboard ID. see <a href=’#notes’>Notes</a>.

layout_type

string

Layout type.

Choices:

  • "responsive"

  • "fixed"

name

string

Dashboard name.

permanent

string

Permanent dashboard (can”t be removed via the GUI).

Choices:

  • "disable"

  • "enable"

vdom

string

Virtual domain. Source system.vdom.name.

widget

list / elements=dictionary

Dashboard widgets.

fabric_device

string

Fabric device to monitor.

fabric_device_widget_name

string

Fabric device widget name.

fabric_device_widget_visualization_type

string

Visualization type for fabric device widget.

fortiview_device

string

FortiView device.

fortiview_filters

list / elements=dictionary

FortiView filters.

id

integer / required

FortiView Filter ID. see <a href=’#notes’>Notes</a>.

key

string

Filter key.

value

string

Filter value.

fortiview_sort_by

string

FortiView sort by.

fortiview_timeframe

string

FortiView timeframe.

fortiview_type

string

FortiView type.

fortiview_visualization

string

FortiView visualization.

height

integer

Height.

id

integer / required

Widget ID. see <a href=’#notes’>Notes</a>.

industry

string

Security Audit Rating industry.

Choices:

  • "default"

  • "custom"

interface

string

Interface to monitor. Source system.interface.name.

region

string

Security Audit Rating region.

Choices:

  • "default"

  • "custom"

title

string

Widget title.

type

string

Widget type.

Choices:

  • "sysinfo"

  • "licinfo"

  • "forticloud"

  • "cpu-usage"

  • "memory-usage"

  • "disk-usage"

  • "log-rate"

  • "sessions"

  • "session-rate"

  • "tr-history"

  • "analytics"

  • "usb-modem"

  • "admins"

  • "security-fabric"

  • "security-fabric-ranking"

  • "sensor-info"

  • "ha-status"

  • "vulnerability-summary"

  • "host-scan-summary"

  • "fortiview"

  • "botnet-activity"

  • "fabric-device"

width

integer

Width.

x_pos

integer

X position.

y_pos

integer

Y position.

gui_global_menu_favorites

list / elements=dictionary

Favorite GUI menu IDs for the global VDOM.

id

string / required

Select menu ID.

gui_ignore_release_overview_version

string

The FortiOS version to ignore release overview prompt for.

gui_new_feature_acknowledge

list / elements=dictionary

Acknowledgement of new features.

id

string / required

Select menu ID.

gui_vdom_menu_favorites

list / elements=dictionary

Favorite GUI menu IDs for VDOMs.

id

string / required

Select menu ID.

name

string / required

SSO admin name.

vdom

list / elements=dictionary

Virtual domain(s) that the administrator can access.

name

string / required

Virtual domain name. Source system.vdom.name.

vdom

string

Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure SSO admin users.
  fortinet.fortios.fortios_system_sso_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sso_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          gui_dashboard:
              -
                  columns: "10"
                  id: "6"
                  layout_type: "responsive"
                  name: "default_name_8"
                  permanent: "disable"
                  vdom: "<your_own_value> (source system.vdom.name)"
                  widget:
                      -
                          fabric_device: "<your_own_value>"
                          fabric_device_widget_name: "<your_own_value>"
                          fabric_device_widget_visualization_type: "<your_own_value>"
                          fortiview_device: "<your_own_value>"
                          fortiview_filters:
                              -
                                  id: "17"
                                  key: "<your_own_value>"
                                  value: "<your_own_value>"
                          fortiview_sort_by: "<your_own_value>"
                          fortiview_timeframe: "<your_own_value>"
                          fortiview_type: "<your_own_value>"
                          fortiview_visualization: "<your_own_value>"
                          height: "25"
                          id: "25"
                          industry: "default"
                          interface: "<your_own_value> (source system.interface.name)"
                          region: "default"
                          title: "<your_own_value>"
                          type: "sysinfo"
                          width: "25"
                          x_pos: "500"
                          y_pos: "500"
          gui_global_menu_favorites:
              -
                  id: "35"
          gui_ignore_release_overview_version: "<your_own_value>"
          gui_new_feature_acknowledge:
              -
                  id: "38"
          gui_vdom_menu_favorites:
              -
                  id: "40"
          name: "default_name_41"
          vdom:
              -
                  name: "default_name_43 (source system.vdom.name)"

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)