junipernetworks.junos.junos_l2_interface (3.1.0) — module

Install collection

Install with ansible-galaxy collection install junipernetworks.junos:==3.1.0

Add to requirements.yml

  collections:
    - name: junipernetworks.junos
      version: 3.1.0

Description

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

Requirements

• ncclient (>=v0.5.2)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
mode:
    choices:
    - access
    - trunk
    description:
    - Mode in which interface needs to be configured.
    type: str

name:
    description:
    - Name of the interface excluding any logical unit number.
    type: str

unit:
    default: 0
    description:
    - Logical interface number. Value of C(unit) should be of type integer.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the Layer-2 Interface configuration.
    type: str

active:
    default: true
    description:
    - Specifies whether or not the configuration is active or deactivated
    type: bool

provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli) or C(connection:
      netconf).'
    - For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html).
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - 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.
        type: str
      password:
        description:
        - 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 C(ANSIBLE_NET_PASSWORD) will
          be used instead.
        type: str
      port:
        description:
        - 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 C(transport=cli))
          or port 830 (for C(transport=netconf)) device.
        type: int
      ssh_keyfile:
        description:
        - 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 C(ANSIBLE_NET_SSH_KEYFILE)
          will be used instead.
        type: path
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - cli
        - netconf
        default: netconf
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      username:
        description:
        - 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 C(ANSIBLE_NET_USERNAME)
          will be used instead.
        type: str
    type: dict

aggregate:
    description:
    - List of Layer-2 interface definitions.
    elements: dict
    suboptions:
      access_vlan:
        description:
        - Configure given VLAN in access port. The value of C(access_vlan) should be vlan
          name.
        type: str
      active:
        description:
        - Specifies whether or not the configuration is active or deactivated
        type: bool
      description:
        description:
        - Description of Interface.
        type: str
      enhanced_layer:
        description:
        - True if your device has Enhanced Layer 2 Software (ELS).
        type: bool
      filter_input:
        description:
        - The name of input filter of ethernet-switching.
        type: str
      filter_output:
        description:
        - The name of output filter of ethernet-switching.
        type: str
      mode:
        choices:
        - access
        - trunk
        description:
        - Mode in which interface needs to be configured.
        type: str
      name:
        description:
        - Name of the interface excluding any logical unit number.
        required: true
        type: str
      native_vlan:
        description:
        - Native VLAN to be configured in trunk port. The value of C(native_vlan) should
          be vlan id.
        type: int
      state:
        choices:
        - present
        - absent
        description:
        - State of the Layer-2 Interface configuration.
        type: str
      trunk_vlans:
        description:
        - List of VLAN names to be configured in trunk port. The value of C(trunk_vlans)
          should be list of vlan names.
        elements: str
        type: list
      unit:
        description:
        - Logical interface number. Value of C(unit) should be of type integer.
        type: int
    type: list

access_vlan:
    description:
    - Configure given VLAN in access port. The value of C(access_vlan) should be vlan
      name.
    type: str

description:
    description:
    - Description of Interface.
    type: str

native_vlan:
    description:
    - Native VLAN to be configured in trunk port. The value of C(native_vlan) should be
      vlan id.
    type: int

trunk_vlans:
    description:
    - List of VLAN names to be configured in trunk port. The value of C(trunk_vlans) should
      be list of vlan names.
    elements: str
    type: list

filter_input:
    description:
    - The name of input filter of ethernet-switching.
    type: str

filter_output:
    description:
    - The name of output filter of ethernet-switching.
    type: str

enhanced_layer:
    default: true
    description:
    - True if your device has Enhanced Layer 2 Software (ELS).
    type: bool

Outputs

diff:
  description: 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; +               }
    +           } +       } +   }

    '
  type: str