fortinet.fortios.fortios_system_api_user module – Configure API users in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.9).

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_api_user.

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 api_user 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

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

system_api_user

dictionary

Configure API users.

accprofile

string

Admin user access profile. Source system.accprofile.name.

api_key

string

Admin user password.

comments

string

Comment.

cors_allow_origin

string

Value for Access-Control-Allow-Origin on API responses. Avoid using “*” if possible.

name

string / required

User name.

peer_auth

string

Enable/disable peer authentication.

Choices:

  • "enable"

  • "disable"

peer_group

string

Peer group name.

schedule

string

Schedule name.

trusthost

list / elements=dictionary

Trusthost.

id

integer / required

ID. see <a href=’#notes’>Notes</a>.

ipv4_trusthost

string

IPv4 trusted host address.

ipv6_trusthost

string

IPv6 trusted host address.

type

string

Trusthost type.

Choices:

  • "ipv4-trusthost"

  • "ipv6-trusthost"

vdom

list / elements=dictionary

Virtual domains.

name

string / required

Virtual domain name. Source system.vdom.name.

vdom

string

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: "root"

Notes

Note

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

  • The module supports check_mode.

Examples

- name: Configure API users.
  fortinet.fortios.fortios_system_api_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_api_user:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          api_key: "<your_own_value>"
          comments: "<your_own_value>"
          cors_allow_origin: "<your_own_value>"
          name: "default_name_7"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          schedule: "<your_own_value>"
          trusthost:
              -
                  id: "12"
                  ipv4_trusthost: "myhostname"
                  ipv6_trusthost: "myhostname"
                  type: "ipv4-trusthost"
          vdom:
              -
                  name: "default_name_17 (source system.vdom.name)"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)