fortinet.fortimanager.fmgr_pkg_footer_policy6 – no description
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_footer_policy6.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| bypass_validation  boolean  | 
 | only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| pkg  string / required  | the parameter (pkg) in requested url | |||
| pkg_footer_policy6  dictionary  | the top level parameters set | |||
| action  string  | 
 | no description | ||
| anti-replay  string  | 
 | no description | ||
| app-category  string  | no description | |||
| app-group  string  | no description | |||
| application  integer  | no description | |||
| application-charts  list / elements=string  | 
 | no description | ||
| application-list  string  | no description | |||
| auto-asic-offload  string  | 
 | no description | ||
| av-profile  string  | no description | |||
| casi-profile  string  | no description | |||
| cifs-profile  string  | no description | |||
| comments  string  | no description | |||
| custom-log-fields  string  | no description | |||
| deep-inspection-options  string  | no description | |||
| device-detection-portal  string  | 
 | no description | ||
| devices  string  | no description | |||
| diffserv-forward  string  | 
 | no description | ||
| diffserv-reverse  string  | 
 | no description | ||
| diffservcode-forward  string  | no description | |||
| diffservcode-rev  string  | no description | |||
| dlp-sensor  string  | no description | |||
| dnsfilter-profile  string  | no description | |||
| dscp-match  string  | 
 | no description | ||
| dscp-negate  string  | 
 | no description | ||
| dscp-value  string  | no description | |||
| dsri  string  | 
 | no description | ||
| dstaddr  string  | no description | |||
| dstaddr-negate  string  | 
 | no description | ||
| dstintf  string  | no description | |||
| dynamic-profile  string  | 
 | no description | ||
| dynamic-profile-access  list / elements=string  | 
 | no description | ||
| dynamic-profile-group  string  | no description | |||
| email-collection-portal  string  | 
 | no description | ||
| emailfilter-profile  string  | no description | |||
| firewall-session-dirty  string  | 
 | no description | ||
| fixedport  string  | 
 | no description | ||
| fsae  string  | 
 | no description | ||
| global-label  string  | no description | |||
| groups  string  | no description | |||
| http-policy-redirect  string  | 
 | no description | ||
| icap-profile  string  | no description | |||
| identity-based  string  | 
 | no description | ||
| identity-based-policy6  list / elements=string  | no description | |||
| action  string  | 
 | no description | ||
| application-list  string  | no description | |||
| av-profile  string  | no description | |||
| deep-inspection-options  string  | no description | |||
| devices  string  | no description | |||
| dlp-sensor  string  | no description | |||
| endpoint-compliance  string  | 
 | no description | ||
| groups  string  | no description | |||
| icap-profile  string  | no description | |||
| id  integer  | no description | |||
| ips-sensor  string  | no description | |||
| logtraffic  string  | 
 | no description | ||
| mms-profile  string  | no description | |||
| per-ip-shaper  string  | no description | |||
| profile-group  string  | no description | |||
| profile-protocol-options  string  | no description | |||
| profile-type  string  | 
 | no description | ||
| replacemsg-group  string  | no description | |||
| schedule  string  | no description | |||
| send-deny-packet  string  | 
 | no description | ||
| service  string  | no description | |||
| service-negate  string  | 
 | no description | ||
| spamfilter-profile  string  | no description | |||
| sslvpn-portal  string  | no description | |||
| sslvpn-realm  string  | no description | |||
| traffic-shaper  string  | no description | |||
| traffic-shaper-reverse  string  | no description | |||
| utm-status  string  | 
 | no description | ||
| voip-profile  string  | no description | |||
| webfilter-profile  string  | no description | |||
| identity-from  string  | 
 | no description | ||
| inbound  string  | 
 | no description | ||
| inspection-mode  string  | 
 | no description | ||
| ippool  string  | 
 | no description | ||
| ips-sensor  string  | no description | |||
| label  string  | no description | |||
| logtraffic  string  | 
 | no description | ||
| logtraffic-start  string  | 
 | no description | ||
| mms-profile  string  | no description | |||
| name  string  | no description | |||
| nat  string  | 
 | no description | ||
| natinbound  string  | 
 | no description | ||
| natoutbound  string  | 
 | no description | ||
