fmgd_router_static – Configure IPv4 static routing tables.
Added in version 1.0.0.
Synopsis
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- router_static - Configure IPv4 static routing tables. type: dict
- bfd Enable/disable bidirectional forwarding detection (bfd). type: str choices: [disable, enable] more...
- blackhole Enable/disable black hole. type: str choices: [disable, enable] more...
- comment Optional comments. type: str more...
- device Gateway out interface or tunnel. type: list more...
- distance Administrative distance (1 - 255). type: int more...
- dst Destination ip and mask for this route. type: list more...
- dstaddr Name of firewall address or address group. type: list more...
- dynamic_gateway (Alias name: dynamic-gateway) Enable use of dynamic gateway retrieved from a dhcp or ppp server. type: str choices: [disable, enable] more...
- gateway Gateway ip for this route. type: str more...
- internet_service (Alias name: internet-service) Application id in the internet service database. type: list more...
- internet_service_custom (Alias name: internet-service-custom) Application name in the internet service custom database. type: list more...
- link_monitor_exempt (Alias name: link-monitor-exempt) Enable/disable withdrawal of this static route when link monitor or health check is down. type: str choices: [disable, enable] more...
- preferred_source (Alias name: preferred-source) Preferred source ip for this route. type: str more...
- priority Administrative priority (1 - 65535). type: int more...
- sdwan_zone (Alias name: sdwan-zone) Choose sd-wan zone. type: list more...
- seq_num (Alias name: seq-num) Sequence number. type: int more...
- src Source prefix for this route. type: list more...
- status Enable/disable this static route. type: str choices: [disable, enable] more...
- tag Route tag. type: int more...
- vrf Virtual routing forwarding id. type: str more...
- weight Administrative weight (0 - 255). type: int more...
- sdwan Enable/disable egress through sd-wan. type: str choices: [disable, enable] more...
- dst_type (Alias name: dst-type) Dst type. type: str choices: [ipmask, addrname, service-id, service-custom] more...
- virtual_wan_link (Alias name: virtual-wan-link) Enable/disable egress through the virtual-wan-link. type: str choices: [disable, enable] more...
- _seq_num (Alias name: _seq-num) Seq num. type: int more...
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Application name in the internet service fortiguard database. type: list more...
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 static routing tables.
fortinet.fmgdevice.fmgd_router_static:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
router_static:
seq_num: 0 # Required variable, integer
# bfd: <value in [disable, enable]>
# blackhole: <value in [disable, enable]>
# comment: <string>
# device: <list or string>
# distance: <integer>
# dst: <list or string>
# dstaddr: <list or string>
# dynamic_gateway: <value in [disable, enable]>
# gateway: <string>
# internet_service: <list or string>
# internet_service_custom: <list or string>
# link_monitor_exempt: <value in [disable, enable]>
# preferred_source: <string>
# priority: <integer>
# sdwan_zone: <list or string>
# src: <list or string>
# status: <value in [disable, enable]>
# tag: <integer>
# vrf: <string>
# weight: <integer>
# sdwan: <value in [disable, enable]>
# dst_type: <value in [ipmask, addrname, service-id, ...]>
# virtual_wan_link: <value in [disable, enable]>
# _seq_num: <integer>
# internet_service_fortiguard: <list or string>
Return Values
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
Status
This module is not guaranteed to have a backwards compatible interface.