junos_l2_interface - Manage Layer-2 interface on Juniper JUNOS network devices

New in version 2.5.

Synopsis

Requirements

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

  • ncclient (>=v0.5.2)

Parameters

Parameter Choices/Defaults Comments
access_vlan
Configure given VLAN in access port. The value of access_vlan should be vlan name.
active
bool
    Choices:
  • no
  • yes ←
Specifies whether or not the configuration is active or deactivated
aggregate
List of Layer-2 interface definitions.
description
Description of Interface.
enhanced_layer
bool

(added in 2.7)
    Choices:
  • no
  • yes ←
True if your device has Enhanced Layer 2 Software (ELS).
mode
    Choices:
  • access
  • trunk
Mode in which interface needs to be configured.
name
Name of the interface excluding any logical unit number.
native_vlan
Native VLAN to be configured in trunk port. The value of native_vlan should be vlan id.
provider
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.
username
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.
host
required
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.
ssh_keyfile
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 Default:
10
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.
password
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 Default:
22
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.
state
    Choices:
  • present ←
  • absent
State of the Layer-2 Interface configuration.
trunk_vlans
List of VLAN names to be configured in trunk port. The value of trunk_vlans should be list of vlan names.
unit Default:
0
Logical interface number. Value of unit should be of type integer.

Notes

Note

Examples

- name: Configure interface in access mode
  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
  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
  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 Returned Description
diff
string
 when configuration is changed and diff option is enabled.
Configuration difference before and after applying change.

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Network Team, see here.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Ganesh Nalawade (@ganeshrn)

Hint

If you notice any issues in this documentation you can edit this document to improve it.