New in version 2.4.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
active
bool |
|
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 |
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 |
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. |
|
| 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
|
||
Note
netconf. See the Junos OS Platform Options.local connections for legacy playbooks.- 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
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; + }
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.