- source
fmgr_pkg_footer_policy6.py
- orphan
2.0.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.0.0 -> latest
- 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
- pkg - The parameter in requested url type: str required: true
- pkg_footer_policy6 - Configure IPv6 policies. type: dict
- action type: str choices: [deny, accept, ipsec, ssl-vpn]
more...
Supported Version Ranges:
v6.0.0 -> latest
- anti_replay (Alias name: anti-replay) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- app_category (Alias name: app-category) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- app_group (Alias name: app-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- application type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- application_charts (Alias name: application-charts) type: list choices: [top10-app, top10-p2p-user, top10-media-user]
more...
Supported Version Ranges:
v6.0.0 -> latest
- application_list (Alias name: application-list) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- auto_asic_offload (Alias name: auto-asic-offload) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- av_profile (Alias name: av-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- casi_profile (Alias name: casi-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- cifs_profile (Alias name: cifs-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- comments type: str
- custom_log_fields (Alias name: custom-log-fields) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- deep_inspection_options (Alias name: deep-inspection-options) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- device_detection_portal (Alias name: device-detection-portal) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- devices type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffserv_forward (Alias name: diffserv-forward) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffserv_reverse (Alias name: diffserv-reverse) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffservcode_forward (Alias name: diffservcode-forward) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffservcode_rev (Alias name: diffservcode-rev) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dlp_sensor (Alias name: dlp-sensor) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dnsfilter_profile (Alias name: dnsfilter-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_match (Alias name: dscp-match) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_negate (Alias name: dscp-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_value (Alias name: dscp-value) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dsri type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstaddr type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstaddr_negate (Alias name: dstaddr-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstintf type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dynamic_profile (Alias name: dynamic-profile) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dynamic_profile_access (Alias name: dynamic-profile-access) type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, ftps]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dynamic_profile_group (Alias name: dynamic-profile-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- email_collection_portal (Alias name: email-collection-portal) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- emailfilter_profile (Alias name: emailfilter-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- firewall_session_dirty (Alias name: firewall-session-dirty) type: str choices: [check-all, check-new]
more...
Supported Version Ranges:
v6.0.0 -> latest
- fixedport type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- fsae type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- global_label (Alias name: global-label) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- groups type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- http_policy_redirect (Alias name: http-policy-redirect) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- icap_profile (Alias name: icap-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- identity_based (Alias name: identity-based) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- identity_based_policy6 (Alias name: identity-based-policy6) type: list
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- action type: str choices: [deny, accept]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- application_list (Alias name: application-list) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- av_profile (Alias name: av-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- deep_inspection_options (Alias name: deep-inspection-options) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- devices type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- dlp_sensor (Alias name: dlp-sensor) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- endpoint_compliance (Alias name: endpoint-compliance) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- groups type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- icap_profile (Alias name: icap-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- ips_sensor (Alias name: ips-sensor) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- logtraffic type: str choices: [disable, enable, all, utm]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- mms_profile (Alias name: mms-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- per_ip_shaper (Alias name: per-ip-shaper) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- profile_group (Alias name: profile-group) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- profile_protocol_options (Alias name: profile-protocol-options) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- profile_type (Alias name: profile-type) type: str choices: [single, group]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- replacemsg_group (Alias name: replacemsg-group) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- schedule type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- send_deny_packet (Alias name: send-deny-packet) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- service type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- service_negate (Alias name: service-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- spamfilter_profile (Alias name: spamfilter-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- sslvpn_portal (Alias name: sslvpn-portal) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- sslvpn_realm (Alias name: sslvpn-realm) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- traffic_shaper (Alias name: traffic-shaper) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- utm_status (Alias name: utm-status) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- voip_profile (Alias name: voip-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- webfilter_profile (Alias name: webfilter-profile) type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.0
- action type: str choices: [deny, accept]
more...
- identity_from (Alias name: identity-from) type: str choices: [auth, device]
more...
Supported Version Ranges:
v6.0.0 -> latest
- inbound type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- inspection_mode (Alias name: inspection-mode) type: str choices: [proxy, flow]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ippool type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ips_sensor (Alias name: ips-sensor) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- label type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- logtraffic type: str choices: [disable, enable, all, utm]
more...
Supported Version Ranges:
v6.0.0 -> latest
- logtraffic_start (Alias name: logtraffic-start) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- mms_profile (Alias name: mms-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- name type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nat type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- natinbound type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- natoutbound type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- np_accelation (Alias name: np-accelation) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- np_acceleration (Alias name: np-acceleration) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- outbound type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- per_ip_shaper (Alias name: per-ip-shaper) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- policyid type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- poolname type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- profile_group (Alias name: profile-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- profile_protocol_options (Alias name: profile-protocol-options) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- profile_type (Alias name: profile-type) type: str choices: [single, group]
more...
Supported Version Ranges:
v6.0.0 -> latest
- replacemsg_group (Alias name: replacemsg-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- replacemsg_override_group (Alias name: replacemsg-override-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- rsso type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- schedule type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- send_deny_packet (Alias name: send-deny-packet) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- service type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- service_negate (Alias name: service-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- session_ttl (Alias name: session-ttl) type: int or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- spamfilter_profile (Alias name: spamfilter-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcaddr type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcaddr_negate (Alias name: srcaddr-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcintf type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ssh_filter_profile (Alias name: ssh-filter-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ssh_policy_redirect (Alias name: ssh-policy-redirect) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ssl_mirror (Alias name: ssl-mirror) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ssl_mirror_intf (Alias name: ssl-mirror-intf) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ssl_ssh_profile (Alias name: ssl-ssh-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- sslvpn_auth (Alias name: sslvpn-auth) type: str choices: [any, local, radius, ldap, tacacs+]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sslvpn_ccert (Alias name: sslvpn-ccert) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sslvpn_cipher (Alias name: sslvpn-cipher) type: str choices: [any, high, medium]
more...
Supported Version Ranges:
v6.0.0 -> latest
- status type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tags type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tcp_mss_receiver (Alias name: tcp-mss-receiver) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- tcp_mss_sender (Alias name: tcp-mss-sender) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- tcp_session_without_syn (Alias name: tcp-session-without-syn) type: str choices: [all, data-only, disable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- timeout_send_rst (Alias name: timeout-send-rst) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos_mask (Alias name: tos-mask) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos_negate (Alias name: tos-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- traffic_shaper (Alias name: traffic-shaper) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- url_category (Alias name: url-category) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- users type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- utm_inspection_mode (Alias name: utm-inspection-mode) type: str choices: [proxy, flow]
more...
Supported Version Ranges:
v6.0.0 -> latest
- utm_status (Alias name: utm-status) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- uuid type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- vlan_cos_fwd (Alias name: vlan-cos-fwd) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- vlan_cos_rev (Alias name: vlan-cos-rev) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- vlan_filter (Alias name: vlan-filter) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- voip_profile (Alias name: voip-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- vpntunnel type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- webfilter_profile (Alias name: webfilter-profile) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- waf_profile (Alias name: waf-profile) type: list or str
more...
Supported Version Ranges:
v6.2.1 -> latest
- webcache type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> latest
- webcache_https (Alias name: webcache-https) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> latest
- webproxy_forward_server (Alias name: webproxy-forward-server) type: list or str
more...
Supported Version Ranges:
v6.2.1 -> latest
- webproxy_profile (Alias name: webproxy-profile) type: list or str
more...
Supported Version Ranges:
v6.2.1 -> latest
- fsso_groups (Alias name: fsso-groups) type: list or str
more...
Supported Version Ranges:
v6.2.3 -> latest
- decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- file_filter_profile (Alias name: file-filter-profile) type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest
- cgn_log_server_grp (Alias name: cgn-log-server-grp) Np log server group name type: str
more...
Supported Version Ranges:
v6.2.7 -> v6.2.12
,v6.4.3 -> latest
- policy_offload (Alias name: policy-offload) Enable/disable offloading policy configuration to cp processors. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.7 -> v6.2.12
,v6.4.3 -> latest
- _policy_block Assigned policy block. type: int
more...
Supported Version Ranges:
v7.2.2 -> latest
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 footer policies.
fortinet.fortimanager.fmgr_pkg_footer_policy6:
bypass_validation: false
pkg: ansible
state: present
pkg_footer_policy6:
action: accept # <value in [deny, accept, ipsec, ...]>
comments: ansible-comment
dstaddr: gall
dstintf: any
name: ansible-test-footer
policyid: 1074741836 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
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 IPv6 footer policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_footer_policy6"
params:
pkg: "ansible"
policy6: "your_value"
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)