ansible.builtin.fortios_router_static6 (v2.9.27) — module

Configure IPv6 static routing tables in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure IPv6 static routing tables.
    fortios_router_static6:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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>"
        gateway: "<your_own_value>"
        priority: "11"
        seq_num: "12"
        status: "enable"
        virtual_wan_link: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

router_static6:
    default: null
    description:
    - Configure IPv6 static routing tables.
    suboptions:
      bfd:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Bidirectional Forwarding Detection (BFD).
        type: str
      blackhole:
        choices:
        - enable
        - disable
        description:
        - Enable/disable black hole.
        type: str
      comment:
        description:
        - Optional comments.
        type: str
      device:
        description:
        - Gateway out interface or tunnel. Source system.interface.name.
        type: str
      devindex:
        description:
        - Device index (0 - 4294967295).
        type: int
      distance:
        description:
        - Administrative distance (1 - 255).
        type: int
      dst:
        description:
        - Destination IPv6 prefix.
        type: str
      gateway:
        description:
        - IPv6 address of the gateway.
        type: str
      priority:
        description:
        - Administrative priority (0 - 4294967295).
        type: int
      seq_num:
        description:
        - Sequence number.
        type: int
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this static route.
        type: str
      virtual_wan_link:
        choices:
        - enable
        - disable
        description:
        - Enable/disable egress through the virtual-wan-link.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str