New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
||
system_api_user
-
|
Default: null
|
Configure API users.
|
||
accprofile
-
|
Admin user access profile. Source system.accprofile.name.
|
|||
api-key
-
|
Admin user password.
|
|||
comments
-
|
Comment.
|
|||
cors-allow-origin
-
|
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
|
|||
name
-
/ required
|
User name.
|
|||
peer-auth
-
|
|
Enable/disable peer authentication.
|
||
peer-group
-
|
Peer group name.
|
|||
schedule
-
|
Schedule name.
|
|||
state
-
|
|
Indicates whether to create or remove the object
|
||
trusthost
-
|
Trusthost.
|
|||
id
-
/ required
|
Table ID.
|
|||
ipv4-trusthost
-
|
IPv4 trusted host address.
|
|||
ipv6-trusthost
-
|
IPv6 trusted host address.
|
|||
type
-
|
|
Trusthost type.
|
||
vdom
-
|
Virtual domains.
|
|||
name
-
/ required
|
Virtual domain name. Source system.vdom.name.
|
|||
username
-
/ required
|
FortiOS or FortiGate username.
|
|||
vdom
-
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure API users.
fortios_system_api_user:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
system_api_user:
state: "present"
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)"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.