fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_service_custom Configure custom services. | "added in version" 1.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_firewall_service_custom (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure custom services. fortinet.fortimanager.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]>
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the custom services fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_service_custom" params: adom: "ansible" custom: "your_value"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str firewall_service_custom: description: The top level parameters set. required: false suboptions: app-category: description: (list) Deprecated, please rename it to app_category. Application category ID. type: raw app-service-type: choices: - disable - app-id - app-category description: Deprecated, please rename it to app_service_type. Application service type. type: str application: description: (list) Application ID. type: raw category: description: Service category. type: str check-reset-range: choices: - disable - default - strict description: Deprecated, please rename it to check_reset_range. Configure the type of ICMP error message verification. type: str color: description: Color of icon on the GUI. type: int comment: description: (dict or str) No description. type: raw explicit-proxy: choices: - disable - enable description: Deprecated, please rename it to explicit_proxy. Enable/disable explicit web proxy service. type: str fabric-object: choices: - disable - enable description: Deprecated, please rename it to fabric_object. Security Fabric global object setting. type: str fqdn: description: Fully qualified domain name. type: str global-object: description: Deprecated, please rename it to global_object. Global Object. type: int helper: 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 description: Helper name. type: str icmpcode: description: ICMP code. type: int icmptype: description: ICMP type. type: int iprange: description: Start and end of the IP range associated with service. type: str name: description: Custom service name. required: true type: str protocol: choices: - ICMP - IP - TCP/UDP/SCTP - ICMP6 - HTTP - FTP - CONNECT - SOCKS - ALL - SOCKS-TCP - SOCKS-UDP description: Protocol type based on IANA numbers. type: str protocol-number: description: Deprecated, please rename it to protocol_number. IP protocol number. type: int proxy: choices: - disable - enable description: Enable/disable web proxy service. type: str sctp-portrange: description: Deprecated, please rename it to sctp_portrange. Multiple SCTP port ranges. type: str session-ttl: description: (int or str) Deprecated, please rename it to session_ttl. Session TTL type: raw tcp-halfclose-timer: description: Deprecated, please rename it to tcp_halfclose_timer. Wait time to close a TCP session waiting for an unanswered FIN packet type: int tcp-halfopen-timer: description: Deprecated, please rename it to tcp_halfopen_timer. Wait time to close a TCP session waiting for an unanswered open sessio... type: int tcp-portrange: description: Deprecated, please rename it to tcp_portrange. Multiple TCP port ranges. type: str tcp-rst-timer: description: Deprecated, please rename it to tcp_rst_timer. Set the length of the TCP CLOSE state in seconds type: int tcp-timewait-timer: description: Deprecated, please rename it to tcp_timewait_timer. Set the length of the TCP TIME-WAIT state in seconds type: int udp-idle-timer: description: Deprecated, please rename it to udp_idle_timer. UDP half close timeout type: int udp-portrange: description: Deprecated, please rename it to udp_portrange. Multiple UDP port ranges. type: str uuid: description: Universally Unique Identifier type: str visibility: choices: - disable - enable description: Enable/disable the visibility of the service on the GUI. type: str type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
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 FortiManager version. returned: complex type: list