ansible.builtin.ios_static_route (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

This module provides declarative management of static IP routes on Cisco IOS network devices.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure static route
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    next_hop: 10.0.0.1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure black hole in vrf blue depending on tracked item 10
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    vrf: blue
    interface: null0
    track: 10

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure ultimate route with name and tag
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    interface: GigabitEthernet1
    name: hello world
    tag: 100

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: remove configuration
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    next_hop: 10.0.0.1
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add static route aggregates
  ios_static_route:
    aggregate:
      - { prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
      - { prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove static route aggregates
  ios_static_route:
    aggregate:
      - { prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
      - { prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
    state: absent

Inputs

    
tag:
    description:
    - Set tag of the static route.
    version_added: '2.8'
    version_added_collection: ansible.builtin

vrf:
    description:
    - VRF of the static route.
    version_added: '2.8'
    version_added_collection: ansible.builtin

mask:
    description:
    - Network prefix mask of the static route.

name:
    aliases:
    - description
    description:
    - Name of the static route
    version_added: '2.8'
    version_added_collection: ansible.builtin

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the static route configuration.

track:
    description:
    - Tracked item to depend on for the static route.
    version_added: '2.8'
    version_added_collection: ansible.builtin

prefix:
    description:
    - Network prefix of the static route.

next_hop:
    description:
    - Next hop IP of the static route.

aggregate:
    description: List of static route definitions.

interface:
    description:
    - Interface of the static route.
    version_added: '2.8'
    version_added_collection: ansible.builtin

admin_distance:
    description:
    - Admin distance of the static route.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - ip route 192.168.2.0 255.255.255.0 10.0.0.1
  type: list