ansible.builtin._net_static_route (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

This module provides declarative management of static IP routes on network appliances (routers, switches et. al.).

Usage examples

Scanned by Steampunk Spotter

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

- name: configure static route
  net_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: remove configuration
  net_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: configure aggregates of static routes
  net_static_route:
    aggregate:
      - { prefix: 192.168.2.0, mask: 255.255.255.0, next_hop: 10.0.0.1 }
      - { prefix: 192.168.3.0, mask: 255.255.255.0, next_hop: 10.0.2.1 }

Scanned by Steampunk Spotter

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

- name: Remove static route collections
  net_static_route:
    aggregate:
      - { prefix: 172.24.1.0/24, next_hop: 192.168.42.64 }
      - { prefix: 172.24.3.0/24, next_hop: 192.168.42.64 }
    state: absent

Inputs

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

purge:
    default: false
    description:
    - Purge static routes not defined in the I(aggregate) parameter.

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

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

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

aggregate:
    description: List of static route definitions

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/24 10.0.0.1
  type: list