- source
fmgr_pkg_firewall_hyperscalepolicy64.py
- orphan
2.2.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.4.7 -> v6.4.14
, v7.0.1 -> v7.2.0
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- 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
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_hyperscalepolicy64 - Configure IPv6 to IPv4 policies. type: dict
- action Policy action. type: str choices: [deny, accept]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- cgn_eif (Alias name: cgn-eif) Enable/disable cgn endpoint independent filtering. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- cgn_eim (Alias name: cgn-eim) Enable/disable cgn endpoint independent mapping. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- cgn_log_server_grp (Alias name: cgn-log-server-grp) Np log server group name type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- cgn_resource_quota (Alias name: cgn-resource-quota) Resource quota type: int
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- cgn_session_quota (Alias name: cgn-session-quota) Session quota type: int
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- comments Comment. type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- dstaddr type: list or str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- dstintf Destination interface name. type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- ippool Enable/disable policy64 ip pool. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- name Policy name. type: str
more...
Supported Version Ranges:
v6.4.8 -> v6.4.14
,v7.0.3 -> v7.2.0
- policy_offload (Alias name: policy-offload) Enable/disable hardware session setup for cgnat. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- policyid Policy id (0 - 4294967294). type: int
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- poolname type: list or str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- service type: list or str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- srcaddr type: list or str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- srcintf Source interface name. type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- status Enable/disable policy status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- tcp_timeout_pid (Alias name: tcp-timeout-pid) Tcp timeout profile id type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Reverse traffic shaper. type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- udp_timeout_pid (Alias name: udp-timeout-pid) Udp timeout profile id type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> v7.2.0
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
- 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: Configure IPv6 to IPv4 policies.
fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy64:
# 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>
pkg: <your own value>
state: present # <value in [present, absent]>
pkg_firewall_hyperscalepolicy64:
action: <value in [deny, accept]>
cgn_eif: <value in [disable, enable]>
cgn_eim: <value in [disable, enable]>
cgn_log_server_grp: <string>
cgn_resource_quota: <integer>
cgn_session_quota: <integer>
comments: <string>
dstaddr: <list or string>
dstintf: <string>
ippool: <value in [disable, enable]>
name: <string>
policy_offload: <value in [disable, enable]>
policyid: <integer>
poolname: <list or string>
service: <list or string>
srcaddr: <list or string>
srcintf: <string>
status: <value in [disable, enable]>
tcp_timeout_pid: <string>
traffic_shaper: <string>
traffic_shaper_reverse: <string>
udp_timeout_pid: <string>
uuid: <string>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)