fmgr_firewall_service_custom – Configure custom services.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| firewall_service_custom | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters 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 adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- firewall_service_custom - no description type: dict
- app-category - Application category ID. type: int more...
- app-service-type - Application service type. type: str choices: [disable, app-id, app-category] more...
- application - Application ID. type: int more...
- category - Service category. type: str more...
- check-reset-range - Configure the type of ICMP error message verification. type: str choices: [disable, default, strict] more...
- color - Color of icon on the GUI. type: int more...
- comment - No description for the parameter type: str
- fqdn - Fully qualified domain name. type: str more...
- 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, pfcp] more...
- icmpcode - ICMP code. type: int more...
- icmptype - ICMP type. type: int more...
- iprange - Start and end of the IP range associated with service. type: str more...
- name - Custom service name. type: str more...
- 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] more...
- protocol-number - IP protocol number. type: int more...
- proxy - Enable/disable web proxy service. type: str choices: [disable, enable] more...
- sctp-portrange - Multiple SCTP port ranges. type: str more...
- session-ttl - Session TTL (300 - 604800, 0 = default). type: int more...
- tcp-halfclose-timer - Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). type: int more...
- tcp-halfopen-timer - Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). type: int more...
- tcp-portrange - Multiple TCP port ranges. type: str more...
- tcp-timewait-timer - Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). type: int more...
- udp-idle-timer - UDP half close timeout (0 - 86400 sec, 0 = default). type: int more...
- udp-portrange - Multiple UDP port ranges. type: str more...
- visibility - Enable/disable the visibility of the service on the GUI. type: str choices: [disable, enable] more...
- global-object - Global Object. type: int more...
- fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
- tcp-rst-timer - Set the length of the TCP CLOSE state in seconds (5 - 300 sec, 0 = default). type: int more...
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the custom services
fmgr_fact:
facts:
selector: 'firewall_service_custom'
params:
adom: 'ansible'
custom: 'your_value'
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure custom services.
fmgr_firewall_service_custom:
bypass_validation: False
adom: ansible
state: present
firewall_service_custom:
app-service-type: disable #<value in [disable, app-id, app-category]>
color: 1
comment: 'comment'
helper: auto #<value in [disable, auto, ftp, ...]>
name: 'ansible-test'
protocol: ALL #<value in [ICMP, IP, TCP/UDP/SCTP, ...]>
proxy: enable #<value in [disable, enable]>
visibility: enable #<value in [disable, enable]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict