fortios_system_api_user – Configure API users in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_system_api_user – Configure API users in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## 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.5

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9 | Choices: present absent | Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
system_api_user dictionary | Default: null | 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 | Choices: enable disable | Enable/disable peer authentication.
| peer_group string |  | Peer group name.
| schedule string |  | Schedule name.
| state string | Choices: present absent | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
| trusthost list |  | Trusthost.
|  | id integer / required |  | Table ID.
|  | ipv4_trusthost string |  | IPv4 trusted host address.
|  | ipv6_trusthost string |  | IPv6 trusted host address.
|  | type string | Choices: ipv4-trusthost ipv6-trusthost | Trusthost type.
| vdom list |  | Virtual domains.
|  | name string / required |  | Virtual domain name. Source system.vdom.name.
username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet

- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure API users.
        fortios_system_api_user:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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: "<your_own_value>"
                ipv6_trusthost: "<your_own_value>"
                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 | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)

- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.