fortiswitch_system_admin – Administrative user configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and admin category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_system_admin v7.0.0 -> latest

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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_admin - Administrative user configuration. type: dict
    • accprofile - Administrative user access profile. type: str
    • accprofile_override - Enable/disable remote authentication server to override access profile. type: str choices: enable, disable
    • allow_remove_admin_session - Enable/disable privileged administrative users to remove administrative sessions. type: str choices: enable, disable
    • comments - Comment. type: str
    • email_address - Email address. type: str
    • first_name - First name. type: str
    • force_password_change - Enable/disable forcing of password change on next login. type: str choices: enable, disable
    • hidden - Administrative user hidden attribute. type: int
    • ip6_trusthost1 - Trusted host one IP address . type: str
    • ip6_trusthost10 - Trusted host one IP address . type: str
    • ip6_trusthost2 - Trusted host one IP address . type: str
    • ip6_trusthost3 - Trusted host one IP address . type: str
    • ip6_trusthost4 - Trusted host one IP address . type: str
    • ip6_trusthost5 - Trusted host one IP address . type: str
    • ip6_trusthost6 - Trusted host one IP address . type: str
    • ip6_trusthost7 - Trusted host one IP address . type: str
    • ip6_trusthost8 - Trusted host one IP address . type: str
    • ip6_trusthost9 - Trusted host one IP address . type: str
    • is_admin - User has administrative privileges. type: int
    • last_name - Last name. type: str
    • mobile_number - Mobile number. type: str
    • name - Adminstrative user name. type: str required: true
    • pager_number - Pager number. type: str
    • password - Remote authentication password. type: str
    • password_expire - Password expire time. type: str
    • peer_auth - Enable/disable peer authentication. type: str choices: enable, disable
    • peer_group - Peer group name. type: str
    • phone_number - Phone number. type: str
    • remote_auth - Enable/disable remote authentication. type: str choices: enable, disable
    • remote_group - Remote authentication group name. type: str
    • schedule - Schedule name. type: str
    • ssh_public_key1 - SSH public key1. type: str
    • ssh_public_key2 - SSH public key2. type: str
    • ssh_public_key3 - SSH public key3. type: str
    • trusthost1 - Trusted host one IP address . type: str
    • trusthost10 - Trusted host one IP address . type: str
    • trusthost2 - Trusted host one IP address . type: str
    • trusthost3 - Trusted host one IP address . type: str
    • trusthost4 - Trusted host one IP address . type: str
    • trusthost5 - Trusted host one IP address . type: str
    • trusthost6 - Trusted host one IP address . type: str
    • trusthost7 - Trusted host one IP address . type: str
    • trusthost8 - Trusted host one IP address . type: str
    • trusthost9 - Trusted host one IP address . type: str
    • vdom - Virtual domain name. type: str
    • wildcard - Enable/disable wildcard RADIUS authentication. type: str choices: enable, disable
    • wildcard_fallback - Enable/disable attempting authentication against wildcard accounts if authenticating this account fails. type: str choices: enable, disable

Examples

- name: Administrative user configuration.
  fortinet.fortiswitch.fortiswitch_system_admin:
      state: "present"
      system_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          accprofile_override: "enable"
          allow_remove_admin_session: "enable"
          comments: "<your_own_value>"
          Email address.: "<your_own_value>"
          First name.: "<your_own_value>"
          force_password_change: "enable"
          hidden: "10"
          ip6_trusthost1: "<your_own_value>"
          ip6_trusthost10: "<your_own_value>"
          ip6_trusthost2: "<your_own_value>"
          ip6_trusthost3: "<your_own_value>"
          ip6_trusthost4: "<your_own_value>"
          ip6_trusthost5: "<your_own_value>"
          ip6_trusthost6: "<your_own_value>"
          ip6_trusthost7: "<your_own_value>"
          ip6_trusthost8: "<your_own_value>"
          ip6_trusthost9: "<your_own_value>"
          is_admin: "21"
          Last name.: "<your_own_value>"
          Mobile number.: "<your_own_value>"
          name: "default_name_24"
          Pager number.: "<your_own_value>"
          password: "<your_own_value>"
          password_expire: "<your_own_value>"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          Phone number.: "<your_own_value>"
          remote_auth: "enable"
          remote_group: "<your_own_value>"
          schedule: "<your_own_value>"
          ssh_public_key1: "<your_own_value>"
          ssh_public_key2: "<your_own_value>"
          ssh_public_key3: "<your_own_value>"
          trusthost1: "<your_own_value>"
          trusthost10: "<your_own_value>"
          trusthost2: "<your_own_value>"
          trusthost3: "<your_own_value>"
          trusthost4: "<your_own_value>"
          trusthost5: "<your_own_value>"
          trusthost6: "<your_own_value>"
          trusthost7: "<your_own_value>"
          trusthost8: "<your_own_value>"
          trusthost9: "<your_own_value>"
          vdom: "<your_own_value> (source system.vdom.name)"
          wildcard: "enable"
          wildcard_fallback: "enable"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

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