Skip to content

Latest commit

 

History

History
465 lines (426 loc) · 19.9 KB

junipernetworks.junos.junos_vrf_module.rst

File metadata and controls

465 lines (426 loc) · 19.9 KB

junipernetworks.junos.junos_vrf

Manage the VRF definitions on Juniper JUNOS devices

Version added: 1.0.0

Synopsis

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

Requirements

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

  • ncclient (>=v0.5.2)

Parameters

Parameter Choices/Defaults Comments
active
boolean
    Choices:
  • no
  • yes ←
Specifies whether or not the configuration is active or deactivated
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
    Choices:
  • no
  • yes
Specifies whether or not the configuration is active or deactivated
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
    Choices:
  • present
  • absent
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
table_label
boolean
    Choices:
  • no
  • yes
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.
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
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
    Choices:
  • present ←
  • absent
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
table_label
boolean
    Choices:
  • no
  • yes ←
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.
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

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 Returned Description
diff.prepared
string
when configuration is changed and diff option is enabled.
Configuration difference before and after applying change.

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; + }


Status

Authors

  • Ganesh Nalawade (@ganeshrn)