fmgr_pkg_header_policy

New in version 2.10.

Synopsis

  • 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.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

  • 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
  • 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
  • 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
  • pkg - The parameter in requested url type: str required: true
  • pkg_header_policy - no description type: dict
    • action - No description for the parameter type: str choices: [deny, accept, ipsec, ssl-vpn]
    • active-auth-method - No description for the parameter type: str choices: [ntlm, basic, digest, form]
    • anti-replay - No description for the parameter type: str choices: [disable, enable]
    • app-category - No description for the parameter type: str
    • app-group - No description for the parameter type: str
    • application - No description for the parameter type: int
    • application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user]
    • application-list - No description for the parameter type: str
    • auth-cert - No description for the parameter type: str
    • auth-method - No description for the parameter type: str choices: [basic, digest, ntlm, fsae, form, fsso, rsso]
    • auth-path - No description for the parameter type: str choices: [disable, enable]
    • auth-portal - No description for the parameter type: str choices: [disable, enable]
    • auth-redirect-addr - No description for the parameter type: str
    • auto-asic-offload - No description for the parameter type: str choices: [disable, enable]
    • av-profile - No description for the parameter type: str
    • bandwidth - No description for the parameter type: str choices: [disable, enable]
    • block-notification - No description for the parameter type: str choices: [disable, enable]
    • captive-portal-exempt - No description for the parameter type: str choices: [disable, enable]
    • capture-packet - No description for the parameter type: str choices: [disable, enable]
    • casi-profile - No description for the parameter type: str
    • central-nat - No description for the parameter type: str choices: [disable, enable]
    • cifs-profile - No description for the parameter type: str
    • client-reputation - No description for the parameter type: str choices: [disable, enable]
    • client-reputation-mode - No description for the parameter type: str choices: [learning, monitoring]
    • comments - No description for the parameter type: str
    • custom-log-fields - No description for the parameter type: str
    • deep-inspection-options - No description for the parameter type: str
    • delay-tcp-npu-session - No description for the parameter type: str choices: [disable, enable]
    • delay-tcp-npu-sessoin - No description for the parameter type: str choices: [disable, enable]
    • device-detection-portal - No description for the parameter type: str choices: [disable, enable]
    • devices - No description for the parameter type: str
    • diffserv-forward - No description for the parameter type: str choices: [disable, enable]
    • diffserv-reverse - No description for the parameter type: str choices: [disable, enable]
    • diffservcode-forward - No description for the parameter type: str
    • diffservcode-rev - No description for the parameter type: str
    • disclaimer - No description for the parameter type: str choices: [disable, enable]
    • dlp-sensor - No description for the parameter type: str
    • dnsfilter-profile - No description for the parameter type: str
    • dponly - No description for the parameter type: str choices: [disable, enable]
    • dscp-match - No description for the parameter type: str choices: [disable, enable]
    • dscp-negate - No description for the parameter type: str choices: [disable, enable]
    • dscp-value - No description for the parameter type: str
    • dsri - No description for the parameter type: str choices: [disable, enable]
    • dstaddr - No description for the parameter type: str
    • dstaddr-negate - No description for the parameter type: str choices: [disable, enable]
    • dstaddr6 - No description for the parameter type: str
    • dstintf - No description for the parameter type: str
    • dynamic-profile - No description for the parameter type: str choices: [disable, enable]
    • dynamic-profile-access - No description for the parameter type: array choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, ftps, ssh]
    • dynamic-profile-fallthrough - No description for the parameter type: str choices: [disable, enable]
    • dynamic-profile-group - No description for the parameter type: str
    • email-collect - No description for the parameter type: str choices: [disable, enable]
    • email-collection-portal - No description for the parameter type: str choices: [disable, enable]
    • emailfilter-profile - No description for the parameter type: str
    • endpoint-check - No description for the parameter type: str choices: [disable, enable]
    • endpoint-compliance - No description for the parameter type: str choices: [disable, enable]
    • endpoint-keepalive-interface - No description for the parameter type: str
    • endpoint-profile - No description for the parameter type: str
    • failed-connection - No description for the parameter type: str choices: [disable, enable]
    • fall-through-unauthenticated - No description for the parameter type: str choices: [disable, enable]
    • firewall-session-dirty - No description for the parameter type: str choices: [check-all, check-new]
    • fixedport - No description for the parameter type: str choices: [disable, enable]
    • forticlient-compliance-devices - No description for the parameter type: array choices: [windows-pc, mac, iphone-ipad, android]
    • forticlient-compliance-enforcement-portal - No description for the parameter type: str choices: [disable, enable]
    • fsae - No description for the parameter type: str choices: [disable, enable]
    • fsae-server-for-ntlm - No description for the parameter type: str
    • fsso - No description for the parameter type: str choices: [disable, enable]
    • fsso-agent-for-ntlm - No description for the parameter type: str
    • geo-location - No description for the parameter type: str choices: [disable, enable]
    • geoip-anycast - No description for the parameter type: str choices: [disable, enable]
    • global-label - No description for the parameter type: str
    • groups - No description for the parameter type: str
    • gtp-profile - No description for the parameter type: str
    • http-policy-redirect - No description for the parameter type: str choices: [disable, enable]
    • icap-profile - No description for the parameter type: str
    • identity-based - No description for the parameter type: str choices: [disable, enable]
    • identity-based-policy - No description for the parameter type: array
      • action - No description for the parameter type: str choices: [deny, accept]
      • application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user]
      • application-list - No description for the parameter type: str
      • av-profile - No description for the parameter type: str
      • capture-packet - No description for the parameter type: str choices: [disable, enable]
      • deep-inspection-options - No description for the parameter type: str
      • devices - No description for the parameter type: str
      • dlp-sensor - No description for the parameter type: str
      • dstaddr - No description for the parameter type: str
      • dstaddr-negate - No description for the parameter type: str choices: [disable, enable]
      • endpoint-compliance - No description for the parameter type: str choices: [disable, enable]
      • groups - No description for the parameter type: str
      • icap-profile - No description for the parameter type: str
      • id - No description for the parameter type: int
      • ips-sensor - No description for the parameter type: str
      • logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm]
      • logtraffic-app - No description for the parameter type: str choices: [disable, enable]
      • logtraffic-start - No description for the parameter type: str choices: [disable, enable]
      • mms-profile - No description for the parameter type: str
      • per-ip-shaper - No description for the parameter type: str
      • profile-group - No description for the parameter type: str
      • profile-protocol-options - No description for the parameter type: str
      • profile-type - No description for the parameter type: str choices: [single, group]
      • replacemsg-group - No description for the parameter type: str
      • schedule - No description for the parameter type: str
      • send-deny-packet - No description for the parameter type: str choices: [disable, enable]
      • service - No description for the parameter type: str
      • service-negate - No description for the parameter type: str choices: [disable, enable]
      • spamfilter-profile - No description for the parameter type: str
      • sslvpn-portal - No description for the parameter type: str
      • sslvpn-realm - No description for the parameter type: str
      • traffic-shaper - No description for the parameter type: str
      • traffic-shaper-reverse - No description for the parameter type: str
      • users - No description for the parameter type: str
      • utm-status - No description for the parameter type: str choices: [disable, enable]
      • voip-profile - No description for the parameter type: str
      • webfilter-profile - No description for the parameter type: str
    • identity-based-route - No description for the parameter type: str
    • identity-from - No description for the parameter type: str choices: [auth, device]
    • inbound - No description for the parameter type: str choices: [disable, enable]
    • inspection-mode - No description for the parameter type: str choices: [proxy, flow]
    • internet-service - No description for the parameter type: str choices: [disable, enable]
    • internet-service-custom - No description for the parameter type: str
    • internet-service-custom-group - No description for the parameter type: str
    • internet-service-group - No description for the parameter type: str
    • internet-service-id - No description for the parameter type: str
    • internet-service-negate - No description for the parameter type: str choices: [disable, enable]
    • internet-service-src - No description for the parameter type: str choices: [disable, enable]
    • internet-service-src-custom - No description for the parameter type: str
    • internet-service-src-custom-group - No description for the parameter type: str
    • internet-service-src-group - No description for the parameter type: str
    • internet-service-src-id - No description for the parameter type: str
    • internet-service-src-negate - No description for the parameter type: str choices: [disable, enable]
    • ip-based - No description for the parameter type: str choices: [disable, enable]
    • ippool - No description for the parameter type: str choices: [disable, enable]
    • ips-sensor - No description for the parameter type: str
    • label - No description for the parameter type: str
    • learning-mode - No description for the parameter type: str choices: [disable, enable]
    • log-unmatched-traffic - No description for the parameter type: str choices: [disable, enable]
    • logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm]
    • logtraffic-app - No description for the parameter type: str choices: [disable, enable]
    • logtraffic-start - No description for the parameter type: str choices: [disable, enable]
    • match-vip - No description for the parameter type: str choices: [disable, enable]
    • mms-profile - No description for the parameter type: str
    • name - No description for the parameter type: str
    • nat - No description for the parameter type: str choices: [disable, enable]
    • natinbound - No description for the parameter type: str choices: [disable, enable]
    • natip - No description for the parameter type: str
    • natoutbound - No description for the parameter type: str choices: [disable, enable]
    • np-acceleration - No description for the parameter type: str choices: [disable, enable]
    • ntlm - No description for the parameter type: str choices: [disable, enable]
    • ntlm-enabled-browsers - No description for the parameter type: str
    • ntlm-guest - No description for the parameter type: str choices: [disable, enable]
    • outbound - No description for the parameter type: str choices: [disable, enable]
    • per-ip-shaper - No description for the parameter type: str
    • permit-any-host - No description for the parameter type: str choices: [disable, enable]
    • permit-stun-host - No description for the parameter type: str choices: [disable, enable]
    • policyid - No description for the parameter type: int
    • poolname - No description for the parameter type: str
    • profile-group - No description for the parameter type: str
    • profile-protocol-options - No description for the parameter type: str
    • profile-type - No description for the parameter type: str choices: [single, group]
    • radius-mac-auth-bypass - No description for the parameter type: str choices: [disable, enable]
    • redirect-url - No description for the parameter type: str
    • replacemsg-group - No description for the parameter type: str
    • replacemsg-override-group - No description for the parameter type: str
    • reputation-direction - No description for the parameter type: str choices: [source, destination]
    • reputation-minimum - No description for the parameter type: int
    • require-tfa - No description for the parameter type: str choices: [disable, enable]
    • rsso - No description for the parameter type: str choices: [disable, enable]
    • rtp-addr - No description for the parameter type: str
    • rtp-nat - No description for the parameter type: str choices: [disable, enable]
    • scan-botnet-connections - No description for the parameter type: str choices: [disable, block, monitor]
    • schedule - No description for the parameter type: str
    • schedule-timeout - No description for the parameter type: str choices: [disable, enable]
    • send-deny-packet - No description for the parameter type: str choices: [disable, enable]
    • service - No description for the parameter type: str
    • service-negate - No description for the parameter type: str choices: [disable, enable]
    • session-ttl - No description for the parameter type: int
    • sessions - No description for the parameter type: str choices: [disable, enable]
    • spamfilter-profile - No description for the parameter type: str
    • srcaddr - No description for the parameter type: str
    • srcaddr-negate - No description for the parameter type: str choices: [disable, enable]
    • srcaddr6 - No description for the parameter type: str
    • srcintf - No description for the parameter type: str
    • ssh-filter-profile - No description for the parameter type: str
    • ssh-policy-redirect - No description for the parameter type: str choices: [disable, enable]
    • ssl-mirror - No description for the parameter type: str choices: [disable, enable]
    • ssl-mirror-intf - No description for the parameter type: str
    • ssl-ssh-profile - No description for the parameter type: str
    • sslvpn-auth - No description for the parameter type: str choices: [any, local, radius, ldap, tacacs+]
    • sslvpn-ccert - No description for the parameter type: str choices: [disable, enable]
    • sslvpn-cipher - No description for the parameter type: str choices: [any, high, medium]
    • sso-auth-method - No description for the parameter type: str choices: [fsso, rsso]
    • status - No description for the parameter type: str choices: [disable, enable]
    • tags - No description for the parameter type: str
    • tcp-mss-receiver - No description for the parameter type: int
    • tcp-mss-sender - No description for the parameter type: int
    • tcp-reset - No description for the parameter type: str choices: [disable, enable]
    • tcp-session-without-syn - No description for the parameter type: str choices: [all, data-only, disable]
    • timeout-send-rst - No description for the parameter type: str choices: [disable, enable]
    • tos - No description for the parameter type: str
    • tos-mask - No description for the parameter type: str
    • tos-negate - No description for the parameter type: str choices: [disable, enable]
    • traffic-shaper - No description for the parameter type: str
    • traffic-shaper-reverse - No description for the parameter type: str
    • transaction-based - No description for the parameter type: str choices: [disable, enable]
    • url-category - No description for the parameter type: str
    • users - No description for the parameter type: str
    • utm-inspection-mode - No description for the parameter type: str choices: [proxy, flow]
    • utm-status - No description for the parameter type: str choices: [disable, enable]
    • uuid - No description for the parameter type: str
    • vlan-cos-fwd - No description for the parameter type: int
    • vlan-cos-rev - No description for the parameter type: int
    • vlan-filter - No description for the parameter type: str
    • voip-profile - No description for the parameter type: str
    • vpntunnel - No description for the parameter type: str
    • waf-profile - No description for the parameter type: str
    • wanopt - No description for the parameter type: str choices: [disable, enable]
    • wanopt-detection - No description for the parameter type: str choices: [active, passive, off]
    • wanopt-passive-opt - No description for the parameter type: str choices: [default, transparent, non-transparent]
    • wanopt-peer - No description for the parameter type: str
    • wanopt-profile - No description for the parameter type: str
    • wccp - No description for the parameter type: str choices: [disable, enable]
    • web-auth-cookie - No description for the parameter type: str choices: [disable, enable]
    • webcache - No description for the parameter type: str choices: [disable, enable]
    • webcache-https - No description for the parameter type: str choices: [disable, ssl-server, any, enable]
    • webfilter-profile - No description for the parameter type: str
    • webproxy-forward-server - No description for the parameter type: str
    • webproxy-profile - No description for the parameter type: str
    • wsso - No description for the parameter type: str choices: [disable, enable]

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_header_policy:
        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_header_policy:
           action: <value in [deny, accept, ipsec, ...]>
           active-auth-method: <value in [ntlm, basic, digest, ...]>
           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>
           auth-cert: <value of string>
           auth-method: <value in [basic, digest, ntlm, ...]>
           auth-path: <value in [disable, enable]>
           auth-portal: <value in [disable, enable]>
           auth-redirect-addr: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           bandwidth: <value in [disable, enable]>
           block-notification: <value in [disable, enable]>
           captive-portal-exempt: <value in [disable, enable]>
           capture-packet: <value in [disable, enable]>
           casi-profile: <value of string>
           central-nat: <value in [disable, enable]>
           cifs-profile: <value of string>
           client-reputation: <value in [disable, enable]>
           client-reputation-mode: <value in [learning, monitoring]>
           comments: <value of string>
           custom-log-fields: <value of string>
           deep-inspection-options: <value of string>
           delay-tcp-npu-session: <value in [disable, enable]>
           delay-tcp-npu-sessoin: <value in [disable, enable]>
           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>
           disclaimer: <value in [disable, enable]>
           dlp-sensor: <value of string>
           dnsfilter-profile: <value of string>
           dponly: <value in [disable, enable]>
           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]>
           dstaddr6: <value of string>
           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
             - ssh
           dynamic-profile-fallthrough: <value in [disable, enable]>
           dynamic-profile-group: <value of string>
           email-collect: <value in [disable, enable]>
           email-collection-portal: <value in [disable, enable]>
           emailfilter-profile: <value of string>
           endpoint-check: <value in [disable, enable]>
           endpoint-compliance: <value in [disable, enable]>
           endpoint-keepalive-interface: <value of string>
           endpoint-profile: <value of string>
           failed-connection: <value in [disable, enable]>
           fall-through-unauthenticated: <value in [disable, enable]>
           firewall-session-dirty: <value in [check-all, check-new]>
           fixedport: <value in [disable, enable]>
           forticlient-compliance-devices:
             - windows-pc
             - mac
             - iphone-ipad
             - android
           forticlient-compliance-enforcement-portal: <value in [disable, enable]>
           fsae: <value in [disable, enable]>
           fsae-server-for-ntlm: <value of string>
           fsso: <value in [disable, enable]>
           fsso-agent-for-ntlm: <value of string>
           geo-location: <value in [disable, enable]>
           geoip-anycast: <value in [disable, enable]>
           global-label: <value of string>
           groups: <value of string>
           gtp-profile: <value of string>
           http-policy-redirect: <value in [disable, enable]>
           icap-profile: <value of string>
           identity-based: <value in [disable, enable]>
           identity-based-policy:
             -
                 action: <value in [deny, accept]>
                 application-charts:
                   - top10-app
                   - top10-p2p-user
                   - top10-media-user
                 application-list: <value of string>
                 av-profile: <value of string>
                 capture-packet: <value in [disable, enable]>
                 deep-inspection-options: <value of string>
                 devices: <value of string>
                 dlp-sensor: <value of string>
                 dstaddr: <value of string>
                 dstaddr-negate: <value in [disable, enable]>
                 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, ...]>
                 logtraffic-app: <value in [disable, enable]>
                 logtraffic-start: <value in [disable, enable]>
                 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>
                 users: <value of string>
                 utm-status: <value in [disable, enable]>
                 voip-profile: <value of string>
                 webfilter-profile: <value of string>
           identity-based-route: <value of string>
           identity-from: <value in [auth, device]>
           inbound: <value in [disable, enable]>
           inspection-mode: <value in [proxy, flow]>
           internet-service: <value in [disable, enable]>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-id: <value of string>
           internet-service-negate: <value in [disable, enable]>
           internet-service-src: <value in [disable, enable]>
           internet-service-src-custom: <value of string>
           internet-service-src-custom-group: <value of string>
           internet-service-src-group: <value of string>
           internet-service-src-id: <value of string>
           internet-service-src-negate: <value in [disable, enable]>
           ip-based: <value in [disable, enable]>
           ippool: <value in [disable, enable]>
           ips-sensor: <value of string>
           label: <value of string>
           learning-mode: <value in [disable, enable]>
           log-unmatched-traffic: <value in [disable, enable]>
           logtraffic: <value in [disable, enable, all, ...]>
           logtraffic-app: <value in [disable, enable]>
           logtraffic-start: <value in [disable, enable]>
           match-vip: <value in [disable, enable]>
           mms-profile: <value of string>
           name: <value of string>
           nat: <value in [disable, enable]>
           natinbound: <value in [disable, enable]>
           natip: <value of string>
           natoutbound: <value in [disable, enable]>
           np-acceleration: <value in [disable, enable]>
           ntlm: <value in [disable, enable]>
           ntlm-enabled-browsers: <value of string>
           ntlm-guest: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           permit-any-host: <value in [disable, enable]>
           permit-stun-host: <value in [disable, enable]>
           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]>
           radius-mac-auth-bypass: <value in [disable, enable]>
           redirect-url: <value of string>
           replacemsg-group: <value of string>
           replacemsg-override-group: <value of string>
           reputation-direction: <value in [source, destination]>
           reputation-minimum: <value of integer>
           require-tfa: <value in [disable, enable]>
           rsso: <value in [disable, enable]>
           rtp-addr: <value of string>
           rtp-nat: <value in [disable, enable]>
           scan-botnet-connections: <value in [disable, block, monitor]>
           schedule: <value of string>
           schedule-timeout: <value in [disable, enable]>
           send-deny-packet: <value in [disable, enable]>
           service: <value of string>
           service-negate: <value in [disable, enable]>
           session-ttl: <value of integer>
           sessions: <value in [disable, enable]>
           spamfilter-profile: <value of string>
           srcaddr: <value of string>
           srcaddr-negate: <value in [disable, enable]>
           srcaddr6: <value of string>
           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]>
           sso-auth-method: <value in [fsso, rsso]>
           status: <value in [disable, enable]>
           tags: <value of string>
           tcp-mss-receiver: <value of integer>
           tcp-mss-sender: <value of integer>
           tcp-reset: <value in [disable, enable]>
           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>
           transaction-based: <value in [disable, enable]>
           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>
           waf-profile: <value of string>
           wanopt: <value in [disable, enable]>
           wanopt-detection: <value in [active, passive, off]>
           wanopt-passive-opt: <value in [default, transparent, non-transparent]>
           wanopt-peer: <value of string>
           wanopt-profile: <value of string>
           wccp: <value in [disable, enable]>
           web-auth-cookie: <value in [disable, enable]>
           webcache: <value in [disable, enable]>
           webcache-https: <value in [disable, ssl-server, any, ...]>
           webfilter-profile: <value of string>
           webproxy-forward-server: <value of string>
           webproxy-profile: <value of string>
           wsso: <value in [disable, enable]>

Return Values

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.