cisco.ios.ios_vxlan_vtep (8.0.0) — module

Resource module to configure VXLAN VTEP interface.

| "added in version" 5.3.0 of cisco.ios"

Authors: Padmini Priyadarshini Sivaraj (@PadminiSivaraj)

Install collection

Install with ansible-galaxy collection install cisco.ios:==8.0.0


Add to requirements.yml

  collections:
    - name: cisco.ios
      version: 8.0.0

Description

This module provides declarative management of VXLAN VTEP interface on Cisco IOS network devices.

Inputs

    
state:
    choices:
    - merged
    - replaced
    - overridden
    - deleted
    - rendered
    - gathered
    - parsed
    default: merged
    description:
    - The state the configuration should be left in
    type: str

config:
    description: A dictionary of VXLAN VTEP interface option
    elements: dict
    suboptions:
      host_reachability_bgp:
        description:
        - Host reachability using EVPN protocol
        type: bool
      interface:
        description:
        - VXLAN VTEP interface
        required: true
        type: str
      member:
        description:
        - Configure VNI member
        suboptions:
          vni:
            description:
            - Configure VNI information
            suboptions:
              l2vni:
                description:
                - Associates L2VNI with the VXLAN VTEP interface
                elements: dict
                suboptions:
                  replication:
                    description: Replication type for the L2VNI
                    suboptions:
                      mcast_group:
                        description: Configure multicast group for VNI(s)
                        suboptions:
                          ipv4:
                            description: IPv4 multicast group
                            type: str
                          ipv6:
                            description: IPv6 multicast group
                            type: str
                        type: dict
                      type:
                        choices:
                        - ingress
                        - static
                        description: Replication type
                        type: str
                    type: dict
                  vni:
                    description: VNI number
                    type: int
                type: list
              l3vni:
                description:
                - Associates L3VNI with the VXLAN VTEP interface
                elements: dict
                suboptions:
                  vni:
                    description: VNI number
                    type: int
                  vrf:
                    description: VRF name of the L3VNI
                    type: str
                type: list
            type: dict
        type: dict
      source_interface:
        description:
        - Source interface for the VXLAN VTEP interface
        type: str
    type: list

running_config:
    description:
    - This option is used only with state I(parsed).
    - The value of this option should be the output received from the IOS device by executing
      the command B(show running-config | section ^interface nve).
    - The state I(parsed) reads the configuration from C(running_config) option and transforms
      it into Ansible structured data as per the resource module's argspec and the value
      is then returned in the I(parsed) key within the result.
    type: str

Outputs

after:
  description: The resulting configuration after module execution.
  returned: when changed
  sample: 'This output will always be in the same format as the module argspec.

    '
  type: dict
before:
  description: The configuration prior to the module execution.
  returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
    C(purged)
  sample: 'This output will always be in the same format as the module argspec.

    '
  type: dict
commands:
  description: The set of commands pushed to the remote device.
  returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
    C(purged)
  sample:
  - interface nve1
  - source-interface Loopback1
  - host-reachability protocol bgp
  - member vni 10101 ingress-replication
  type: list