junipernetworks / junipernetworks.junos / 3.1.0 / module / junos_interface
Removed in None
Reason:Updated modules released with more functionality | Alternative:Use M(junipernetworks.junos.junos_interfaces) instead.
(deprecated, removed after 2022-06-01) Manage Interface on Juniper JUNOS network devices
| "added in version" 1.0.0 of junipernetworks.junos"
Authors: Ganesh Nalawade (@ganeshrn)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install junipernetworks.junos:==3.1.0
collections: - name: junipernetworks.junos version: 3.1.0
This module provides declarative management of Interfaces on Juniper JUNOS network devices.
- name: configure interface junipernetworks.junos.junos_interface: name: ge-0/0/1 description: test-interface
- name: remove interface junipernetworks.junos.junos_interface: name: ge-0/0/1 state: absent
- name: make interface down junipernetworks.junos.junos_interface: name: ge-0/0/1 enabled: false
- name: make interface up junipernetworks.junos.junos_interface: name: ge-0/0/1 enabled: true
- name: Deactivate interface config junipernetworks.junos.junos_interface: name: ge-0/0/1 state: present active: false
- name: Activate interface config junipernetworks.junos.junos_interface: name: ge-0/0/1 state: present active: true
- name: Configure interface speed, mtu, duplex junipernetworks.junos.junos_interface: name: ge-0/0/1 state: present speed: 1g mtu: 256 duplex: full
- name: Create interface using aggregate junipernetworks.junos.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 junipernetworks.junos.junos_interface: aggregate: - name: ge-0/0/1 - name: ge-0/0/2 state: absent
- name: Check intent arguments junipernetworks.junos.junos_interface: name: '{{ name }}' state: up tx_rate: ge(0) rx_rate: le(0)
- name: Check neighbor intent junipernetworks.junos.junos_interface: name: xe-0/1/1 neighbors: - port: Ethernet1/0/1 host: netdev
- name: Config + intent junipernetworks.junos.junos_interface: name: '{{ name }}' enabled: false state: down
mtu: description: - Maximum size of transmit packet. type: int name: description: - Name of the Interface. type: str delay: default: 10 description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). type: int speed: description: - Interface link speed. type: str state: choices: - present - absent - up - down default: present description: - State of the Interface configuration, C(up) indicates present and operationally up and C(down) indicates present and operationally C(down) type: str active: default: true description: - Specifies whether or not the configuration is active or deactivated type: bool duplex: choices: - full - half - auto description: - Interface link status. type: str enabled: default: true description: - Configure interface link status. type: bool rx_rate: description: - Receiver rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str tx_rate: description: - Transmit rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str 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 Interfaces definitions. elements: dict suboptions: active: description: - Specifies whether or not the configuration is active or deactivated type: bool delay: description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). type: int description: description: - Description of Interface. type: str duplex: choices: - full - half - auto description: - Interface link status. type: str enabled: description: - Configure interface link status. type: bool mtu: description: - Maximum size of transmit packet. type: int name: description: - Name of the Interface. required: true type: str neighbors: description: - Check the operational state of given interface C(name) for LLDP neighbor. - The following suboptions are available. elements: dict suboptions: host: description: - LLDP neighbor host for given interface C(name). type: str port: description: - LLDP neighbor port to which given interface C(name) is connected. type: str type: list rx_rate: description: - Receiver rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str speed: description: - Interface link speed. type: str state: choices: - present - absent - up - down description: - State of the Interface configuration, C(up) indicates present and operationally up and C(down) indicates present and operationally C(down) type: str tx_rate: description: - Transmit rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str type: list neighbors: description: - Check the operational state of given interface C(name) for LLDP neighbor. - The following suboptions are available. elements: dict suboptions: host: description: - LLDP neighbor host for given interface C(name). type: str port: description: - LLDP neighbor port to which given interface C(name) is connected. type: str type: list description: description: - Description of Interface. type: str
diff.prepared: 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 test-interface; + } ' type: str