fmgr_firewall_internetservice – Show Internet Service application.¶
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.
- Tested with FortiManager v6.0.0.
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 |
|
| firewall_internetservice | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: 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
- adom - The parameter in requested url type: str required: true
- firewall_internetservice - Show Internet Service application. type: dict
- database - No description for the parameter type: str choices: [isdb, irdb] more...
- direction - No description for the parameter type: str choices: [src, dst, both] more...
- entry - No description for the parameter type: array
more...
- id - Entry ID. type: int more...
- ip-number - Total number of IP addresses. type: int more...
- ip-range-number - Total number of IP ranges. type: int more...
- port - No description for the parameter type: int more...
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int more...
- icon-id - No description for the parameter type: int more...
- id - No description for the parameter type: int more...
- name - No description for the parameter type: str more...
- offset - No description for the parameter type: int more...
- reputation - No description for the parameter type: int more...
- sld-id - No description for the parameter type: int more...
- extra-ip-range-number - No description for the parameter type: int more...
- ip-number - No description for the parameter type: int more...
- ip-range-number - No description for the parameter type: int more...
- jitter-threshold - No description for the parameter type: int more...
- latency-threshold - No description for the parameter type: int more...
- obsolete - No description for the parameter type: int more...
- packetloss-threshold - No description for the parameter type: int more...
- singularity - No description for the parameter type: int more...
- city - No description for the parameter type: int more...
- country - No description for the parameter type: int more...
- region - No description for the parameter 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¶
- 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: Show Internet Service application.
fmgr_firewall_internetservice:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
firewall_internetservice:
database: <value in [isdb, irdb]>
direction: <value in [src, dst, both]>
entry:
-
id: <value of integer>
ip-number: <value of integer>
ip-range-number: <value of integer>
port: <value of integer>
protocol: <value of integer>
icon-id: <value of integer>
id: <value of integer>
name: <value of string>
offset: <value of integer>
reputation: <value of integer>
sld-id: <value of integer>
extra-ip-range-number: <value of integer>
ip-number: <value of integer>
ip-range-number: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
obsolete: <value of integer>
packetloss-threshold: <value of integer>
singularity: <value of integer>
city: <value of integer>
country: <value of integer>
region: <value of integer>
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