| np-accelation  string  | 
 | no description | ||
| np-acceleration  string  | 
 | no description | ||
| outbound  string  | 
 | no description | ||
| per-ip-shaper  string  | no description | |||
| policyid  integer  | no description | |||
| poolname  string  | no description | |||
| profile-group  string  | no description | |||
| profile-protocol-options  string  | no description | |||
| profile-type  string  | 
 | no description | ||
| replacemsg-group  string  | no description | |||
| replacemsg-override-group  string  | no description | |||
| rsso  string  | 
 | no description | ||
| schedule  string  | no description | |||
| send-deny-packet  string  | 
 | no description | ||
| service  string  | no description | |||
| service-negate  string  | 
 | no description | ||
| session-ttl  integer  | no description | |||
| spamfilter-profile  string  | no description | |||
| srcaddr  string  | no description | |||
| srcaddr-negate  string  | 
 | no description | ||
| srcintf  string  | no description | |||
| ssh-filter-profile  string  | no description | |||
| ssh-policy-redirect  string  | 
 | no description | ||
| ssl-mirror  string  | 
 | no description | ||
| ssl-mirror-intf  string  | no description | |||
| ssl-ssh-profile  string  | no description | |||
| sslvpn-auth  string  | 
 | no description | ||
| sslvpn-ccert  string  | 
 | no description | ||
| sslvpn-cipher  string  | 
 | no description | ||
| status  string  | 
 | no description | ||
| tags  string  | no description | |||
| tcp-mss-receiver  integer  | no description | |||
| tcp-mss-sender  integer  | no description | |||
| tcp-session-without-syn  string  | 
 | no description | ||
| timeout-send-rst  string  | 
 | no description | ||
| tos  string  | no description | |||
| tos-mask  string  | no description | |||
| tos-negate  string  | 
 | no description | ||
| traffic-shaper  string  | no description | |||
| traffic-shaper-reverse  string  | no description | |||
| url-category  string  | no description | |||
| users  string  | no description | |||
| utm-inspection-mode  string  | 
 | no description | ||
| utm-status  string  | 
 | no description | ||
| uuid  string  | no description | |||
| vlan-cos-fwd  integer  | no description | |||
| vlan-cos-rev  integer  | no description | |||
| vlan-filter  string  | no description | |||
| voip-profile  string  | no description | |||
| vpntunnel  string  | no description | |||
| webfilter-profile  string  | no description | |||
| rc_failed  list / elements=string  | the rc codes list with which the conditions to fail will be overriden | |||
| rc_succeeded  list / elements=string  | the rc codes list with which the conditions to succeed will be overriden | |||
| state  string / required  | 
 | the directive to create, update or delete an object | ||
