drmofu / drmofu.fortianalyzer / 1.3.0 / module / faz_generic Build and send generic FortiAnalyzer API request. | "added in version" 1.0.0 of drmofu.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@zhengl), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortianalyzer.faz_generic (1.3.0) — module
Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0
collections: - name: drmofu.fortianalyzer version: 1.3.0
This module is for generic fortianalyzer requests. it receives raw json-rpc data, and sends it to fortianalyzer, finally returns the response to users.
This module also rely on fortianalyzer httpapi plugin as the transport.
the payload doesn't include session, the httpapi plugin will automatically fill the session later.
the username and password is not managed by the module, but by the plugin.
- hosts: fortianalyzer01 connection: httpapi vars: adom: "root" ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: "login a user" faz_generic: method: "exec" params: - url: "sys/login/user" data: - user: "APIUser" passwd: "Fortinet1!e" - name: "login another user" faz_generic: json: | { "method":"exec", "params":[ { "url":"sys/login/user", "data":[ { "user":"APIUser", "passwd":"Fortinet1!" } ] } ] }
json: description: - the raw json-formatted payload to send to fortianalyzer required: false type: str method: description: - the method of the json-rpc - it must be in [get, add, set, update, delete, move, clone, exec] required: false type: str params: description: - the parameter collection. elements: dict required: false type: list log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
meta: contains: request_url: description: The full url requested returned: always sample: /sys/login/user type: str response_code: description: The status of api request returned: always sample: 0 type: int response_data: description: The api response returned: always type: list response_message: description: The descriptive message of the api response returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: complex type: list