W3cubDocs

/Ansible

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

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

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

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
system_sso_admin
dictionary
Configure SSO admin users.
accprofile
string
SSO admin user access profile. Source system.accprofile.name.
gui_dashboard
list / elements=string
GUI dashboards.
columns
integer
Number of columns.
id
integer / required
Dashboard ID.
layout_type
string
    Choices:
  • responsive
  • fixed
Layout type.
name
string
Dashboard name.
permanent
string
    Choices:
  • disable
  • enable
Permanent dashboard (can"t be removed via the GUI).
vdom
string
Virtual domain. Source system.vdom.name.
widget
list / elements=string
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=string
FortiView filters.
id
integer / required
FortiView Filter ID.
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.
industry
string
    Choices:
  • default
  • custom
Security Audit Rating industry.
interface
string
Interface to monitor. Source system.interface.name.
region
string
    Choices:
  • default
  • custom
Security Audit Rating region.
title
string
Widget title.
type
string
    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
Widget type.
width
integer
Width.
x_pos
integer
X position.
y_pos
integer
Y position.
gui_global_menu_favorites
list / elements=string
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=string
Acknowledgement of new features.
id
string / required
Select menu ID.
gui_vdom_menu_favorites
list / elements=string
Favorite GUI menu IDs for VDOMs.
id
string / required
Select menu ID.
name
string / required
SSO admin name.
vdom
list / elements=string
Virtual domain(s) that the administrator can access.
name
string / required
Virtual domain name. Source system.vdom.name.
vdom
string
Default:
"root"
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.

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure SSO admin users.
    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: "5"
            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: "24"
                id:  "25"
                industry: "default"
                interface: "<your_own_value> (source system.interface.name)"
                region: "default"
                title: "<your_own_value>"
                type: "sysinfo"
                width: "31"
                x_pos: "32"
                y_pos: "33"
        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 Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_sso_admin_module.html