junipernetworks / junipernetworks.junos / 3.1.0 / module / junos_static_route
Removed in None
Reason:Updated modules released with more functionality | Alternative:Use M(junipernetworks.junos.junos_static_routes) instead.
(deprecated, removed after 2022-06-01) Manage static IP routes 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 static IP routes on Juniper JUNOS network devices.
- 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
state: choices: - present - absent default: present description: - State of the static route configuration. type: str active: default: true description: - Specifies whether or not the configuration is active or deactivated type: bool address: aliases: - prefix description: - Network address with prefix of the static route. type: str next_hop: description: - Next hop IP of the static route. 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 static route definitions elements: dict suboptions: active: description: - Specifies whether or not the configuration is active or deactivated type: bool address: description: - Network address with prefix of the static route. required: true type: str next_hop: description: - Next hop IP of the static route. type: str preference: aliases: - admin_distance description: - Global admin preference of the static route. type: int qualified_next_hop: description: - Qualified next hop IP of the static route. Qualified next hops allow to associate preference with a particular next-hop address. type: str qualified_preference: description: - Assign preference for qualified next hop. type: int state: choices: - present - absent description: - State of the static route configuration. type: str type: list preference: aliases: - admin_distance description: - Global admin preference of the static route. type: int qualified_next_hop: description: - Qualified next hop IP of the static route. Qualified next hops allow to associate preference with a particular next-hop address. type: str qualified_preference: description: - Assign preference for qualified next hop. type: int
diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. sample: "[edit routing-options static]\n route 2.2.2.0/24 { ... }\n+ route\ \ 4.4.4.0/24 {\n next-hop 3.3.3.3;\n qualified-next-hop 5.5.5.5\ \ {\n+ preference 30;\n }\n+ preference 10; + }\n" type: str