Skip to content

Latest commit

 

History

History
213 lines (169 loc) · 9.56 KB

fortios_system_sso_fortigate_cloud_admin.rst

File metadata and controls

213 lines (169 loc) · 9.56 KB
Raw
source:fortios_system_sso_fortigate_cloud_admin.py
orphan:

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

.. versionadded:: 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_fortigate_cloud_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

Tips

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

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_sso_fortigate_cloud_admin v7.2.4 -> latest

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_fortigate_cloud_admin - Configure FortiCloud SSO admin users. type: dict more...
    Supported Version Ranges
    system_sso_fortigate_cloud_admin v7.2.4 -> latest
    • accprofile - FortiCloud SSO admin user access profile. Source system.accprofile.name. type: str more...
      Supported Version Ranges
      accprofile v7.2.4 -> latest
    • name - FortiCloud SSO admin name. type: str required: true more...
      Supported Version Ranges
      name v7.2.4 -> latest
    • vdom - Virtual domain(s) that the administrator can access. type: list member_path: vdom:name more...
      Supported Version Ranges
      vdom v7.2.4 -> latest
      • name - Virtual domain name. Source system.vdom.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.4 -> latest

Notes

Note

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

Examples

- name: Configure FortiCloud SSO admin users.
  fortinet.fortios.fortios_system_sso_fortigate_cloud_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sso_fortigate_cloud_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          name: "default_name_4"
          vdom:
              -
                  name: "default_name_6 (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.