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.8).
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure SSO admin users. |
|
SSO admin user access profile. Source system.accprofile.name. |
|
GUI dashboards. |
|
Number of columns. |
|
Dashboard ID. see <a href=’#notes’>Notes</a>. |
|
Layout type. Choices:
|
|
Dashboard name. |
|
Permanent dashboard (can”t be removed via the GUI). Choices:
|
|
Virtual domain. Source system.vdom.name. |
|
Dashboard widgets. |
|
Fabric device to monitor. |
|
Fabric device widget name. |
|
Visualization type for fabric device widget. |
|
FortiView device. |
|
FortiView filters. |
|
FortiView Filter ID. see <a href=’#notes’>Notes</a>. |
|
Filter key. |
|
Filter value. |
|
FortiView sort by. |
|
FortiView timeframe. |
|
FortiView type. |
|
FortiView visualization. |
|
Height. |
|
Widget ID. see <a href=’#notes’>Notes</a>. |
|
Security Audit Rating industry. Choices:
|
|
Interface to monitor. Source system.interface.name. |
|
Security Audit Rating region. Choices:
|
|
Widget title. |
|
Widget type. Choices:
|
|
Width. |
|
X position. |
|
Y position. |
|
Favorite GUI menu IDs for the global VDOM. |
|
Select menu ID. |
|
The FortiOS version to ignore release overview prompt for. |
|
Acknowledgement of new features. |
|
Select menu ID. |
|
Favorite GUI menu IDs for VDOMs. |
|
Select menu ID. |
|
SSO admin name. |
|
Virtual domain(s) that the administrator can access. |
|
Virtual domain name. Source system.vdom.name. |
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
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 number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |