fortinet.fortimanager.fmgr_pkg_header_shapingpolicy – no description

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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		Choices/Defaults	Comments
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
pkg string / required			the parameter (pkg) in requested url
pkg_header_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	Choices: disable enable	no description
	diffserv-reverse string	Choices: disable enable	no description
	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	Choices: disable enable	no description
	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-src string	Choices: disable enable	no description
	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
	ip-version string	Choices: 4 6	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	Choices: disable enable	no description
	tos string		no description
	tos-mask string		no description
	tos-negate string	Choices: disable enable	no description
	traffic-shaper string		no description
	traffic-shaper-reverse string		no description
	url-category string		no description
	users string		no description
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		Choices: present absent	the directive to create, update or delete an object
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		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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_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: <value in [present, absent]>
        pkg_header_shapingpolicy:
           app-category: <value of string>
           app-group: <value of string>
           application: <value of integer>
           class-id: <value of integer>
           comment: <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>
           dstaddr: <value of string>
           dstaddr6: <value of string>
           dstintf: <value of string>
           groups: <value of string>
           id: <value of integer>
           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-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>
           ip-version: <value in [4, 6]>
           per-ip-shaper: <value of string>
           schedule: <value of string>
           service: <value of string>
           srcaddr: <value of string>
           srcaddr6: <value of string>
           srcintf: <value of string>
           status: <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>
           url-category: <value of string>
           users: <value of string>

Return Values

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

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_pkg_header_shapingpolicy_module.html