fortinet.fortimanager.fmgr_pkg_header_policy6 (2.4.0) — module

Configure IPv6 policies.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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 header policies.
      fortinet.fortimanager.fmgr_pkg_header_policy6:
        bypass_validation: false
        pkg: ansible
        state: present
        pkg_header_policy6:
          action: accept # <value in [deny, accept, ipsec, ...]>
          comments: ansible-comment
          dstaddr: gall
          dstintf: any
          name: ansible-test2-header
          policyid: 1073741827 # must larger than 2^30(1074741824), since header/footer policy is a special policy
          schedule: galways
          service: gALL
          srcaddr: gall
          srcintf: any
          status: enable
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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 header policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_header_policy6"
          params:
            pkg: "ansible"
            policy6: "your_value"

Inputs

    
pkg:
    description: The parameter (pkg) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

pkg_header_policy6:
    description: The top level parameters set.
    required: false
    suboptions:
      _policy_block:
        description: Assigned policy block.
        type: int
      action:
        choices:
        - deny
        - accept
        - ipsec
        - ssl-vpn
        description: No description.
        type: str
      anti-replay:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to anti_replay.
        type: str
      app-category:
        description: (list or str) Deprecated, please rename it to app_category.
        type: raw
      app-group:
        description: (list or str) Deprecated, please rename it to app_group.
        type: raw
      application:
        description: (list) No description.
        type: raw
      application-charts:
        choices:
        - top10-app
        - top10-p2p-user
        - top10-media-user
        description: Deprecated, please rename it to application_charts.
        elements: str
        type: list
      application-list:
        description: (list or str) Deprecated, please rename it to application_list.
        type: raw
      auto-asic-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_asic_offload.
        type: str
      av-profile:
        description: (list or str) Deprecated, please rename it to av_profile.
        type: raw
      casi-profile:
        description: (list or str) Deprecated, please rename it to casi_profile.
        type: raw
      cgn-log-server-grp:
        description: Deprecated, please rename it to cgn_log_server_grp. NP log server
          group name
        type: str
      cifs-profile:
        description: (list or str) Deprecated, please rename it to cifs_profile.
        type: raw
      comments:
        description: No description.
        type: str
      custom-log-fields:
        description: (list or str) Deprecated, please rename it to custom_log_fields.
        type: raw
      decrypted-traffic-mirror:
        description: (list or str) Deprecated, please rename it to decrypted_traffic_mirror.
        type: raw
      deep-inspection-options:
        description: (list or str) Deprecated, please rename it to deep_inspection_options.
        type: raw
      device-detection-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to device_detection_portal.
        type: str
      devices:
        description: (list or str) No description.
        type: raw
      diffserv-forward:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_forward.
        type: str
      diffserv-reverse:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_reverse.
        type: str
      diffservcode-forward:
        description: Deprecated, please rename it to diffservcode_forward.
        type: str
      diffservcode-rev:
        description: Deprecated, please rename it to diffservcode_rev.
        type: str
      dlp-sensor:
        description: (list or str) Deprecated, please rename it to dlp_sensor.
        type: raw
      dnsfilter-profile:
        description: (list or str) Deprecated, please rename it to dnsfilter_profile.
        type: raw
      dscp-match:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_match.
        type: str
      dscp-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_negate.
        type: str
      dscp-value:
        description: Deprecated, please rename it to dscp_value.
        type: str
      dsri:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      dstaddr:
        description: (list or str) No description.
        type: raw
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dstaddr_negate.
        type: str
      dstintf:
        description: (list or str) No description.
        type: raw
      dynamic-profile:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dynamic_profile.
        type: str
      dynamic-profile-access:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - im
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        description: Deprecated, please rename it to dynamic_profile_access.
        elements: str
        type: list
      dynamic-profile-group:
        description: (list or str) Deprecated, please rename it to dynamic_profile_group.
        type: raw
      email-collection-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to email_collection_portal.
        type: str
      emailfilter-profile:
        description: (list or str) Deprecated, please rename it to emailfilter_profile.
        type: raw
      file-filter-profile:
        description: (list or str) Deprecated, please rename it to file_filter_profile.
        type: raw
      firewall-session-dirty:
        choices:
        - check-all
        - check-new
        description: Deprecated, please rename it to firewall_session_dirty.
        type: str
      fixedport:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      fsae:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      fsso-groups:
        description: (list or str) Deprecated, please rename it to fsso_groups.
        type: raw
      global-label:
        description: Deprecated, please rename it to global_label.
        type: str
      groups:
        description: (list or str) No description.
        type: raw
      http-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to http_policy_redirect.
        type: str
      icap-profile:
        description: (list or str) Deprecated, please rename it to icap_profile.
        type: raw
      identity-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to identity_based.
        type: str
      identity-based-policy6:
        description: Deprecated, please rename it to identity_based_policy6.
        elements: dict
        suboptions:
          action:
            choices:
            - deny
            - accept
            description: No description.
            type: str
          application-list:
            description: Deprecated, please rename it to application_list.
            type: str
          av-profile:
            description: Deprecated, please rename it to av_profile.
            type: str
          deep-inspection-options:
            description: Deprecated, please rename it to deep_inspection_options.
            type: str
          devices:
            description: No description.
            type: str
          dlp-sensor:
            description: Deprecated, please rename it to dlp_sensor.
            type: str
          endpoint-compliance:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to endpoint_compliance.
            type: str
          groups:
            description: No description.
            type: str
          icap-profile:
            description: Deprecated, please rename it to icap_profile.
            type: str
          id:
            description: No description.
            type: int
          ips-sensor:
            description: Deprecated, please rename it to ips_sensor.
            type: str
          logtraffic:
            choices:
            - disable
            - enable
            - all
            - utm
            description: No description.
            type: str
          mms-profile:
            description: Deprecated, please rename it to mms_profile.
            type: str
          per-ip-shaper:
            description: Deprecated, please rename it to per_ip_shaper.
            type: str
          profile-group:
            description: Deprecated, please rename it to profile_group.
            type: str
          profile-protocol-options:
            description: Deprecated, please rename it to profile_protocol_options.
            type: str
          profile-type:
            choices:
            - single
            - group
            description: Deprecated, please rename it to profile_type.
            type: str
          replacemsg-group:
            description: Deprecated, please rename it to replacemsg_group.
            type: str
          schedule:
            description: No description.
            type: str
          send-deny-packet:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to send_deny_packet.
            type: str
          service:
            description: No description.
            type: str
          service-negate:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to service_negate.
            type: str
          spamfilter-profile:
            description: Deprecated, please rename it to spamfilter_profile.
            type: str
          sslvpn-portal:
            description: Deprecated, please rename it to sslvpn_portal.
            type: str
          sslvpn-realm:
            description: Deprecated, please rename it to sslvpn_realm.
            type: str
          traffic-shaper:
            description: Deprecated, please rename it to traffic_shaper.
            type: str
          traffic-shaper-reverse:
            description: Deprecated, please rename it to traffic_shaper_reverse.
            type: str
          utm-status:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to utm_status.
            type: str
          voip-profile:
            description: Deprecated, please rename it to voip_profile.
            type: str
          webfilter-profile:
            description: Deprecated, please rename it to webfilter_profile.
            type: str
        type: list
      identity-from:
        choices:
        - auth
        - device
        description: Deprecated, please rename it to identity_from.
        type: str
      inbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      inspection-mode:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to inspection_mode.
        type: str
      ippool:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      ips-sensor:
        description: (list or str) Deprecated, please rename it to ips_sensor.
        type: raw
      label:
        description: No description.
        type: str
      logtraffic:
        choices:
        - disable
        - enable
        - all
        - utm
        description: No description.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to logtraffic_start.
        type: str
      mms-profile:
        description: (list or str) Deprecated, please rename it to mms_profile.
        type: raw
      name:
        description: No description.
        type: str
      nat:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      natinbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      natoutbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      np-accelation:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_accelation.
        type: str
      np-acceleration:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_acceleration.
        type: str
      outbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      per-ip-shaper:
        description: (list or str) Deprecated, please rename it to per_ip_shaper.
        type: raw
      policy-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to policy_offload. Enable/disable offloading
          policy configuration to CP processors.
        type: str
      policyid:
        description: No description.
        required: true
        type: int
      poolname:
        description: (list or str) No description.
        type: raw
      profile-group:
        description: (list or str) Deprecated, please rename it to profile_group.
        type: raw
      profile-protocol-options:
        description: (list or str) Deprecated, please rename it to profile_protocol_options.
        type: raw
      profile-type:
        choices:
        - single
        - group
        description: Deprecated, please rename it to profile_type.
        type: str
      replacemsg-group:
        description: (list or str) Deprecated, please rename it to replacemsg_group.
        type: raw
      replacemsg-override-group:
        description: (list or str) Deprecated, please rename it to replacemsg_override_group.
        type: raw
      rsso:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      schedule:
        description: (list or str) No description.
        type: raw
      send-deny-packet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to send_deny_packet.
        type: str
      service:
        description: (list or str) No description.
        type: raw
      service-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to service_negate.
        type: str
      session-ttl:
        description: (int or str) Deprecated, please rename it to session_ttl.
        type: raw
      spamfilter-profile:
        description: (list or str) Deprecated, please rename it to spamfilter_profile.
        type: raw
      srcaddr:
        description: (list or str) No description.
        type: raw
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to srcaddr_negate.
        type: str
      srcintf:
        description: (list or str) No description.
        type: raw
      ssh-filter-profile:
        description: (list or str) Deprecated, please rename it to ssh_filter_profile.
        type: raw
      ssh-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssh_policy_redirect.
        type: str
      ssl-mirror:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssl_mirror.
        type: str
      ssl-mirror-intf:
        description: (list or str) Deprecated, please rename it to ssl_mirror_intf.
        type: raw
      ssl-ssh-profile:
        description: (list or str) Deprecated, please rename it to ssl_ssh_profile.
        type: raw
      sslvpn-auth:
        choices:
        - any
        - local
        - radius
        - ldap
        - tacacs+
        description: Deprecated, please rename it to sslvpn_auth.
        type: str
      sslvpn-ccert:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sslvpn_ccert.
        type: str
      sslvpn-cipher:
        choices:
        - any
        - high
        - medium
        description: Deprecated, please rename it to sslvpn_cipher.
        type: str
      status:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      tags:
        description: (list or str) No description.
        type: raw
      tcp-mss-receiver:
        description: Deprecated, please rename it to tcp_mss_receiver.
        type: int
      tcp-mss-sender:
        description: Deprecated, please rename it to tcp_mss_sender.
        type: int
      tcp-session-without-syn:
        choices:
        - all
        - data-only
        - disable
        description: Deprecated, please rename it to tcp_session_without_syn.
        type: str
      timeout-send-rst:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to timeout_send_rst.
        type: str
      tos:
        description: No description.
        type: str
      tos-mask:
        description: Deprecated, please rename it to tos_mask.
        type: str
      tos-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tos_negate.
        type: str
      traffic-shaper:
        description: (list or str) Deprecated, please rename it to traffic_shaper.
        type: raw
      traffic-shaper-reverse:
        description: (list or str) Deprecated, please rename it to traffic_shaper_reverse.
        type: raw
      url-category:
        description: (list or str) Deprecated, please rename it to url_category.
        type: raw
      users:
        description: (list or str) No description.
        type: raw
      utm-inspection-mode:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to utm_inspection_mode.
        type: str
      utm-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to utm_status.
        type: str
      uuid:
        description: No description.
        type: str
      vlan-cos-fwd:
        description: Deprecated, please rename it to vlan_cos_fwd.
        type: int
      vlan-cos-rev:
        description: Deprecated, please rename it to vlan_cos_rev.
        type: int
      vlan-filter:
        description: Deprecated, please rename it to vlan_filter.
        type: str
      voip-profile:
        description: (list or str) Deprecated, please rename it to voip_profile.
        type: raw
      vpntunnel:
        description: (list or str) No description.
        type: raw
      waf-profile:
        description: (list or str) Deprecated, please rename it to waf_profile.
        type: raw
      webcache:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      webcache-https:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to webcache_https.
        type: str
      webfilter-profile:
        description: (list or str) Deprecated, please rename it to webfilter_profile.
        type: raw
      webproxy-forward-server:
        description: (list or str) Deprecated, please rename it to webproxy_forward_server.
        type: raw
      webproxy-profile:
        description: (list or str) Deprecated, please rename it to webproxy_profile.
        type: raw
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list