fortios_system_sso_admin.rst

source:	fortios_system_sso_admin.py
orphan:

fortios_system_sso_admin -- Configure SSO admin users in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

v6.2.0

v6.2.3

v6.2.5

v6.2.7

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.0.12

v7.2.0

v7.2.1

v7.2.2

v7.2.4

v7.4.0

fortios_system_sso_admin

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• system_sso_admin - Configure SSO admin users. type: dict more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  system_sso_admin

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• accprofile - SSO admin user access profile. Source system.accprofile.name. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  accprofile

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• gui_dashboard - GUI dashboards. type: list member_path: gui_dashboard:id more...

  	v6.2.0	v6.2.3
  gui_dashboard	no	yes

• columns - Number of columns. type: int more...

  	v6.2.3
  columns	yes

• id - Dashboard ID. type: int required: true more...

  	v6.2.3
  id	yes

• layout_type - Layout type. type: str choices: responsive, fixed more...

  	v6.2.3
  layout_type	yes
  [responsive]	yes
  [fixed]	yes

• name - Dashboard name. type: str more...

  	v6.2.3
  name	yes

• permanent - Permanent dashboard (can"t be removed via the GUI). type: str choices: disable, enable more...

  	v6.2.3
  permanent	yes
  [disable]	yes
  [enable]	yes

• vdom - Virtual domain. Source system.vdom.name. type: str more...

  	v6.2.3
  vdom	yes

• widget - Dashboard widgets. type: list member_path: gui_dashboard:id/widget:id more...

  	v6.2.3
  widget	yes

• fabric_device - Fabric device to monitor. type: str more...

  	v6.2.3
  fabric_device	yes

• fabric_device_widget_name - Fabric device widget name. type: str more...

  	v6.2.3
  fabric_device_widget_name	yes

• fabric_device_widget_visualization_type - Visualization type for fabric device widget. type: str more...

  	v6.2.3
  fabric_device_widget_visualization_type	yes

• fortiview_device - FortiView device. type: str more...

  	v6.2.3
  fortiview_device	yes

• fortiview_filters - FortiView filters. type: list member_path: gui_dashboard:id/widget:id/fortiview_filters:id more...

  	v6.2.3
  fortiview_filters	yes

• id - FortiView Filter ID. type: int required: true more...

  	v6.2.3
  id	yes

• key - Filter key. type: str more...

  	v6.2.3
  key	yes

• value - Filter value. type: str more...

  	v6.2.3
  value	yes

• fortiview_sort_by - FortiView sort by. type: str more...

  	v6.2.3
  fortiview_sort_by	yes

• fortiview_timeframe - FortiView timeframe. type: str more...

  	v6.2.3
  fortiview_timeframe	yes

• fortiview_type - FortiView type. type: str more...

  	v6.2.3
  fortiview_type	yes

• fortiview_visualization - FortiView visualization. type: str more...

  	v6.2.3
  fortiview_visualization	yes

• height - Height. type: int more...

  	v6.2.3
  height	yes

• id - Widget ID. type: int required: true more...

  	v6.2.3
  id	yes

• industry - Security Audit Rating industry. type: str choices: default, custom more...

  	v6.2.3
  industry	yes
  [default]	yes
  [custom]	yes

• interface - Interface to monitor. Source system.interface.name. type: str more...

  	v6.2.3
  interface	yes

• region - Security Audit Rating region. type: str choices: default, custom more...

  	v6.2.3
  region	yes
  [default]	yes
  [custom]	yes

• title - Widget title. type: str more...

  	v6.2.3
  title	yes

• type - Widget type. type: str 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 more...

  	v6.2.3
  type	yes
  [sysinfo]	yes
  [licinfo]	yes
  [forticloud]	yes
  [cpu-usage]	yes
  [memory-usage]	yes
  [disk-usage]	yes
  [log-rate]	yes
  [sessions]	yes
  [session-rate]	yes
  [tr-history]	yes
  [analytics]	yes
  [usb-modem]	yes
  [admins]	yes
  [security-fabric]	yes
  [security-fabric-ranking]	yes
  [sensor-info]	yes
  [ha-status]	yes
  [vulnerability-summary]	yes
  [host-scan-summary]	yes
  [fortiview]	yes
  [botnet-activity]	yes
  [fabric-device]	yes

• width - Width. type: int more...

  	v6.2.3
  width	yes

• x_pos - X position. type: int more...

  	v6.2.3
  x_pos	yes

• y_pos - Y position. type: int more...

  	v6.2.3
  y_pos	yes

• gui_global_menu_favorites - Favorite GUI menu IDs for the global VDOM. type: list member_path: gui_global_menu_favorites:id more...

  	v6.2.0	v6.2.3
  gui_global_menu_favorites	no	yes

• id - Select menu ID. type: str required: true more...

  	v6.2.3
  id	yes

• gui_ignore_release_overview_version - The FortiOS version to ignore release overview prompt for. type: str more...

  	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1
  gui_ignore_release_overview_version	no	no	no	no	no	yes

• gui_new_feature_acknowledge - Acknowledgement of new features. type: list member_path: gui_new_feature_acknowledge:id more...

  	v6.2.0	v6.2.3
  gui_new_feature_acknowledge	no	yes

• id - Select menu ID. type: str required: true more...

  	v6.2.3
  id	yes

• gui_vdom_menu_favorites - Favorite GUI menu IDs for VDOMs. type: list member_path: gui_vdom_menu_favorites:id more...

  	v6.2.0	v6.2.3
  gui_vdom_menu_favorites	no	yes

• id - Select menu ID. type: str required: true more...

  	v6.2.3
  id	yes

• name - SSO admin name. type: str required: true more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• vdom - Virtual domain(s) that the administrator can access. type: list member_path: vdom:name more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  vdom

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• name - Virtual domain name. Source system.vdom.name. type: str required: true more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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: "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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• build - Build number of the fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
• name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
• path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.