Note
This plugin is part of the junipernetworks.junos collection (version 2.6.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
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
major release after 2022-06-01
Updated modules released with more functionality
Use junipernetworks.junos.junos_static_routes instead.
Note
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
| 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 / required | 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. | |
Note
netconf. See the Junos OS Platform Options.local connections for legacy playbooks.- 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
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 routing-options static] route 2.2.2.0/24 { ... } + route 4.4.4.0/24 { next-hop 3.3.3.3; qualified-next-hop 5.5.5.5 { + preference 30; } + preference 10; + } |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/junos_static_route_module.html