fortisase_generic - Send generic FortiSASE API request.
Added in version 1.0.0.
Synopsis
This module is for generic fortisase requests. It receives raw json-rpc data, and sends it to fortisase, finally returns the response to users.
Two parameters schemes are supported, either in raw json format “json” or in ansible recognnizable format “params”.
If all two parameters are provided, the “json” is preferred.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.17.0
Parameters
- method The method of the HTTP request.[Required]type: strchoices: ['get', 'post', 'put', 'delete']
- url The URL of the API.[Required]type: str
- json Raw json-rpc data.[Required]type: str
- params Ansible recognnizable parameters.[Required]type: dict
Examples
- name: FortiSASE Generic Request
hosts: fortisase
gather_facts: false
tasks:
- name: FortiSASE Generic POST (Create) Request
fortinet.fortisase.fortisase_generic:
method: post
url: "/resource-api/v2/network/dns-rules"
params:
primaryKey: "3"
primaryDns: "3.3.3.3"
secondaryDns: "3.3.3.2"
domains:
- www.33333.com
popDnsOverride: {}
- name: FortiSASE Generic GET (Read) Request
fortinet.fortisase.fortisase_generic:
method: get
url: "/resource-api/v2/network/dns-rules/3"
- name: FortiSASE Generic PUT (Update) Request
fortinet.fortisase.fortisase_generic:
method: put
url: "/resource-api/v2/network/dns-rules/3"
params:
primaryKey: "3"
primaryDns: "4.4.4.4"
secondaryDns: "4.4.4.2"
domains:
- www.44444.com
popDnsOverride: {}
- name: FortiSASE Generic Delete (Delete) Request
fortinet.fortisase.fortisase_generic:
method: delete
url: "/resource-api/v2/network/dns-rules/3"
# Using json string
- name: FortiSASE Generic Request (Using JSON String)
hosts: fortisase
gather_facts: false
tasks:
- name: FortiSASE Generic POST (Create) Request (JSON String)
fortinet.fortisase.fortisase_generic:
method: post
url: "/resource-api/v2/network/dns-rules"
json: |
{
"primaryKey": "3",
"primaryDns": "3.3.3.3",
"secondaryDns": "3.3.3.2",
"domains": ["www.33333.com"],
"popDnsOverride": {}
}
- name: FortiSASE Generic Delete (Delete) Request (JSON String)
fortinet.fortisase.fortisase_generic:
method: delete
url: "/resource-api/v2/network/dns-rules/3"
json: "{}"
Return Values
- http_code type: intreturned: always
- response type: rawreturned: always