fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy module – no description

Note

This module is part of the fortinet.fortimanager collection (version 2.1.7).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy.

New in fortinet.fortimanager 1.0.0

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

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean
only set to True when module schema diffs with FortiManager API structure,

module continues to execute without validating parameters

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task

Choices:

  • false ← (default)

  • true

pkg

string / required

the parameter (pkg) in requested url

pkg_firewall_shapingpolicy

dictionary

the top level parameters set

app-category

string

no description

app-group

string

no description

application

integer

no description

class-id

integer

no description

comment

string

no description

diffserv-forward

string

no description

Choices:

  • "disable"

  • "enable"

diffserv-reverse

string

no description

Choices:

  • "disable"

  • "enable"

diffservcode-forward

string

no description

diffservcode-rev

string

no description

dstaddr

string

no description

dstaddr6

string

no description

dstintf

string

no description

groups

string

no description

id

integer

no description

internet-service

string

no description

Choices:

  • "disable"

  • "enable"

internet-service-custom

string

no description

internet-service-custom-group

string

no description

internet-service-group

string

no description

internet-service-id

string

no description

internet-service-name

string

no description

internet-service-src

string

no description

Choices:

  • "disable"

  • "enable"

internet-service-src-custom

string

no description

internet-service-src-custom-group

string

no description

internet-service-src-group

string

no description

internet-service-src-id

string

no description

internet-service-src-name

string

no description

ip-version

string

no description

Choices:

  • "4"

  • "6"

name

string

no description

per-ip-shaper

string

no description

schedule

string

no description

service

string

no description

srcaddr

string

no description

srcaddr6

string

no description

srcintf

string

no description

status

string

no description

Choices:

  • "disable"

  • "enable"

tos

string

no description

tos-mask

string

no description

tos-negate

string

no description

Choices:

  • "disable"

  • "enable"

traffic-shaper

string

no description

traffic-shaper-reverse

string

no description

url-category

string

no description

users

string

no description

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • "update"

  • "set"

  • "add"

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

Choices:

  • "present"

  • "absent"

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the shaping policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_shapingpolicy'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               shaping-policy: 'your_value'
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure shaping policies.
     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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: "OK."

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)