Try SpotterCreate SD-WAN rules or priority rules
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
wanprof:
description: The parameter (wanprof) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
wanprof_system_virtualwanlink_service:
description: The top level parameters set.
required: false
suboptions:
addr-mode:
choices:
- ipv4
- ipv6
description: Deprecated, please rename it to addr_mode. Address mode
type: str
bandwidth-weight:
description: Deprecated, please rename it to bandwidth_weight. Coefficient of
reciprocal of available bidirectional bandwidth in the fo...
type: int
default:
choices:
- disable
- enable
description: Enable/disable use of SD-WAN as default service.
type: str
dscp-forward:
choices:
- disable
- enable
description: Deprecated, please rename it to dscp_forward. Enable/disable forward
traffic DSCP tag.
type: str
dscp-forward-tag:
description: Deprecated, please rename it to dscp_forward_tag. Forward traffic
DSCP tag.
type: str
dscp-reverse:
choices:
- disable
- enable
description: Deprecated, please rename it to dscp_reverse. Enable/disable reverse
traffic DSCP tag.
type: str
dscp-reverse-tag:
description: Deprecated, please rename it to dscp_reverse_tag. Reverse traffic
DSCP tag.
type: str
dst:
description: (list or str) Destination address name.
type: raw
dst-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to dst_negate. Enable/disable negation
of destination address match.
type: str
dst6:
description: (list or str) Destination address6 name.
type: raw
end-port:
description: Deprecated, please rename it to end_port. End destination port number.
type: int
gateway:
choices:
- disable
- enable
description: Enable/disable SD-WAN service gateway.
type: str
groups:
description: (list or str) User groups.
type: raw
health-check:
description: Deprecated, please rename it to health_check. Health check.
type: str
hold-down-time:
description: Deprecated, please rename it to hold_down_time. Waiting period in
seconds when switching from the back-up member to the pr...
type: int
id:
description: Priority rule ID
required: true
type: int
input-device:
description: (list or str) Deprecated, please rename it to input_device. Source
interface name.
type: raw
input-device-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to input_device_negate. Enable/disable
negation of input device match.
type: str
internet-service:
choices:
- disable
- enable
description: Deprecated, please rename it to internet_service. Enable/disable
use of Internet service for application-based load balancing.
type: str
internet-service-app-ctrl:
description: (list) Deprecated, please rename it to internet_service_app_ctrl.
type: raw
internet-service-app-ctrl-group:
description: (list or str) Deprecated, please rename it to internet_service_app_ctrl_group.
Application control based Internet Service ...
type: raw
internet-service-ctrl:
description: (list) Deprecated, please rename it to internet_service_ctrl.
type: raw
internet-service-ctrl-group:
description: (list or str) Deprecated, please rename it to internet_service_ctrl_group.
Control-based Internet Service group list.
type: raw
internet-service-custom:
description: (list or str) Deprecated, please rename it to internet_service_custom.
Custom Internet service name list.
type: raw
internet-service-custom-group:
description: (list or str) Deprecated, please rename it to internet_service_custom_group.
Custom Internet Service group list.
type: raw
internet-service-group:
description: (list or str) Deprecated, please rename it to internet_service_group.
Internet Service group list.
type: raw
internet-service-id:
description: (list or str) Deprecated, please rename it to internet_service_id.
Internet service ID list.
type: raw
internet-service-name:
description: Deprecated, please rename it to internet_service_name. Internet service
name list.
type: str
jitter-weight:
description: Deprecated, please rename it to jitter_weight. Coefficient of jitter
in the formula of custom-profile-1.
type: int
latency-weight:
description: Deprecated, please rename it to latency_weight. Coefficient of latency
in the formula of custom-profile-1.
type: int
link-cost-factor:
choices:
- latency
- jitter
- packet-loss
- inbandwidth
- outbandwidth
- bibandwidth
- custom-profile-1
description: Deprecated, please rename it to link_cost_factor. Link cost factor.
type: str
link-cost-threshold:
description: Deprecated, please rename it to link_cost_threshold. Percentage threshold
change of link cost values that will result in p...
type: int
member:
description: Member sequence number.
type: str
mode:
choices:
- auto
- manual
- priority
- sla
- load-balance
description: Control how the priority rule sets the priority of interfaces in
the SD-WAN.
type: str
name:
description: Priority rule name.
type: str
packet-loss-weight:
description: Deprecated, please rename it to packet_loss_weight. Coefficient of
packet-loss in the formula of custom-profile-1.
type: int
priority-members:
description: (list or str) Deprecated, please rename it to priority_members. Member
sequence number list.
type: raw
protocol:
description: Protocol number.
type: int
quality-link:
description: Deprecated, please rename it to quality_link. Quality grade.
type: int
role:
choices:
- primary
- secondary
- standalone
description: Service role to work with neighbor.
type: str
route-tag:
description: Deprecated, please rename it to route_tag. IPv4 route map route-tag.
type: int
sla:
description: No description.
elements: dict
suboptions:
health-check:
description: Deprecated, please rename it to health_check. Virtual WAN Link
health-check.
type: str
id:
description: SLA ID.
type: int
type: list
sla-compare-method:
choices:
- order
- number
description: Deprecated, please rename it to sla_compare_method. Method to compare
SLA value for sla and load balance mode.
type: str
src:
description: (list or str) Source address name.
type: raw
src-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to src_negate. Enable/disable negation
of source address match.
type: str
src6:
description: (list or str) Source address6 name.
type: raw
standalone-action:
choices:
- disable
- enable
description: Deprecated, please rename it to standalone_action. Enable/disable
service when selected neighbor role is standalone while ...
type: str
start-port:
description: Deprecated, please rename it to start_port. Start destination port
number.
type: int
status:
choices:
- disable
- enable
description: Enable/disable SD-WAN service.
type: str
tos:
description: Type of service bit pattern.
type: str
tos-mask:
description: Deprecated, please rename it to tos_mask. Type of service evaluated
bits.
type: str
users:
description: (list or str) User name.
type: raw
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list