arubanetworks.aoscx.aoscx_ospfv3_router (4.3.2) — module

Create, Update or Delete OSPFv3 configuration on AOS-CX

| "added in version" 4.1.0 of arubanetworks.aoscx"

Authors: Aruba Networks (@ArubaNetworks)

preview | supported by certified

Install collection

Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2


Add to requirements.yml

  collections:
    - name: arubanetworks.aoscx
      version: 4.3.2

Description

This modules provides configuration management of OSPFv3 Routers on AOS-CX devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Create new OSPFv3 Router
  aoscx_ospfv3_router:
    vrf: default
    instance_tag: 1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Create new OSPFv3 Router, with bgp and static as OSPF
    redistribution methods.
  aoscx_ospfv3_router:
    state: update
    vrf: default
    instance_tag: 1
    redistribute:
      - bgp
      - static
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Update OSPFv3 Router, add connected to the redistribute methods list.
  aoscx_ospfv3_router:
    state: update
    vrf: default
    instance_tag: 1
    redistribute:
      - connected
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Update OSPFv3 Router, set redistribute to connected, and static only. This
    deletes bgp from the list.
  aoscx_ospfv3_router:
    state: override
    vrf: default
    instance_tag: 1
    redistribute:
      - connected
      - static
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Update OSPFv3 Router, set redistribute to connected only. This deletes
    static from the list.
  aoscx_ospfv3_router:
    state: override
    vrf: default
    instance_tag: 1
    redistribute:
      - connected
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete OSPFv3 Router
  aoscx_ospfv3_router:
    state: delete
    vrf: default
    instance_tag: 1

Inputs

    
vrf:
    description: 'The VRF the OSPFv3 Router will belong to once created. If none provided,
      it will be in the Default VRF. If the OSPFv3 Router is created and the user wants
      to change its VRF, the user must first delete the OSPFv3 Router, and then recreate
      it in the desired VRF.

      '
    required: true
    type: str

state:
    choices:
    - create
    - update
    - delete
    - override
    default: create
    description: Create, update, or delete the OSPFv3 Router.
    required: false
    type: str

distance:
    description: Administrative distances.
    required: false
    suboptions:
      all:
        description: 'The administrative distance applies to all types of routes if not
          configured specifically for certain types. Must be in [1, 255].

          '
        required: false
        type: int
      external:
        description: 'The administrative distance applies to routes of type external.
          Must be in [1, 255].

          '
        required: false
        type: int
      inter_area:
        description: 'The administrative distance applies to routes of type inter-area.
          Must be in [1, 255].

          '
        required: false
        type: int
      intra_area:
        description: 'The administrative distance applies to routes of type intra-area.
          Must be in [1, 255].

          '
        required: false
        type: int
    type: dict

snmp_traps:
    description: The configurations related to the OSPF SNMP traps.
    required: false
    suboptions:
      base:
        description: Enable all the base (non LSA) traps.
        required: true
        type: bool
      lsa:
        description: Enable all LSA traps.
        required: true
        type: bool
      throttle_num_traps:
        description: 'Maximum number of traps to be generated per throttle window, must
          be in [0, 255].

          '
        required: true
        type: int
      throttle_time_window:
        description: Maximum number of traps to be generated per throttle window, must
          be in [2, 60].
        required: true
        type: int
    type: dict

lsa_arrival:
    description: 'Minimum wait time in milliseconds before same LSAs received from a peer
      are processed. Must be in [0, 600000]

      '
    required: false
    type: int

instance_tag:
    description: OSPF Process ID, in [0, 63]
    required: true
    type: int

lsa_throttle:
    description: Timers related to LSA throttling.
    required: false
    suboptions:
      hold_time:
        description: 'The base value of hold_time in milliseconds until when a next instance
          of the same LSA generation will be delayed. This will double each time the same
          LSA needs to be generated until it reaches the max_wait_time after which it
          will start with the base time again. When set to 0, the minimum time between
          same LSA regeneration is not increased.

          '
        required: false
        type: int
      max_wait_time:
        description: 'Maximum time until when next instance of same LSA generation will
          be delayed. When set to 0, the maximum time between same LSA regeneration is
          not increased.

          '
        required: false
        type: int
      start_time:
        description: 'The initial wait time in milliseconds after which LSAs will be generated.
          When set to 0, the LSAs are generated without any delay.

          '
        required: false
        type: int
    type: dict

