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

Creates a Virtual Network Identifier member (VNI)

| "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

Creates a Virtual Network Identifier member (VNI) for an NVE overlay interface.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nxos_vxlan_vtep_vni:
    interface: nve1
    vni: 6000
    ingress_replication: default
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Inputs

    
vni:
    description:
    - ID of the Virtual Network Identifier.
    required: true

save:
    choices:
    - 'true'
    - 'false'
    default: false
    description:
    - Specify to save the running configuration after module operations.
    required: false

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

config:
    default: null
    description:
    - Configuration string to be used for module operations. If not specified, the module
      will use the current running configuration.
    required: false

assoc_vrf:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - This attribute is used to identify and separate processing VNIs that are associated
      with a VRF and used for routing. The VRF and VNI specified with this command must
      match the configuration of the VNI under the VRF.
    required: false

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

peer_list:
    default: null
    description:
    - Set the ingress-replication static peer list. Valid values are an array, a space-separated
      string of ip addresses, or the keyword 'default'.
    required: false

suppress_arp:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Suppress arp under layer 2 VNI.
    required: false

multicast_group:
    default: null
    description:
    - The multicast group (range) of the VNI. Valid values are string and keyword 'default'.
    required: false

include_defaults:
    choices:
    - 'true'
    - 'true'
    default: true
    description:
    - Specify to use or not the complete running configuration for module operations.
    required: false

ingress_replication:
    choices:
    - bgp
    - static
    default: null
    description:
    - Specifies mechanism for host reachability advertisement.
    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 configuration after module execution
  returned: verbose mode
  sample:
    assoc_vrf: false
    ingress_replication: ''
    interface: nve1
    multicast_group: ''
    peer_list: []
    suppress_arp: false
    vni: '6000'
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: verbose mode
  sample: {}
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    ingress_replication: default
    interface: nve1
    vni: '6000'
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - interface nve1
  - member vni 6000
  type: list