ansible.builtin.nxos_vxlan_vtep (v2.3.3.0-1) — module

Manages VXLAN Network Virtualization Endpoint (NVE).

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

Authors: Gabriele Gerbino (@GGabriele)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nxos_vxlan_vtep:
    interface: nve1
    description: default
    host_reachability: default
    source_interface: Loopback0
    source_interface_hold_down_time: 30
    shutdown: default
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.
    required: false

shutdown:
    choices:
    - 'true'
    - 'false'
    default: false
    description:
    - Administratively shutdown the NVE interface.
    required: false

interface:
    description:
    - Interface name for the VXLAN Network Virtualization Endpoint.
    required: true

description:
    default: null
    description:
    - Description of the NVE interface.
    required: false

source_interface:
    default: null
    description:
    - Specify the loopback interface whose IP address should be used for the NVE interface.
    required: false

host_reachability:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Specify mechanism for host reachability advertisement.
    required: false

source_interface_hold_down_time:
    default: null
    description:
    - Suppresses advertisement of the NVE loopback address until the overlay has converged.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of VXLAN VTEP configuration after module execution
  returned: verbose mode
  sample:
    description: simple description
    host_reachability: true
    interface: nve1
    shutdown: true
    source_interface: loopback0
    source_interface_hold_down_time: '30'
  type: dict
existing:
  description: k/v pairs of existing VXLAN VTEP configuration
  returned: verbose mode
  sample: {}
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    description: simple description
    host_reachability: true
    interface: nve1
    shutdown: true
    source_interface: loopback0
    source_interface_hold_down_time: '30'
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - interface nve1
  - source-interface loopback0
  - source-interface hold-down-time 30
  - description simple description
  - shutdown
  - host-reachability protocol bgp
  type: list