junos_interface – Manage Interface on Juniper JUNOS network devices
New in version 2.4.
Synopsis
- This module provides declarative management of Interfaces on Juniper JUNOS network devices.
Requirements
The below requirements are needed on the host that executes this module.
- ncclient (>=v0.5.2)
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
active boolean |
| Specifies whether or not the configuration is active or deactivated | |
aggregate - | List of Interfaces definitions. | ||
delay - | Default: 10 | Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up /down , tx_rate and rx_rate. | |
description - | Description of Interface. | ||
duplex - |
| Interface link status. | |
enabled boolean |
| Configure interface link status. | |
mtu - | Maximum size of transmit packet. | ||
name - / required | Name of the Interface. | ||
neighbors - | Check the operational state of given interface name for LLDP neighbor.The following suboptions are available. | ||
host - | LLDP neighbor host for given interface name . | ||
port - | LLDP neighbor port to which given interface name is connected. | ||
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 / 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. | ||
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 | 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. | |
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 | 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. | |
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. | ||
rx_rate - | Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules
| ||
speed - | Interface link speed. | ||
state - |
| State of the Interface configuration, up idicates present and operationally up and down indicates present and operationally down
| |
tx_rate - | Transmit rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules
|
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.
- Recommended connection is
netconf
. See the Junos OS Platform Options. - This module also works with
local
connections for legacy playbooks. - For information on using CLI and netconf see the Junos OS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.
Examples
- name: configure interface junos_interface: name: ge-0/0/1 description: test-interface - name: remove interface junos_interface: name: ge-0/0/1 state: absent - name: make interface down junos_interface: name: ge-0/0/1 enabled: False - name: make interface up junos_interface: name: ge-0/0/1 enabled: True - name: Deactivate interface config junos_interface: name: ge-0/0/1 state: present active: False - name: Activate interface config net_interface: name: ge-0/0/1 state: present active: True - name: Configure interface speed, mtu, duplex junos_interface: name: ge-0/0/1 state: present speed: 1g mtu: 256 duplex: full - name: Create interface using aggregate junos_interface: aggregate: - name: ge-0/0/1 description: test-interface-1 - name: ge-0/0/2 description: test-interface-2 speed: 1g duplex: full mtu: 512 - name: Delete interface using aggregate junos_interface: aggregate: - name: ge-0/0/1 - name: ge-0/0/2 state: absent - name: Check intent arguments junos_interface: name: "{{ name }}" state: up tx_rate: ge(0) rx_rate: le(0) - name: Check neighbor intent junos_interface: name: xe-0/1/1 neighbors: - port: Ethernet1/0/1 host: netdev - name: Config + intent junos_interface: name: "{{ name }}" enabled: False state: down
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 interfaces] + ge-0/0/1 { + description test-interface; + } |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Ganesh Nalawade (@ganeshrn)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/junos_interface_module.html