fortinet.fortios.fortios_router_policy6 (2.3.6) — module

Configure IPv6 routing policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure IPv6 routing policies.
  fortinet.fortios.fortios_router_policy6:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_policy6:
          action: "deny"
          comments: "<your_own_value>"
          dst:
              -
                  addr6: "<your_own_value>"
          dst_negate: "enable"
          dstaddr:
              -
                  name: "default_name_9 (source firewall.address6.name firewall.addrgrp6.name)"
          end_port: "65535"
          end_source_port: "65535"
          gateway: "<your_own_value>"
          input_device:
              -
                  name: "default_name_14 (source system.interface.name)"
          input_device_negate: "enable"
          internet_service_custom:
              -
                  name: "default_name_17 (source firewall.internet-service-custom.name)"
          internet_service_id:
              -
                  id: "19 (source firewall.internet-service.id)"
          output_device: "<your_own_value> (source system.interface.name system.interface.name)"
          protocol: "0"
          seq_num: "<you_own_value>"
          src:
              -
                  addr6: "<your_own_value>"
          src_negate: "enable"
          srcaddr:
              -
                  name: "default_name_27 (source firewall.address6.name firewall.addrgrp6.name)"
          start_port: "1"
          start_source_port: "1"
          status: "enable"
          tos: "<your_own_value>"
          tos_mask: "<your_own_value>"

Inputs

    
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

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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

router_policy6:
    default: null
    description:
    - Configure IPv6 routing policies.
    suboptions:
      action:
        choices:
        - deny
        - permit
        description:
        - Action of the policy route.
        type: str
      comments:
        description:
        - Optional comments.
        type: str
      dst:
        description:
        - Destination IPv6 prefix.
        elements: dict
        suboptions:
          addr6:
            description:
            - IPv6 address prefix.
            required: true
            type: str
        type: list
      dst_negate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable negating destination address match.
        type: str
      dstaddr:
        description:
        - Destination address name.
        elements: dict
        suboptions:
          name:
            description:
            - Address/group name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
            type: str
        type: list
      end_port:
        description:
        - End destination port number (1 - 65535).
        type: int
      end_source_port:
        description:
        - End source port number (1 - 65535).
        type: int
      gateway:
        description:
        - IPv6 address of the gateway.
        type: str
      input_device:
        description:
        - Incoming interface name. Source system.interface.name.
        elements: dict
        suboptions:
          name:
            description:
            - Interface name. Source system.interface.name.
            required: true
            type: str
        type: list
      input_device_negate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable negation of input device match.
        type: str
      internet_service_custom:
        description:
        - Custom Destination Internet Service name.
        elements: dict
        suboptions:
          name:
            description:
            - Custom Destination Internet Service name. Source firewall.internet-service-custom.name.
            required: true
            type: str
        type: list
      internet_service_id:
        description:
        - Destination Internet Service ID.
        elements: dict
        suboptions:
          id:
            description:
            - Destination Internet Service ID. see <a href='#notes'>Notes</a>. Source
              firewall.internet-service.id.
            required: true
            type: int
        type: list
      output_device:
        description:
        - Outgoing interface name. Source system.interface.name system.interface.name.
        type: str
      protocol:
        description:
        - Protocol number (0 - 255).
        type: int
      seq_num:
        description:
        - Sequence number(1-65535). see <a href='#notes'>Notes</a>.
        required: true
        type: int
      src:
        description:
        - Source IPv6 prefix.
        elements: dict
        suboptions:
          addr6:
            description:
            - IPv6 address prefix.
            required: true
            type: str
        type: list
      src_negate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable negating source address match.
        type: str
      srcaddr:
        description:
        - Source address name.
        elements: dict
        suboptions:
          name:
            description:
            - Address/group name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
            type: str
        type: list
      start_port:
        description:
        - Start destination port number (1 - 65535).
        type: int
      start_source_port:
        description:
        - Start source port number (1 - 65535).
        type: int
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy route.
        type: str
      tos:
        description:
        - Type of service bit pattern.
        type: str
      tos_mask:
        description:
        - Type of service evaluated bits.
        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