ansible.builtin.nxos_static_route (v2.3.3.0-1) — module

Manages static route configuration

| "added in version" 2.2 of ansible.builtin"

Authors: Gabriele Gerbino (@GGabriele)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manages static route configuration

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nxos_static_route:
    prefix: "192.168.20.64/24"
    next_hop: "3.3.3.3"
    route_name: testing
    pref: 100
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Inputs

    
tag:
    default: null
    description:
    - Route tag value (numeric).
    required: false

vrf:
    default: default
    description:
    - VRF for static route.
    required: false

pref:
    default: null
    description:
    - Preference or administrative difference of route (range 1-255).
    required: false

state:
    choices:
    - present
    - absent
    description:
    - Manage the state of the resource.
    required: true

prefix:
    description:
    - Destination prefix of static route.
    required: true

next_hop:
    description:
    - Next hop address or interface of static route. If interface, it must be the fully-qualified
      interface name.
    required: true

route_name:
    default: null
    description:
    - Name of the route. Used with the name parameter on the CLI.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of configuration after module execution
  returned: verbose mode
  sample:
    next_hop: 3.3.3.3
    pref: '100'
    prefix: 192.168.20.0/24
    route_name: testing
    tag: null
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: verbose mode
  sample: {}
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    next_hop: 3.3.3.3
    pref: '100'
    prefix: 192.168.20.64/24
    route_name: testing
    vrf: default
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - ip route 192.168.20.0/24 3.3.3.3 name testing 100
  type: list