other_config:
    description: Miscellaneous configuration
    required: false
    suboptions:
      default_metric:
        description: The default cost metric for the distributed routes.
        required: false
        type: int
      ospf_rfc1583_compatible:
        description: 'This determines whether RFC1583 compatibility mode is enabled or
          not. If value is false then the path preference algorithm is calculated as defined
          by RFC2328.

          '
        required: false
        type: bool
    type: dict

redistribute:
    choices:
    - connected
    - local_loopback
    - static
    - bgp
    - rip
    description: 'From where to redistribute routes from other sources into this OSPF
      instance, if the same source also has a route map based filter associated with it,
      only the filtered routes will be redistributed into this instance.

      '
    elements: str
    type: list

spf_throttle:
    description: Timers related to SPF throttling.
    required: false
    suboptions:
      hold_time:
        description: 'Exponential backoff time in milliseconds before the next SPF calculation
          can be scheduled, must be in [0, 600000].

          '
        required: false
        type: int
      max_wait_time:
        description: Maximum duration of the exponential backoff time in milliseconds
          until when an SPF calculation can be delayed, must be in [0, 600000].
        required: false
        type: int
      start_time:
        description: Initial delay in milliseconds after which an SPF calculation will
          be triggered, must be in [0, 600000].
        required: false
        type: int
    type: dict

maximum_paths:
    description: 'Maximum number of equal cost paths that are stored for each destination
      in the routing table.

      '
    required: false
    type: int

helper_disable:
    description: 'Indicates whether OSPF will help a neighbor undergoing hitless restart
      on this interface.

      '
    required: false
    type: bool

admin_router_id:
    description: 'The router identifier configured for the OSPF instance. The router ID
      MUST be unique within the entire Autonomous System. If admin_router_id is present,
      the same will be elected as active_router_id. The router ID is in IPv4 address format.

      '
    required: false
    type: str

stub_router_adv:
    description: 'Configurations related to stub router and router_lsa advertisements.

      '
    required: false
    suboptions:
      admin_set:
        description: 'This determines whether the stub router router_lsa advertisement
          is set administratively.

          '
        required: false
        type: bool
      include_stub:
        description: 'Determines whether the router should advertise maximum metric for
          stub links in router_lsa.

          '
        required: true
        type: bool
      startup:
        description: 'Determines whether the router should advertise stub router router_lsa
          on start-up. The delay, in seconds, is the duration for how long, after the
          reboot, stub router router_lsa should be advertised.

          '
        required: true
        type: int
    type: dict

auto_cost_ref_bw:
    description: 'The reference bandwidth, Mbits/second, for interface cost calculations.
      Must be in [1, 4000000].

      '
    required: false
    type: int

protocol_disable:
    description: Disable this OSPF instance
    required: false
    type: bool

restart_interval:
    description: 'If OSPF is attempting to undergo a graceful restart, this field specifies
      the length in seconds of grace period that should be requested from adjacent routers
      in grace LSAs. Must be in [5, 1800].

      '
    required: false
    type: int

active_interfaces:
    description: 'The list of the active-interfaces. If "passive_interface_default" is
      set to "false", then this list should be empty.

      '
    elements: str
    required: false
    type: list

default_originate:
    choices:
    - disable
    - originate
    - always_originate
    description: 'Criteria for redistribution of the default routes into the OSPF domain:
      disable: no default route should be advertised. originate: advertise default route
      if it exists in the routing table. always_originate: always advertise default route,
      regardless of its presence in the routing table.

      '
    required: false
    type: str

redistribute_ospf:
    description: 'Redistribute routes from other OSPF instances into this OSPF instance.
      If the same instance also has a route map based filter associated with it, only
      the filtered routes will be redistributed into this instance.

      '
    elements: str
    required: false
    type: list

passive_interfaces:
    description: 'List of passive interfaces. If "passive_interface_default" is set to
      true, then this list should be empty.

      '
    elements: str
    required: false
    type: list

gr_ignore_lost_interface:
    description: 'Specifies whether to ignore OSPF interfaces that have gone down just
      prior to the restart event.

      '
    required: false
    type: bool

strict_lsa_check_disable:
    description: 'Specifies whether strict LSA checking is disabled for this OSPF router
      instance.

      '
    required: false
    type: bool

bfd_all_interfaces_enable:
    description: Enables BFD on all interfaces involved in this OSPF Router
    required: false
    type: bool

passive_interface_default:
    description: 'This determines whether all interfaces should be set to passive by default.

      '
    required: false
    type: bool