ansible.builtin.junos_vlan (v2.8.18) — module

Install Ansible via pip

Install with pip install ansible==2.8.18

Description

This module provides declarative management of VLANs 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 VLAN ID and name
  junos_vlan:
    vlan_name: test
    vlan_id: 20
    name: test-vlan

Scanned by Steampunk Spotter

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

- name: Link to logical layer 3 interface
  junos_vlan:
    vlan_name: test
    vlan_id: 20
    l3-interface: vlan.20
    name: test-vlan

Scanned by Steampunk Spotter

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

- name: remove VLAN configuration
  junos_vlan:
    vlan_name: test
    state: absent

Scanned by Steampunk Spotter

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

- name: deactive VLAN configuration
  junos_vlan:
    vlan_name: test
    state: present
    active: False

Scanned by Steampunk Spotter

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

- name: activate VLAN configuration
  junos_vlan:
    vlan_name: test
    state: present
    active: True

Scanned by Steampunk Spotter

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

- name: Create vlan configuration using aggregate
  junos_vlan:
    aggregate:
      - { vlan_id: 159, name: test_vlan_1, description: test vlan-1 }
      - { vlan_id: 160, name: test_vlan_2, description: test vlan-2 }

Scanned by Steampunk Spotter

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

- name: Delete vlan configuration using aggregate
  junos_vlan:
    aggregate:
      - { vlan_id: 159, name: test_vlan_1 }
      - { vlan_id: 160, name: test_vlan_2 }
    state: absent

Inputs

    
name:
    description:
    - Name of the VLAN.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the VLAN configuration.

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

vlan_id:
    description:
    - ID of the VLAN. Range 1-4094.
    required: true

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 VLANs definitions.

interfaces:
    description:
    - List of interfaces to check the VLAN has been configured correctly.

description:
    description:
    - Text description of VLANs.

filter_input:
    description:
    - The name of input filter.
    version_added: '2.8'
    version_added_collection: ansible.builtin

l3_interface:
    description:
    - Name of logical layer 3 interface.
    version_added: '2.7'
    version_added_collection: ansible.builtin

filter_output:
    description:
    - The name of output filter.
    version_added: '2.8'
    version_added_collection: ansible.builtin

Outputs

diff.prepared:
  description: Configuration difference before and after applying change.
  returned: when configuration is changed and diff option is enabled.
  sample: '[edit vlans] +   test-vlan-1 { +       vlan-id 60; +   }

    '
  type: str