fortios_router_static6 – Configure IPv6 static routing tables in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and static6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_router_static6 | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- router_static6 - Configure IPv6 static routing tables. type: dict more...
- bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable more...
- blackhole - Enable/disable black hole. type: str choices: enable, disable more...
- comment - Optional comments. type: str more...
- device - Gateway out interface or tunnel. Source system.interface.name. type: str more...
- devindex - Device index (0 - 4294967295). type: int more...
- distance - Administrative distance (1 - 255). type: int more...
- dst - Destination IPv6 prefix. type: str more...
- dynamic_gateway - Enable use of dynamic gateway retrieved from Router Advertisement (RA). type: str choices: enable, disable more...
- gateway - IPv6 address of the gateway. type: str more...
- link_monitor_exempt - Enable/disable withdrawal of this static route when link monitor or health check is down. type: str choices: enable, disable more...
- priority - Administrative priority (0 - 4294967295). type: int more...
- sdwan - Enable/disable egress through the SD-WAN. type: str choices: enable, disable more...
- seq_num - Sequence number. type: int more...
- status - Enable/disable this static route. type: str choices: enable, disable more...
- virtual_wan_link - Enable/disable egress through the virtual-wan-link. type: str choices: enable, disable more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 static routing tables.
fortios_router_static6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_static6:
bfd: "enable"
blackhole: "enable"
comment: "Optional comments."
device: "<your_own_value> (source system.interface.name)"
devindex: "7"
distance: "8"
dst: "<your_own_value>"
dynamic_gateway: "enable"
gateway: "<your_own_value>"
link_monitor_exempt: "enable"
priority: "13"
sdwan: "enable"
seq_num: "15"
status: "enable"
virtual_wan_link: "enable"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3