NxosVrf() generates Ansible task instances conformant with its identically-named Ansible module. These task instances can then be passed to Playbook().add_task()
| Properties / Methods | Description |
|---|---|
| add_vrf() | Append the currently-configured vrf to the vrf
list, and clear all vrf-related properties so that
another vrf can be configured. See
- Type: method
- Example:
task = NxosVrf(log_instance)
task.name = 'vrf_1'
task.description = 'ENG'
task.interfaces = ['Ethernet1/1']
task.rd = 'auto'
task.add_vrf()
task.name = 'vrf_2'
task.description = 'SALES'
task.interfaces = ['Ethernet1/2']
task.rd = 'auto'
task.add_vrf()
etc...
|
| admin_state | Administrative state of the VRF: - Type: str()
- Valid values:
- down
- up
- Examples:
task.admin_state = 'up'
|
| aggregate | list() of VRF definitions: This property is not accessed directly. Use ScriptKit's add_vrf() method to populate the aggregate list(). If ``add_vrf()`` is not called prior to ``update()``, then the task will contain a single vrf, and aggregate is not used. See ScriptKit Example above for example usage in a script. |
| associated_interfaces | This is an intent option and checks the operational state of the interfaces for the given vrf name. If the value in the associated_interfaces list() does not match the operational state of vrf interfaces on device the module will report a failure: - Type: list()
- Valid values:
- list() of interface names
- keyword: default
- Examples:
task.associated_interfaces = 'default'
interfaces = list()
interfaces.append('Ethernet1/1')
interfaces.append('port-channel44')
task.associated_interfaces = interfaces
|
| delay | Time in seconds to wait before checking for the operational state on the remote device: - Type: int()
- Default: 10
- Examples:
task.delay = 20
|
| description | Description of the VRF: - Type: str()
- Valid values:
- freeform vrf description
- keyword: default
- Examples:
task.description = 'no offsite access'
task.description = 'default'
|
| interfaces | List of interfaces on which to configure VRF membership: - Type: list()
- Valid values:
- list() of interface names
- keyword: default
- Examples:
task.interfaces = 'default'
interfaces = list()
interfaces.append('Ethernet1/1')
interfaces.append('port-channel44')
task.interfaces = interfaces
|
| name | Name of the VRF to be managed: - Type: str()
- Examples:
- task.name = 'my_vrf'
|
| purge | Purge VRFs not defined in the aggregate parameter: - Type: bool()
- Valid values:
- False
- True
- Notes:
1. purge is recognized only when
NxosVrf().add_vrf() is used. For example,
the following purges all vrfs configured
on the remote device, except for vrf_1
and vrf_2::
task.name = 'vrf_1'
task.state = 'present'
task.add_vrf()
task.name = 'vrf_2'
task.state = 'present'
task.add_vrf()
task.purge = 'yes'
task.update()
|
| rd | VPN Route Distinguisher (RD): - Type: str()
- Valid values:
- ASN2:NN
- ASN4:NN
- IPV4:NN
- keyword: auto
- keyword: default
- Examples:
task.rd = 'auto'
task.rd = 'default'
task.rd = '65230:200'
task.rd = '29123312:65000'
task.rd = '10.1.1.1:65200'
|
| state | Manages desired state of the resource: - Type: str()
- Valid values:
- absent
- present
- Examples:
task.state = 'present'
|
| task_name | Freeform name for the task (ansible-playbook will print this when the task is run): - Type: str()
- Examples:
task.task_name = 'configure vrf {}'.format(task.name)
|
| vni | Virtual network identifier: - Type: int()
- Valid values:
- A VNI
- keyword: default
- Examples:
task.vni = 10200
task.vni = 'default'
|
- Allen Robel (@PacketCalc)