Try SpotterConfigure SSO admin users in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This 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
- 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: "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)"
vdom:
default: root
description:
- 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.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- 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.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
system_sso_admin:
default: null
description:
- Configure SSO admin users.
suboptions:
accprofile:
description:
- SSO admin user access profile. Source system.accprofile.name.
type: str
gui_dashboard:
description:
- GUI dashboards.
elements: dict
suboptions:
columns:
description:
- Number of columns.
type: int
id:
description:
- Dashboard ID.
type: int
layout_type:
choices:
- responsive
- fixed
description:
- Layout type.
type: str
name:
description:
- Dashboard name.
type: str
permanent:
choices:
- disable
- enable
description:
- Permanent dashboard (can"t be removed via the GUI).
type: str
vdom:
description:
- Virtual domain. Source system.vdom.name.
type: str
widget:
description:
- Dashboard widgets.
elements: dict
suboptions:
fabric_device:
description:
- Fabric device to monitor.
type: str
fabric_device_widget_name:
description:
- Fabric device widget name.
type: str
fabric_device_widget_visualization_type:
description:
- Visualization type for fabric device widget.
type: str
fortiview_device:
description:
- FortiView device.
type: str
fortiview_filters:
description:
- FortiView filters.
elements: dict
suboptions:
id:
description:
- FortiView Filter ID.
type: int
key:
description:
- Filter key.
type: str
value:
description:
- Filter value.
type: str
type: list
fortiview_sort_by:
description:
- FortiView sort by.
type: str
fortiview_timeframe:
description:
- FortiView timeframe.
type: str
fortiview_type:
description:
- FortiView type.
type: str
fortiview_visualization:
description:
- FortiView visualization.
type: str
height:
description:
- Height.
type: int
id:
description:
- Widget ID.
type: int
industry:
choices:
- default
- custom
description:
- Security Audit Rating industry.
type: str
interface:
description:
- Interface to monitor. Source system.interface.name.
type: str
region:
choices:
- default
- custom
description:
- Security Audit Rating region.
type: str
title:
description:
- Widget title.
type: str
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
description:
- Widget type.
type: str
width:
description:
- Width.
type: int
x_pos:
description:
- X position.
type: int
y_pos:
description:
- Y position.
type: int
type: list
type: list
gui_global_menu_favorites:
description:
- Favorite GUI menu IDs for the global VDOM.
elements: dict
suboptions:
id:
description:
- Select menu ID.
type: str
type: list
gui_ignore_release_overview_version:
description:
- The FortiOS version to ignore release overview prompt for.
type: str
gui_new_feature_acknowledge:
description:
- Acknowledgement of new features.
elements: dict
suboptions:
id:
description:
- Select menu ID.
type: str
type: list
gui_vdom_menu_favorites:
description:
- Favorite GUI menu IDs for VDOMs.
elements: dict
suboptions:
id:
description:
- Select menu ID.
type: str
type: list
name:
description:
- SSO admin name.
required: true
type: str
vdom:
description:
- Virtual domain(s) that the administrator can access.
elements: dict
suboptions:
name:
description:
- Virtual domain name. Source system.vdom.name.
type: str
type: list
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str