| workspace_locking_adom  string  | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
| workspace_locking_timeout  integer  | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | ||
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: no description
     fmgr_pkg_footer_policy6:
        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, ...]
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_footer_policy6:
           action: <value in [deny, accept, ipsec, ...]>
           anti-replay: <value in [disable, enable]>
           app-category: <value of string>
           app-group: <value of string>
           application: <value of integer>
           application-charts:
             - top10-app
             - top10-p2p-user
             - top10-media-user
           application-list: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           casi-profile: <value of string>
           cifs-profile: <value of string>
           comments: <value of string>
           custom-log-fields: <value of string>
           deep-inspection-options: <value of string>
           device-detection-portal: <value in [disable, enable]>
           devices: <value of string>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           dlp-sensor: <value of string>
           dnsfilter-profile: <value of string>
           dscp-match: <value in [disable, enable]>
           dscp-negate: <value in [disable, enable]>
           dscp-value: <value of string>
           dsri: <value in [disable, enable]>
           dstaddr: <value of string>
           dstaddr-negate: <value in [disable, enable]>
           dstintf: <value of string>
           dynamic-profile: <value in [disable, enable]>
           dynamic-profile-access:
             - imap
             - smtp
             - pop3
             - http
             - ftp
             - im
             - nntp
             - imaps
             - smtps
             - pop3s
             - https
             - ftps
           dynamic-profile-group: <value of string>
           email-collection-portal: <value in [disable, enable]>
           emailfilter-profile: <value of string>
           firewall-session-dirty: <value in [check-all, check-new]>
           fixedport: <value in [disable, enable]>
           fsae: <value in [disable, enable]>
           global-label: <value of string>
           groups: <value of string>
           http-policy-redirect: <value in [disable, enable]>
           icap-profile: <value of string>
           identity-based: <value in [disable, enable]>
           identity-based-policy6:
             -
                 action: <value in [deny, accept]>
                 application-list: <value of string>
                 av-profile: <value of string>
                 deep-inspection-options: <value of string>
                 devices: <value of string>
                 dlp-sensor: <value of string>
                 endpoint-compliance: <value in [disable, enable]>
                 groups: <value of string>
                 icap-profile: <value of string>
                 id: <value of integer>
                 ips-sensor: <value of string>
                 logtraffic: <value in [disable, enable, all, ...]>
                 mms-profile: <value of string>
                 per-ip-shaper: <value of string>
                 profile-group: <value of string>
                 profile-protocol-options: <value of string>
                 profile-type: <value in [single, group]>
                 replacemsg-group: <value of string>
                 schedule: <value of string>
                 send-deny-packet: <value in [disable, enable]>
                 service: <value of string>
                 service-negate: <value in [disable, enable]>
                 spamfilter-profile: <value of string>
                 sslvpn-portal: <value of string>
                 sslvpn-realm: <value of string>
                 traffic-shaper: <value of string>
                 traffic-shaper-reverse: <value of string>
                 utm-status: <value in [disable, enable]>
                 voip-profile: <value of string>
                 webfilter-profile: <value of string>
           identity-from: <value in [auth, device]>
           inbound: <value in [disable, enable]>
           inspection-mode: <value in [proxy, flow]>
           ippool: <value in [disable, enable]>
           ips-sensor: <value of string>
           label: <value of string>
           logtraffic: <value in [disable, enable, all, ...]>
           logtraffic-start: <value in [disable, enable]>
           mms-profile: <value of string>
           name: <value of string>
           nat: <value in [disable, enable]>
           natinbound: <value in [disable, enable]>
           natoutbound: <value in [disable, enable]>
           np-accelation: <value in [disable, enable]>
           np-acceleration: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           policyid: <value of integer>
           poolname: <value of string>
           profile-group: <value of string>
           profile-protocol-options: <value of string>
           profile-type: <value in [single, group]>
           replacemsg-group: <value of string>
           replacemsg-override-group: <value of string>
           rsso: <value in [disable, enable]>
           schedule: <value of string>
           send-deny-packet: <value in [disable, enable]>
           service: <value of string>
           service-negate: <value in [disable, enable]>
           session-ttl: <value of integer>
           spamfilter-profile: <value of string>
           srcaddr: <value of string>
           srcaddr-negate: <value in [disable, enable]>
           srcintf: <value of string>
           ssh-filter-profile: <value of string>
           ssh-policy-redirect: <value in [disable, enable]>
           ssl-mirror: <value in [disable, enable]>
           ssl-mirror-intf: <value of string>
           ssl-ssh-profile: <value of string>
           sslvpn-auth: <value in [any, local, radius, ...]>
           sslvpn-ccert: <value in [disable, enable]>
           sslvpn-cipher: <value in [any, high, medium]>
           status: <value in [disable, enable]>
           tags: <value of string>
           tcp-mss-receiver: <value of integer>
           tcp-mss-sender: <value of integer>
           tcp-session-without-syn: <value in [all, data-only, disable]>
           timeout-send-rst: <value in [disable, enable]>
           tos: <value of string>
           tos-mask: <value of string>
           tos-negate: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           url-category: <value of string>
           users: <value of string>
           utm-inspection-mode: <value in [proxy, flow]>
           utm-status: <value in [disable, enable]>
           uuid: <value of string>
           vlan-cos-fwd: <value of integer>
           vlan-cos-rev: <value of integer>
           vlan-filter: <value of string>
           voip-profile: <value of string>
           vpntunnel: <value of string>
           webfilter-profile: <value of string>
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| request_url  string  | always | The full url requested Sample: /sys/login/user | 
| response_code  integer  | always | The status of api request | 
| response_message  string  | always | The descriptive message of the api response Sample: OK. | 
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_pkg_footer_policy6_module.html