amnesh.soodar.soodar_vrf module – Manage the collection of VRF definitions on Amnesh Soodar devices

Note

This module is part of the amnesh.soodar collection (version 1.0.0).

To install it, use: ansible-galaxy collection install https://soodar.ir/ansible/amnesh.soodar.tar.gz.

To use it in a playbook, specify: amnesh.soodar.soodar_vrf.

New in amnesh.soodar 1.0.0

Synopsis

  • This module provides declarative management of VRF definitions on Amnesh Soodar devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined.

Parameters

Parameter

Comments

associated_interfaces

list / elements=string

This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.

delay

integer

Time in seconds to wait before checking for the operational state on remote device.

Default: 10

description

string

Provides a short description of the VRF definition in the current active configuration. The VRF definition value accepts alphanumeric characters used to provide additional information about the VRF.

interfaces

list / elements=string

Identifies the set of interfaces that should be configured in the VRF. Interfaces must be routed interfaces in order to be placed into a VRF.

name

string

The name of the VRF definition to be managed on the remote IOS device. The VRF definition name is an ASCII string name used to uniquely identify the VRF. This argument is mutually exclusive with the vrfs argument

purge

boolean

Instructs the module to consider the VRF definition absolute. It will remove any previously configured VRFs on the device.

Choices:

  • false ← (default)

  • true

state

string

Configures the state of the VRF definition as it relates to the device operational configuration. When set to present, the VRF should be configured in the device active configuration and when set to absent the VRF should not be in the device active configuration

Choices:

  • "present" ← (default)

  • "absent"

vrfs

list / elements=any

The set of VRF definition objects to be configured on the remote IOS device. Ths list entries can either be the VRF name or a hash of VRF definitions and attributes. This argument is mutually exclusive with the name argument.

Notes

Note

  • Tested against Soodar Version 21.04

Examples

- name: configure a vrf named management
  amnesh.soodar.soodar_vrf:
    name: management
    description: oob mgmt vrf
    interfaces:
    - ge2

- name: remove a vrf named test
  amnesh.soodar.soodar_vrf:
    name: test
    state: absent

- name: configure set of VRFs and purge any others
  amnesh.soodar.soodar_vrf:
    vrfs:
    - red
    - blue
    - green
    purge: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

The list of configuration mode commands to send to the device

Returned: always

Sample: ["ip vrf ansible"]

delta

string

The time elapsed to perform all operations

Returned: always

Sample: "0:00:10.469466"

end

string

The time the job ended

Returned: always

Sample: "2016-11-16 10:38:25.595612"

start

string

The time the job started

Returned: always

Sample: "2016-11-16 10:38:15.126146"

Authors

  • Mahdi Varasteh (@m-varasteh)