- source
fmgr_pkg_header_shapingpolicy.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- pkg - The parameter in requested url type: str required: true
- pkg_header_shapingpolicy - Configure shaping policies. type: dict
- app_category (Alias name: app-category) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- app_group (Alias name: app-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- application type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- class_id (Alias name: class-id) type: int or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- comment type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffserv_forward (Alias name: diffserv-forward) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffserv_reverse (Alias name: diffserv-reverse) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffservcode_forward (Alias name: diffservcode-forward) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffservcode_rev (Alias name: diffservcode-rev) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstaddr type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstaddr6 type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstintf type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- groups type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service (Alias name: internet-service) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_custom (Alias name: internet-service-custom) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_custom_group (Alias name: internet-service-custom-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_group (Alias name: internet-service-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_id (Alias name: internet-service-id) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_src (Alias name: internet-service-src) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_src_custom (Alias name: internet-service-src-custom) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_src_group (Alias name: internet-service-src-group) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_src_id (Alias name: internet-service-src-id) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip_version (Alias name: ip-version) type: str choices: [4, 6]
more...
Supported Version Ranges:
v6.0.0 -> latest
- per_ip_shaper (Alias name: per-ip-shaper) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- schedule type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- service type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcaddr type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcaddr6 type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcintf type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- status type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos_mask (Alias name: tos-mask) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos_negate (Alias name: tos-negate) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- traffic_shaper (Alias name: traffic-shaper) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- url_category (Alias name: url-category) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- users type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- uuid type: str
more...
Supported Version Ranges:
v6.2.1 -> latest
- internet_service_name (Alias name: internet-service-name) type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- internet_service_src_name (Alias name: internet-service-src-name) type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- class_id_reverse (Alias name: class-id-reverse) type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- service_type (Alias name: service-type) type: str choices: [service, internet-service]
more...
Supported Version Ranges:
v7.0.3 -> latest
- uuid_idx (Alias name: uuid-idx) type: int
more...
Supported Version Ranges:
v7.2.1 -> latest
- cos Vlan cos bit pattern. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- cos_mask (Alias name: cos-mask) Vlan cos evaluated bits. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- traffic_type (Alias name: traffic-type) Traffic type. type: str choices: [forwarding, local-in, local-out]
more...
Supported Version Ranges:
v7.4.0 -> latest
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
- 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]>
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)