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

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 system feature and vxlan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• 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 VXLAN devices.
    fortios_system_vxlan:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_vxlan:
        dstport: "3"
        interface: "<your_own_value> (source system.interface.name)"
        ip_version: "ipv4-unicast"
        multicast_ttl: "6"
        name: "default_name_7"
        remote_ip:
         -
            ip: "<your_own_value>"
        remote_ip6:
         -
            ip6: "<your_own_value>"
        vni: "12"

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

system_vxlan:
    default: null
    description:
    - Configure VXLAN devices.
    suboptions:
      dstport:
        description:
        - VXLAN destination port (1 - 65535).
        type: int
      interface:
        description:
        - Outgoing interface for VXLAN encapsulated traffic. Source system.interface.name.
        type: str
      ip_version:
        choices:
        - ipv4-unicast
        - ipv6-unicast
        - ipv4-multicast
        - ipv6-multicast
        description:
        - IP version to use for the VXLAN interface and so for communication over the
          VXLAN. IPv4 or IPv6 unicast or multicast.
        type: str
      multicast_ttl:
        description:
        - VXLAN multicast TTL (1-255).
        type: int
      name:
        description:
        - VXLAN device or interface name. Must be a unique interface name.
        required: true
        type: str
      remote_ip:
        description:
        - IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN.
        suboptions:
          ip:
            description:
            - IPv4 address.
            required: true
            type: str
        type: list
      remote_ip6:
        description:
        - IPv6 IP address of the VXLAN interface on the device at the remote end of the
          VXLAN.
        suboptions:
          ip6:
            description:
            - IPv6 address.
            required: true
            type: str
        type: list
      vni:
        description:
        - VXLAN network ID.
        type: int
    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