fmgr_firewall_service_custom – Configure custom services.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/obj/firewall/service/custom
- /pm/config/global/obj/firewall/service/custom
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way type: bool required: false default: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- parameters for method: [add, set, update] - Configure custom services.
- data - No description for the parameter type: array
- app-category - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- app-service-type - Application service type. type: str choices: [disable, app-id, app-category]
- application - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- category - Service category. type: str
- check-reset-range - Configure the type of ICMP error message verification. type: str choices: [disable, default, strict]
- color - Color of icon on the GUI. type: int
- comment - No description for the parameter type: str
- fqdn - Fully qualified domain name. type: str
- helper - Helper name. type: str choices: [disable, auto, ftp, tftp, ras, h323, tns, mms, sip, pptp, rtsp, dns-udp, dns-tcp, pmap, rsh, dcerpc, mgcp, gtp-c, gtp-u, gtp-b]
- icmpcode - ICMP code. type: int
- icmptype - ICMP type. type: int
- iprange - Start and end of the IP range associated with service. type: str
- name - Custom service name. type: str
- protocol - Protocol type based on IANA numbers. type: str choices: [ICMP, IP, TCP/UDP/SCTP, ICMP6, HTTP, FTP, CONNECT, SOCKS, ALL, SOCKS-TCP, SOCKS-UDP]
- protocol-number - IP protocol number. type: int
- proxy - Enable/disable web proxy service. type: str choices: [disable, enable]
- sctp-portrange - Multiple SCTP port ranges. type: str
- session-ttl - Session TTL (300 - 604800, 0 = default). type: int
- tcp-halfclose-timer - Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). type: int
- tcp-halfopen-timer - Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). type: int
- tcp-portrange - Multiple TCP port ranges. type: str
- tcp-timewait-timer - Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). type: int
- udp-idle-timer - UDP half close timeout (0 - 86400 sec, 0 = default). type: int
- udp-portrange - Multiple UDP port ranges. type: str
- visibility - Enable/disable the visibility of the service on the GUI. type: str choices: [disable, enable]
- app-category - No description for the parameter type: array
- parameters for method: [get] - Configure custom services.
- attr - The name of the attribute to retrieve its datasource. type: str
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [app-category, app-service-type, application, category, check-reset-range, color, fqdn, helper, icmpcode, icmptype, iprange, name, protocol, protocol-number, proxy, sctp-portrange, session-ttl, tcp-halfclose-timer, tcp-halfopen-timer, tcp-portrange, tcp-timewait-timer, udp-idle-timer, udp-portrange, visibility]
- {no-name} - No description for the parameter type: array
- filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- get used - No description for the parameter type: int
- loadsub - Enable or disable the return of any sub-objects. type: int
- option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
- range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/SERVICE/CUSTOM
fmgr_firewall_service_custom:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
app-category:
- <value of integer>
app-service-type: <value in [disable, app-id, app-category]>
application:
- <value of integer>
category: <value of string>
check-reset-range: <value in [disable, default, strict]>
color: <value of integer>
comment: <value of string>
fqdn: <value of string>
helper: <value in [disable, auto, ftp, ...]>
icmpcode: <value of integer>
icmptype: <value of integer>
iprange: <value of string>
name: <value of string>
protocol: <value in [ICMP, IP, TCP/UDP/SCTP, ...]>
protocol-number: <value of integer>
proxy: <value in [disable, enable]>
sctp-portrange: <value of string>
session-ttl: <value of integer>
tcp-halfclose-timer: <value of integer>
tcp-halfopen-timer: <value of integer>
tcp-portrange: <value of string>
tcp-timewait-timer: <value of integer>
udp-idle-timer: <value of integer>
udp-portrange: <value of string>
visibility: <value in [disable, enable]>
- name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/SERVICE/CUSTOM
fmgr_firewall_service_custom:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
attr: <value of string>
fields:
-
- <value in [app-category, app-service-type, application, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- return values for method: [add, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/firewall/service/custom
- return values for method: [get]
- data
- No description for the parameter type: array
- app-category - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- app-service-type - Application service type. type: str
- application - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- category - Service category. type: str
- check-reset-range - Configure the type of ICMP error message verification. type: str
- color - Color of icon on the GUI. type: int
- comment - No description for the parameter type: str
- fqdn - Fully qualified domain name. type: str
- helper - Helper name. type: str
- icmpcode - ICMP code. type: int
- icmptype - ICMP type. type: int
- iprange - Start and end of the IP range associated with service. type: str
- name - Custom service name. type: str
- protocol - Protocol type based on IANA numbers. type: str
- protocol-number - IP protocol number. type: int
- proxy - Enable/disable web proxy service. type: str
- sctp-portrange - Multiple SCTP port ranges. type: str
- session-ttl - Session TTL (300 - 604800, 0 = default). type: int
- tcp-halfclose-timer - Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). type: int
- tcp-halfopen-timer - Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). type: int
- tcp-portrange - Multiple TCP port ranges. type: str
- tcp-timewait-timer - Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). type: int
- udp-idle-timer - UDP half close timeout (0 - 86400 sec, 0 = default). type: int
- udp-portrange - Multiple UDP port ranges. type: str
- visibility - Enable/disable the visibility of the service on the GUI. type: str
- app-category - No description for the parameter type: array
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/firewall/service/custom