junipernetworks.junos.junos_l2_interface module – (deprecated, removed after 2022-06-01) Manage L2 Interface on Juniper JUNOS network devices

Note

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

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_l2_interface.

New in version 1.0.0: of junipernetworks.junos

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules released with more functionality

Alternative

Use junipernetworks.junos.junos_l2_interfaces instead.

Synopsis

  • This module provides declarative management of Layer-2 interface on Juniper JUNOS network devices.

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

access_vlan

string

Configure given VLAN in access port. The value of access_vlan should be vlan name.

active

boolean

Specifies whether or not the configuration is active or deactivated

Choices:

  • no

  • yes ← (default)

aggregate

list / elements=dictionary

List of Layer-2 interface definitions.

access_vlan

string

Configure given VLAN in access port. The value of access_vlan should be vlan name.

active

boolean

Specifies whether or not the configuration is active or deactivated

Choices:

  • no

  • yes

description

string

Description of Interface.

enhanced_layer

boolean

True if your device has Enhanced Layer 2 Software (ELS).

Choices:

  • no

  • yes

filter_input

string

The name of input filter of ethernet-switching.

filter_output

string

The name of output filter of ethernet-switching.

mode

string

Mode in which interface needs to be configured.

Choices:

  • access

  • trunk

name

string / required

Name of the interface excluding any logical unit number.

native_vlan

integer

Native VLAN to be configured in trunk port. The value of native_vlan should be vlan id.

state

string

State of the Layer-2 Interface configuration.

Choices:

  • present

  • absent

trunk_vlans

list / elements=string

List of VLAN names to be configured in trunk port. The value of trunk_vlans should be list of vlan names.

unit

integer

Logical interface number. Value of unit should be of type integer.

description

string

Description of Interface.

enhanced_layer

boolean

True if your device has Enhanced Layer 2 Software (ELS).

Choices:

  • no

  • yes ← (default)

filter_input

string

The name of input filter of ethernet-switching.

filter_output

string

The name of output filter of ethernet-switching.

mode

string

Mode in which interface needs to be configured.

Choices:

  • access

  • trunk

name

string

Name of the interface excluding any logical unit number.

native_vlan

integer

Native VLAN to be configured in trunk port. The value of native_vlan should be vlan id.

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.

state

string

State of the Layer-2 Interface configuration.

Choices:

  • present ← (default)

  • absent

trunk_vlans

list / elements=string

List of VLAN names to be configured in trunk port. The value of trunk_vlans should be list of vlan names.

unit

integer

Logical interface number. Value of unit should be of type integer.

Default: 0

Notes

Note

Examples

- name: Configure interface in access mode
  junipernetworks.junos.junos_l2_interface:
    name: ge-0/0/1
    description: interface-access
    mode: access
    access_vlan: red
    active: true
    state: present

- name: Configure interface in trunk mode
  junipernetworks.junos.junos_l2_interface:
    name: ge-0/0/1
    description: interface-trunk
    mode: trunk
    trunk_vlans:
    - blue
    - green
    native_vlan: 100
    active: true
    state: present

- name: Configure interface in access and trunk mode using aggregate
  junipernetworks.junos.junos_l2_interface:
    aggregate:
    - name: ge-0/0/1
      description: test-interface-access
      mode: access
      access_vlan: red
    - name: ge-0/0/2
      description: test-interface-trunk
      mode: trunk
      trunk_vlans:
      - blue
      - green
      native_vlan: 100
    active: true
    state: present

Return Values

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

Key

Description

diff

string

Configuration difference before and after applying change.

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

Sample: “[edit interfaces] + ge-0/0/1 { + description \”l2 interface configured by Ansible\”; + unit 0 { + family ethernet-switching { + interface-mode access; + vlan { + members red; + } + } + } + }\n”

Status

  • This module will be removed in a major release after 2022-06-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ganesh Nalawade (@ganeshrn)