fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy module – Configure user defined IPv4 local-in policies.
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_pkg_firewall_localinpolicy.
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:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Action performed on traffic matching the policy Choices:
|
|
Comment. |
|
(list or str) Destination address object from available options. |
|
Deprecated, please rename it to dstaddr_negate. When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
Deprecated, please rename it to ha_mgmt_intf_only. Enable/disable dedicating the HA management interface only for local-in… Choices:
|
|
Deprecated, please rename it to internet_service_src. Enable/disable use of Internet Services in source for this local-in … Choices:
|
|
(list) Deprecated, please rename it to internet_service_src_custom. Custom Internet Service source name. |
|
(list) Deprecated, please rename it to internet_service_src_custom_group. Custom Internet Service source group name. |
|
(list) Deprecated, please rename it to internet_service_src_group. Internet Service source group name. |
|
(list) Deprecated, please rename it to internet_service_src_name. Internet Service source name. |
|
Deprecated, please rename it to internet_service_src_negate. When enabled internet-service-src specifies what the service … Choices:
|
|
Incoming interface name from available options. |
|
Enable/disable local-in traffic logging. Choices:
|
|
User defined local in policy ID. |
|
Schedule object from available options. |
|
(list or str) Service object from available options. |
|
Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be. Choices:
|
|
(list or str) Source address object from available options. |
|
Deprecated, please rename it to srcaddr_negate. When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
Enable/disable this local-in policy. Choices:
|
|
Universally Unique Identifier |
|
Deprecated, please rename it to virtual_patch. Enable/disable virtual patching. Choices:
|
|
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 directive to create, update or delete an object. Choices:
|
|
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.
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: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure user defined IPv4 local-in policies.
fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy:
bypass_validation: false
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_localinpolicy:
action: deny # <value in [deny, accept]>
dstaddr: all
intf: any
policyid: 1
schedule: always
service: ALL
srcaddr: all
status: disable
- 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 user defined IPv4 local-in policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_localinpolicy"
params:
adom: "ansible"
pkg: "ansible" # package name
local-in-policy: "your_value"
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 |