junipernetworks.junos.junos_static_route – (deprecated, removed after 2022-06-01) Manage static IP routes on Juniper JUNOS network devices¶
Note
This plugin is part of the junipernetworks.junos collection (version 1.3.0).
To install it use: ansible-galaxy collection install junipernetworks.junos
.
To use it in a playbook, specify: junipernetworks.junos.junos_static_route
.
New in version 1.0.0: of junipernetworks.junos
DEPRECATED¶
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use junipernetworks.junos.junos_static_routes instead.
Synopsis¶
This module provides declarative management of static IP routes on Juniper JUNOS network devices.
Note
This module has a corresponding action plugin.
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
|
|
address
string
|
Network address with prefix of the static route.
aliases: prefix |
||
aggregate
list
/ elements=dictionary
|
List of static route definitions
|
||
active
boolean
|
|
Specifies whether or not the configuration is active or deactivated
|
|
address
string
|
Network address with prefix of the static route.
|
||
next_hop
string
|
Next hop IP of the static route.
|
||
preference
integer
|
Global admin preference of the static route.
aliases: admin_distance |
||
qualified_next_hop
string
|
Qualified next hop IP of the static route. Qualified next hops allow to associate preference with a particular next-hop address.
|
||
qualified_preference
integer
|
Assign preference for qualified next hop.
|
||
state
string
|
|
State of the static route configuration.
|
|
next_hop
string
|
Next hop IP of the static route.
|
||
preference
integer
|
Global admin preference of the static route.
aliases: admin_distance |
||
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
|
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
|
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
|
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.
|
||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
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. |
||
qualified_next_hop
string
|
Qualified next hop IP of the static route. Qualified next hops allow to associate preference with a particular next-hop address.
|
||
qualified_preference
integer
|
Assign preference for qualified next hop.
|
||
state
string
|
|
State of the static route configuration.
|
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 static route
junipernetworks.junos.junos_static_route:
address: 192.168.2.0/24
next_hop: 10.0.0.1
preference: 10
qualified_next_hop: 10.0.0.2
qualified_preference: 3
state: present
- name: delete static route
junipernetworks.junos.junos_static_route:
address: 192.168.2.0/24
state: absent
- name: deactivate static route configuration
junipernetworks.junos.junos_static_route:
address: 192.168.2.0/24
next_hop: 10.0.0.1
preference: 10
qualified_next_hop: 10.0.0.2
qualified_preference: 3
state: present
active: false
- name: activate static route configuration
junipernetworks.junos.junos_static_route:
address: 192.168.2.0/24
next_hop: 10.0.0.1
preference: 10
qualified_next_hop: 10.0.0.2
qualified_preference: 3
state: present
active: true
- name: Configure static route using aggregate
junipernetworks.junos.junos_static_route:
aggregate:
- {address: 4.4.4.0/24, next_hop: 3.3.3.3, qualified_next_hop: 5.5.5.5, qualified_preference: 30}
- {address: 5.5.5.0/24, next_hop: 6.6.6.6, qualified_next_hop: 7.7.7.7, qualified_preference: 12}
preference: 10
- name: Delete static route using aggregate
junipernetworks.junos.junos_static_route:
aggregate:
- address: 4.4.4.0/24
- address: 5.5.5.0/24
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors¶
Ganesh Nalawade (@ganeshrn)