fortinet.fortimanager.fmgr_firewall_internetservice module – Show Internet Service application.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_internetservice
.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
(list) City sequence number list. |
|
(list) IPv6 City sequence number list. |
|
(list) Country sequence number list. |
|
(list) IPv6 Country sequence number list. |
|
Database. Choices:
|
|
Direction. Choices:
|
|
Entry. |
|
Entry ID. |
|
Deprecated, please rename it to ip_number. Total number of IP addresses. |
|
Deprecated, please rename it to ip_range_number. Total number of IP ranges. |
|
(list) Integer value for the TCP/IP port |
|
Integer value for the protocol type as defined by IANA |
|
Deprecated, please rename it to extra_ip_range_number. Extra ip range number. |
|
Deprecated, please rename it to extra_ip6_range_number. Extra ip6 range number. |
|
Deprecated, please rename it to icon_id. Icon id. |
|
Id. |
|
Deprecated, please rename it to ip_number. Ip number. |
|
Deprecated, please rename it to ip_range_number. Ip range number. |
|
Deprecated, please rename it to ip6_range_number. Ip6 range number. |
|
Deprecated, please rename it to jitter_threshold. Jitter threshold. |
|
Deprecated, please rename it to latency_threshold. Latency threshold. |
|
Name. |
|
Obsolete. |
|
Offset. |
|
Deprecated, please rename it to packetloss_threshold. Packetloss threshold. |
|
(list) Region sequence number list. |
|
(list) IPv6 Region sequence number list. |
|
Reputation. |
|
Singularity. |
|
Deprecated, please rename it to sld_id. Sld id. |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Show Internet Service application.
fortinet.fortimanager.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: <integer>
ip_number: <integer>
ip_range_number: <integer>
port: <list or integer>
protocol: <integer>
icon_id: <integer>
id: <integer>
name: <string>
offset: <integer>
reputation: <integer>
sld_id: <integer>
extra_ip_range_number: <integer>
ip_number: <integer>
ip_range_number: <integer>
jitter_threshold: <integer>
latency_threshold: <integer>
obsolete: <integer>
packetloss_threshold: <integer>
singularity: <integer>
city: <list or integer>
country: <list or integer>
region: <list or integer>
city6: <list or integer>
country6: <list or integer>
extra_ip6_range_number: <integer>
ip6_range_number: <integer>
region6: <list or integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |