junipernetworks.junos.junos_vrf module – Manage the VRF definitions on Juniper JUNOS devices

Note

This module is part of the junipernetworks.junos collection (version 3.0.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install junipernetworks.junos.

To use it in a playbook, specify: junipernetworks.junos.junos_vrf.

New in version 1.0.0: of junipernetworks.junos

Synopsis

  • This module provides declarative management of VRF definitions on Juniper JUNOS devices. It allows playbooks to manage individual or the entire VRF collection.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ncclient (>=v0.5.2)

Parameters

Parameter

Comments

active

boolean

Specifies whether or not the configuration is active or deactivated

Choices:

  • no

  • yes ← (default)

aggregate

list / elements=dictionary

The set of VRF definition objects to be configured on the remote JUNOS 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.

active

boolean

Specifies whether or not the configuration is active or deactivated

Choices:

  • no

  • yes

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 / required

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 aggregate argument

rd

list / elements=string

The router-distinguisher value uniquely identifies the VRF to routing processes on the remote IOS system. The RD value takes the form of A:B where A and B are both numeric values.

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

  • absent

table_label

boolean

Causes JUNOS to allocate a VPN label per VRF rather than per VPN FEC. This allows for forwarding of traffic to directly connected subnets, COS Egress filtering etc.

Choices:

  • no

  • yes

target

list / elements=string

It configures VRF target community configuration. The target value takes the form of target:A:B where A and B are both numeric values.

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 aggregate argument

provider

dictionary

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.

For more information please see the Junos OS Platform Options guide.


A dict object containing connection details.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device.

ssh_keyfile

path

Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.

transport

string

Configures the transport connection to use when connecting to the remote device.

Choices:

  • cli

  • netconf ← (default)

username

string

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

rd

list / elements=string

The router-distinguisher value uniquely identifies the VRF to routing processes on the remote IOS system. The RD value takes the form of A:B where A and B are both numeric values.

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

table_label

boolean

Causes JUNOS to allocate a VPN label per VRF rather than per VPN FEC. This allows for forwarding of traffic to directly connected subnets, COS Egress filtering etc.

Choices:

  • no

  • yes ← (default)

target

list / elements=string

It configures VRF target community configuration. The target value takes the form of target:A:B where A and B are both numeric values.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.

  • Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.

  • Recommended connection is netconf. See the Junos OS Platform Options.

  • This module also works with local connections for legacy playbooks.

  • For information on using CLI and netconf see the Junos OS Platform Options guide

  • For more information on using Ansible to manage network devices see the Ansible Network Guide

  • For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.

Examples

- name: Configure vrf configuration
  junipernetworks.junos.junos_vrf:
    name: test-1
    description: test-vrf-1
    interfaces:
    - ge-0/0/3
    - ge-0/0/2
    rd: 192.0.2.1:10
    target: target:65514:113
    state: present

- name: Remove vrf configuration
  junipernetworks.junos.junos_vrf:
    name: test-1
    description: test-vrf-1
    interfaces:
    - ge-0/0/3
    - ge-0/0/2
    rd: 192.0.2.1:10
    target: target:65514:113
    state: absent

- name: Deactivate vrf configuration
  junipernetworks.junos.junos_vrf:
    name: test-1
    description: test-vrf-1
    interfaces:
    - ge-0/0/3
    - ge-0/0/2
    rd: 192.0.2.1:10
    target: target:65514:113
    active: false

- name: Activate vrf configuration
  junipernetworks.junos.junos_vrf:
    name: test-1
    description: test-vrf-1
    interfaces:
    - ge-0/0/3
    - ge-0/0/2
    rd: 192.0.2.1:10
    target: target:65514:113
    active: true

- name: Create vrf using aggregate
  junipernetworks.junos.junos_vrf:
    aggregate:
    - name: test-1
      description: test-vrf-1
      interfaces:
      - ge-0/0/3 - ge-0/0/2
      rd: 192.0.2.1:10
      target: target:65514:113
    - name: test-2
      description: test-vrf-2
      interfaces:
      - ge-0/0/4
      - ge-0/0/5
      rd: 192.0.2.2:10
      target: target:65515:114
  state: present

Return Values

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

Key

Description

diff.prepared

string

Configuration difference before and after applying change.

Returned: when configuration is changed and diff option is enabled.

Sample: “[edit routing-instances] + test-1 { + description test-vrf-1; + instance-type vrf; + interface ge-0/0/2.0; + interface ge-0/0/3.0; + route-distinguisher 192.0.2.1:10; + vrf-target target:65514:113; + }\n”

Authors

  • Ganesh Nalawade (@ganeshrn)