- source
fmgr_wanprof_system_virtualwanlink_service.py
- orphan
fmgr_wanprof_system_virtualwanlink_service -- Create SD-WAN rules or priority rules (also called services) to control how sessions are distributed to physical interfaces in the SD-WAN.
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
- adom - The parameter in requested url type: str required: true
- wanprof - The parameter in requested url type: str required: true
- wanprof_system_virtualwanlink_service - Create SD-WAN rules or priority rules type: dict
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges:
v6.0.0 -> latest
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- default Enable/disable use of sd-wan as default service. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_forward (Alias name: dscp-forward) Enable/disable forward traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_forward_tag (Alias name: dscp-forward-tag) Forward traffic dscp tag. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_reverse (Alias name: dscp-reverse) Enable/disable reverse traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_reverse_tag (Alias name: dscp-reverse-tag) Reverse traffic dscp tag. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dst Destination address name. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dst_negate (Alias name: dst-negate) Enable/disable negation of destination address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dst6 Destination address6 name. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- end_port (Alias name: end-port) End destination port number. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- groups User groups. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- health_check (Alias name: health-check) Health check. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- hold_down_time (Alias name: hold-down-time) Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- id Priority rule id (1 - 4000). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service (Alias name: internet-service) Enable/disable use of internet service for application-based load balancing. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_ctrl (Alias name: internet-service-ctrl) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- internet_service_ctrl_group (Alias name: internet-service-ctrl-group) Control-based internet service group list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_group (Alias name: internet-service-group) Internet service group list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_id (Alias name: internet-service-id) Internet service id list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- link_cost_factor (Alias name: link-cost-factor) Link cost factor. type: str choices: [latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1]
more...
Supported Version Ranges:
v6.0.0 -> latest
- link_cost_threshold (Alias name: link-cost-threshold) Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default = 10). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- member Member sequence number. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- mode Control how the priority rule sets the priority of interfaces in the sd-wan. type: str choices: [auto, manual, priority, sla, load-balance]
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Priority rule name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- priority_members (Alias name: priority-members) Member sequence number list. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- protocol Protocol number. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- quality_link (Alias name: quality-link) Quality grade. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- sla type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- src Source address name. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- src_negate (Alias name: src-negate) Enable/disable negation of source address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- src6 Source address6 name. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- start_port (Alias name: start-port) Start destination port number. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- status Enable/disable sd-wan service. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos Type of service bit pattern. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- users User name. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- internet_service_app_ctrl (Alias name: internet-service-app-ctrl) type: list
more...
Supported Version Ranges:
v6.2.0 -> latest
- internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list or str
more...
Supported Version Ranges:
v6.2.0 -> latest
- role Service role to work with neighbor. type: str choices: [primary, secondary, standalone]
more...
Supported Version Ranges:
v6.2.1 -> latest
- sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla and load balance mode. type: str choices: [order, number]
more...
Supported Version Ranges:
v6.2.1 -> latest
- standalone_action (Alias name: standalone-action) Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> latest
- input_device (Alias name: input-device) Source interface name. type: list or str
more...
Supported Version Ranges:
v6.2.2 -> latest
- internet_service_name (Alias name: internet-service-name) Internet service name list. type: str
more...
Supported Version Ranges:
v6.4.0 -> v6.4.0
- input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> 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: Create SD-WAN rules or priority rules
fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service:
# 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, ...]
adom: <your own value>
wanprof: <your own value>
state: present # <value in [present, absent]>
wanprof_system_virtualwanlink_service:
addr_mode: <value in [ipv4, ipv6]>
bandwidth_weight: <integer>
default: <value in [disable, enable]>
dscp_forward: <value in [disable, enable]>
dscp_forward_tag: <string>
dscp_reverse: <value in [disable, enable]>
dscp_reverse_tag: <string>
dst: <list or string>
dst_negate: <value in [disable, enable]>
dst6: <list or string>
end_port: <integer>
gateway: <value in [disable, enable]>
groups: <list or string>
health_check: <string>
hold_down_time: <integer>
id: <integer>
internet_service: <value in [disable, enable]>
internet_service_ctrl: <list or integer>
internet_service_ctrl_group: <list or string>
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>
jitter_weight: <integer>
latency_weight: <integer>
link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
link_cost_threshold: <integer>
member: <string>
mode: <value in [auto, manual, priority, ...]>
name: <string>
packet_loss_weight: <integer>
priority_members: <list or string>
protocol: <integer>
quality_link: <integer>
route_tag: <integer>
sla:
-
health_check: <string>
id: <integer>
src: <list or string>
src_negate: <value in [disable, enable]>
src6: <list or string>
start_port: <integer>
status: <value in [disable, enable]>
tos: <string>
tos_mask: <string>
users: <list or string>
internet_service_app_ctrl: <list or integer>
internet_service_app_ctrl_group: <list or string>
role: <value in [primary, secondary, standalone]>
sla_compare_method: <value in [order, number]>
standalone_action: <value in [disable, enable]>
input_device: <list or string>
internet_service_name: <string>
input_device_negate: <value in [disable, enable]>
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)