Skip to content

Latest commit

 

History

History
229 lines (188 loc) · 11.4 KB

cisco.nxos.nxos_evpn_vni.rst

File metadata and controls

229 lines (188 loc) · 11.4 KB
Raw

NxosEvpnVni()

Version

104

ScriptKit Synopsis

  • NxosEvpnVni() generates Ansible Playbook tasks conformant with cisco.nxos.nxos_evpn_vni
  • These can then be passed to Playbook().add_task()

Ansible Module Documentation

ScriptKit Example


Method Description
commit()

Perform final verification and commit the current task.:

- Type: function()
- Alias: update()
- Example:
    See also: ScriptKit Example above

    #!/usr/bin/env python3
    # configure evpn vni
    from ask.common.playbook import Playbook
    from ask.common.log import Log
    from ask.cisco.nxos.nxos_evpn_vni import NxosEvpnVni

    log_level_console = 'INFO'
    log_level_file = 'DEBUG'
    log = Log('my_log', log_level_console, log_level_file)

    pb = Playbook(log)
    pb.profile_nxos()
    pb.ansible_password = 'mypassword'
    pb.name = 'nxos_evpn_vni example'
    pb.add_host('dc-101')
    pb.file = '/tmp/nxos_evpn_vni.yaml'

    task = NxosEvpnVni(log)
    task.vni = 10302
    task.route_distinguisher = '1.2.3.4:302'
    task.route_target_import = ['1.2.3.4:304', '56220:1']
    task.route_target_export = ['65122:13']
    task.state = 'present'
    task.task_name = 'configure vni {}'.format(task.vni)
    task.commit()

    pb.add_task(task)
    pb.append_playbook()
    pb.write_playbook()
    log.info('wrote {}'.format(pb.file))

- Resulting tasks:

    hosts: dc-101
    name: nxos_evpn_vni example
    tasks:
    -   cisco.nxos.nxos_evpn_vni:
            route_distinguisher: 1.2.3.4:302
            route_target_export:
            - '65122:13'
            route_target_import:
            - 1.2.3.4:304
            - '56220:1'
            state: present
            vni: '10302'
        name: configure vni 10302

- Resulting config:

    evpn
      vni 10302 l2
        rd 1.2.3.4:302
        route-target import 1.2.3.4:304
        route-target import 56220:1
        route-target export 65122:13

Property Description
route_distinguisher

VPN Route Distinguisher (RD). RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address:

- Type: str()
- Valid values:
    - auto
    - default
    - y.y.y.y:x
        - where y.y.y.y is dotted-decimal address
        - where x is int()
    - x:x
        - where x is int()
- Examples:
    task.route_distinguisher = 'auto'
    task.route_distinguisher = 'default'
    task.route_distinguisher = '10.3.1.1:34000'
    task.route_distinguisher = '12229:14177'
route_target_both

Enables/Disables route-target settings for both import and export target communities using a single property:

- Type: str() or list()
- Valid values:
    - auto
    - default
    - list() with str() elements in the following
      formats:
        - y.y.y.y:x
            - where y.y.y.y is dotted-decimal address
            - where x is int()
        - x:x
            - where x is int()
- Examples:
    task.route_target_both = 'auto'
    task.route_target_both = 'default'
    rt = list()
    rt.append('10.1.1.3:12001')
    rt.append('12227:12001')
    task.route_target_both = rt.copy()
route_target_export

Sets the route-target 'export' extended communities:

- Type: str() or list()
- Valid values:
    - auto
    - default
    - list() with str() elements in the following
      formats:
        - y.y.y.y:x
            - where y.y.y.y is dotted-decimal address
            - where x is int()
        - x:x
            - where x is int()
- Examples:
    task.route_target_both = 'auto'
    task.route_target_both = 'default'
    rt = list()
    rt.append('10.1.1.3:12001')
    rt.append('12227:12001')
    task.route_target_both = rt.copy()
route_target_import

Sets the route-target 'import' extended communities:

- Type: str() or list()
- Valid values:
    - auto
    - default
    - list() with str() elements in the following
      formats:
        - y.y.y.y:x
            - where y.y.y.y is dotted-decimal address
            - where x is int()
        - x:x
            - where x is int()
- Examples:
    task.route_target_both = 'auto'
    task.route_target_both = 'default'
    rt = list()
    rt.append('10.1.1.3:12001')
    rt.append('12227:12001')
    task.route_target_both = rt.copy()
state

Determines whether the config should be present or not on the remote device:

- Type: str()
- Valid values:
    - absent
    - present
- Default: present
task_name

Name of the task. Ansible will display this when the playbook is run:

- Type: str()
- Examples:
    - task.task_name = 'my task'
vni

The EVPN VXLAN Network Identifier:

- Type: int()
- Examples:
    - task.vni = 32020

NOTES

  1. feature nv overlay must be enabled before using this library
  2. RD override is not permitted. You should set it to the default values first and then reconfigure it
  3. route_target_both, route_target_import and route_target_export valid values are a list of extended communities (e.g. ['1.2.3.4:5', '33:55']) or the keywords auto or default.
  4. route_target_both property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit route_target_export and route_target_import properties instead of route_target_both
  5. RD valid values are a string in one of the route-distinguisher formats, the keyword auto, or the keyword default

Authors

  • Allen Robel (@PacketCalc)