fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_internetservicecustom Configure custom Internet Services. | "added in version" 2.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_internetservicecustom (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 Internet Services via Generic Module. fortinet.fortimanager.fmgr_generic: method: "set" params: - url: "/pm/config/adom/ansible/obj/firewall/internet-service-custom" data: - name: "ansible-test" comment: "ansible-comment" - name: Configure custom Internet Services. when: false fortinet.fortimanager.fmgr_firewall_internetservicecustom: bypass_validation: false adom: ansible state: present firewall_internetservicecustom: comment: "ansible-comment" name: "ansible-test"
- 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 Internet Services fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_internetservicecustom" params: adom: "ansible" internet-service-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 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 firewall_internetservicecustom: description: The top level parameters set. required: false suboptions: comment: description: Comment. type: str disable-entry: description: Deprecated, please rename it to disable_entry. elements: dict suboptions: id: description: Disable entry ID. type: int ip-range: description: Deprecated, please rename it to ip_range. elements: dict suboptions: end-ip: description: Deprecated, please rename it to end_ip. End IP address. type: str id: description: Disable entry range ID. type: int start-ip: description: Deprecated, please rename it to start_ip. Start IP address. type: str type: list port: description: (list) No description. type: raw protocol: description: Integer value for the protocol type as defined by IANA type: int type: list entry: description: Entry. elements: dict suboptions: addr-mode: choices: - ipv4 - ipv6 description: Deprecated, please rename it to addr_mode. Address mode type: str dst: description: (list or str) Destination address or address group name. type: raw dst6: description: (list) No description. type: raw id: description: Entry ID type: int port-range: description: Deprecated, please rename it to port_range. Port-Range. elements: dict suboptions: end-port: description: Deprecated, please rename it to end_port. Integer value for ending TCP/UDP/SCTP destination port in range type: int id: description: Custom entry port range ID. type: int start-port: description: Deprecated, please rename it to start_port. Integer value for starting TCP/UDP/SCTP destination port in range type: int type: list protocol: description: Integer value for the protocol type as defined by IANA type: int type: list id: description: Internet Service ID. type: int master-service-id: description: Deprecated, please rename it to master_service_id. Internet Service ID in the Internet Service database. type: str name: description: Internet Service name. required: true type: str reputation: description: Reputation level of the custom Internet Service. type: int type: dict
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