fortinet.fortimanager.fmgr_pkg_header_shapingpolicy module – Configure shaping policies.

Note

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

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_header_shapingpolicy.

New in fortinet.fortimanager 2.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

access_token

string

The token to access FortiManager without using username and password.

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

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_header_shapingpolicy

dictionary

The top level parameters set.

app_category

any

(list or str) App category.

app_group

any

(list or str) App group.

application

any

(list) Application.

class_id

any

(int or str) Class id.

class_id_reverse

integer

Class id reverse.

comment

string

Comment.

cos

string

VLAN CoS bit pattern.

cos_mask

string

VLAN CoS evaluated bits.

diffserv_forward

string

Diffserv forward.

Choices:

  • "disable"

  • "enable"

diffserv_reverse

string

Diffserv reverse.

Choices:

  • "disable"

  • "enable"

diffservcode_forward

string

Diffservcode forward.

diffservcode_rev

string

Diffservcode rev.

dstaddr

any

(list or str) Dstaddr.

dstaddr6

any

(list or str) Dstaddr6.

dstintf

any

(list or str) Dstintf.

groups

any

(list or str) Groups.

id

integer / required

Id.

internet_service

string

Internet service.

Choices:

  • "disable"

  • "enable"

internet_service_custom

any

(list or str) Internet service custom.

internet_service_custom_group

any

(list or str) Internet service custom group.

internet_service_group

any

(list or str) Internet service group.

internet_service_id

any

(list or str) Internet service id.

internet_service_name

any

(list or str) Internet service name.

internet_service_src

string

Internet service src.

Choices:

  • "disable"

  • "enable"

internet_service_src_custom

any

(list or str) Internet service src custom.

internet_service_src_custom_group

any

(list or str) Internet service src custom group.

internet_service_src_group

any

(list or str) Internet service src group.

internet_service_src_id

any

(list or str) Internet service src id.

internet_service_src_name

any

(list or str) Internet service src name.

ip_version

string

Ip version.

Choices:

  • "4"

  • "6"

per_ip_shaper

string

Per ip shaper.

schedule

string

Schedule.

service

any

(list or str) Service.

service_type

string

Service type.

Choices:

  • "service"

  • "internet-service"

srcaddr

any

(list or str) Srcaddr.

srcaddr6

any

(list or str) Srcaddr6.

srcintf

any

(list or str) Srcintf.

status

string

Status.

Choices:

  • "disable"

  • "enable"

tos

string

Tos.

tos_mask

string

Tos mask.

tos_negate

string

Tos negate.

Choices:

  • "disable"

  • "enable"

traffic_shaper

string

Traffic shaper.

traffic_shaper_reverse

string

Traffic shaper reverse.

traffic_type

string

Traffic type.

Choices:

  • "forwarding"

  • "local-in"

  • "local-out"

url_category

any

(list or str) Url category.

users

any

(list or str) Users.

uuid

string

Uuid.

uuid_idx

integer

Uuid idx.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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: Example playbook (generated based on argument schema)
  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_header_shapingpolicy:
        # 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: present # <value in [present, absent]>
        pkg_header_shapingpolicy:
          app_category: <list or string>
          app_group: <list or string>
          application: <list or integer>
          class_id: <integer or string>
          comment: <string>
          diffserv_forward: <value in [disable, enable]>
          diffserv_reverse: <value in [disable, enable]>
          diffservcode_forward: <string>
          diffservcode_rev: <string>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          dstintf: <list or string>
          groups: <list or string>
          id: <integer>
          internet_service: <value in [disable, enable]>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_id: <list or string>
          internet_service_src: <value in [disable, enable]>
          internet_service_src_custom: <list or string>
          internet_service_src_custom_group: <list or string>
          internet_service_src_group: <list or string>
          internet_service_src_id: <list or string>
          ip_version: <value in [4, 6]>
          per_ip_shaper: <string>
          schedule: <string>
          service: <list or string>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          srcintf: <list or string>
          status: <value in [disable, enable]>
          tos: <string>
          tos_mask: <string>
          tos_negate: <value in [disable, enable]>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          url_category: <list or string>
          users: <list or string>
          uuid: <string>
          internet_service_name: <list or string>
          internet_service_src_name: <list or string>
          class_id_reverse: <integer>
          service_type: <value in [service, internet-service]>
          uuid_idx: <integer>
          cos: <string>
          cos_mask: <string>
          traffic_type: <value in [forwarding, local-in, local-out]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)