fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy (2.4.0) — module

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

Scanned by Steampunk Spotter

• 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 shaping policies.
      fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_shapingpolicy:
          dstaddr: all
          dstintf: any
          id: 1
          ip-version: 4 # <value in [4, 6]>
          schedule: always
          service: ALL
          srcaddr: all
          status: disable

Scanned by Steampunk Spotter

• 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 shaping policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_shapingpolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            shaping-policy: "your_value"

Inputs

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

adom:
    description: The parameter (adom) 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

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

pkg_firewall_shapingpolicy:
    description: The top level parameters set.
    required: false
    suboptions:
      app-category:
        description: (list or str) Deprecated, please rename it to app_category. IDs of
          one or more application categories that this shaper app...
        type: raw
      app-group:
        description: (list or str) Deprecated, please rename it to app_group. One or more
          application group names.
        type: raw
      application:
        description: (list) IDs of one or more applications that this shaper applies application
          control traffic shaping to.
        type: raw
      class-id:
        description: (int or str) Deprecated, please rename it to class_id. Traffic class
          ID.
        type: raw
      comment:
        description: Comments.
        type: str
      cos:
        description: VLAN CoS bit pattern.
        type: str
      cos-mask:
        description: Deprecated, please rename it to cos_mask. VLAN CoS evaluated bits.
        type: str
      diffserv-forward:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_forward. Enable to change
          packets DiffServ values to the specified diffservcode-f...
        type: str
      diffserv-reverse:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_reverse. Enable to change
          packets reverse
        type: str
      diffservcode-forward:
        description: Deprecated, please rename it to diffservcode_forward. Change packets
          DiffServ to this value.
        type: str
      diffservcode-rev:
        description: Deprecated, please rename it to diffservcode_rev. Change packets
          reverse
        type: str
      dstaddr:
        description: (list or str) IPv4 destination address and address group names.
        type: raw
      dstaddr6:
        description: (list or str) IPv6 destination address and address group names.
        type: raw
      dstintf:
        description: (list or str) One or more outgoing
        type: raw
      groups:
        description: (list or str) Apply this traffic shaping policy to user groups that
          have authenticated with the FortiGate.
        type: raw
      id:
        description: Shaping policy ID.
        required: true
        type: int
      internet-service:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service. Enable/disable
          use of Internet Services for this policy.
        type: str
      internet-service-custom:
        description: (list or str) Deprecated, please rename it to internet_service_custom.
          Custom Internet Service name.
        type: raw
      internet-service-custom-group:
        description: (list or str) Deprecated, please rename it to internet_service_custom_group.
          Custom Internet Service group name.
        type: raw
      internet-service-group:
        description: (list or str) Deprecated, please rename it to internet_service_group.
          Internet Service group name.
        type: raw
      internet-service-id:
        description: (list or str) Deprecated, please rename it to internet_service_id.
          Internet Service ID.
        type: raw
      internet-service-name:
        description: (list or str) Deprecated, please rename it to internet_service_name.
          Internet Service ID.
        type: raw
      internet-service-src:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service_src. Enable/disable
          use of Internet Services in source for this policy.
        type: str
      internet-service-src-custom:
        description: (list or str) Deprecated, please rename it to internet_service_src_custom.
          Custom Internet Service source name.
        type: raw
      internet-service-src-custom-group:
        description: (list or str) Deprecated, please rename it to internet_service_src_custom_group.
          Custom Internet Service source group name.
        type: raw
      internet-service-src-group:
        description: (list or str) Deprecated, please rename it to internet_service_src_group.
          Internet Service source group name.
        type: raw
      internet-service-src-id:
        description: (list or str) Deprecated, please rename it to internet_service_src_id.
          Internet Service source ID.
        type: raw
      internet-service-src-name:
        description: (list or str) Deprecated, please rename it to internet_service_src_name.
          Internet Service source name.
        type: raw
      ip-version:
        choices:
        - '4'
        - '6'
        description: Deprecated, please rename it to ip_version. Apply this traffic shaping
          policy to IPv4 or IPv6 traffic.
        type: str
      name:
        description: Shaping policy name.
        type: str
      per-ip-shaper:
        description: Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper
          to apply with this policy.
        type: str
      schedule:
        description: Schedule name.
        type: str
      service:
        description: (list or str) Service and service group names.
        type: raw
      srcaddr:
        description: (list or str) IPv4 source address and address group names.
        type: raw
      srcaddr6:
        description: (list or str) IPv6 source address and address group names.
        type: raw
      srcintf:
        description: (list or str) One or more incoming
        type: raw
      status:
        choices:
        - disable
        - enable
        description: Enable/disable this traffic shaping policy.
        type: str
      tos:
        description: ToS
        type: str
      tos-mask:
        description: Deprecated, please rename it to tos_mask. Non-zero bit positions
          are used for comparison while zero bit positions are ignored.
        type: str
      tos-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tos_negate. Enable negated TOS match.
        type: str
      traffic-shaper:
        description: Deprecated, please rename it to traffic_shaper. Traffic shaper to
          apply to traffic forwarded by the firewall policy.
        type: str
      traffic-shaper-reverse:
        description: Deprecated, please rename it to traffic_shaper_reverse. Traffic shaper
          to apply to response traffic received by the firewa...
        type: str
      traffic-type:
        choices:
        - forwarding
        - local-in
        - local-out
        description: Deprecated, please rename it to traffic_type. Traffic type.
        type: str
      url-category:
        description: (list or str) Deprecated, please rename it to url_category. IDs of
          one or more FortiGuard Web Filtering categories that th...
        type: raw
      users:
        description: (list or str) Apply this traffic shaping policy to individual users
          that have authenticated with the FortiGate.
        type: raw
      uuid:
        description: Universally Unique Identifier
        type: str
    type: dict

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