arubanetworks.aoscx.aoscx_ospf_area (4.3.2) — module

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 OSPF Areas on AOS-CX devices.

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Create new OSPF Area
  aoscx_ospf_area:
    vrf: default
    ospf_id: 1
    area_id: 1
    other_config:
      stub_metric_cost: 2
      stub_metric_type: metric_non_comparable

Scanned by Steampunk Spotter

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

- name: Create new OSPF Area
  aoscx_ospf_area:
    vrf: default
    ospf_id: 1
    area_id: 1.1.1.1
    area_type: nssa
    state: update

Inputs

    
vrf:
    description: 'The VRF the OSPF Area will belong to once created. If the OSPF Area
      is created and the user wants to change its VRF, the user must first delete the
      OSPF Area, and then recreate it in the desired VRF.

      '
    required: true
    type: str

state:
    choices:
    - create
    - update
    - delete
    default: create
    description: Create or update or delete the OSPF Area.
    required: false
    type: str

area_id:
    description: 'OSPF Area Identifier, in X.X.X.X form, or as a number in [0, 4294967295].

      '
    required: true
    type: str

ospf_id:
    description: The OSPF Router the Area will belong to once created
    required: true
    type: int

ipsec_ah:
    description: 'IPsec Authentication Header (AH) configuration. Specifies Security Parameters
      Index (SPI), authentication type and key to use. IPsec AH is preferred over IPsec
      Encapsulating Security Payload (ESP) if both ipsec_ah and ipsec_esp are configured.

      '
    required: false
    suboptions:
      auth_key:
        description: IPsec AH authentication key.
        required: true
        type: str
      auth_type:
        choices:
        - md5
        - sha1
        description: IPsec AH authentication algorithm.
        required: true
        type: str
      spi:
        description: 'Security Parameters Index for the Security Association (SA). AH
          SPI must be unique on a router because it is carried in IPsec protocol packet
          to enable the receiving system to select the SA to process the packet. Must
          be in [256, 4294967295].

          '
        required: true
        type: int
    type: dict

area_type:
    choices:
    - default
    - nssa
    - nssa_no_summary
    - stub
    - stub_no_summary
    default: default
    description: 'Alphanumeric option defining how the external routing and summary LSAs
      for this area will be handled.

      '
    required: false
    type: str

ipsec_esp:
    description: 'IPsec Encapsulating Security Payload (ESP) configuration. Specifies
      SPI, encryption/authentication type, and key to use. IPsec AH is preferred over
      IPsec ESP if both ipsec_ah and ipsec_esp are configured.

      '
    required: false
    suboptions:
      auth_key:
        description: IPsec ESP authentication key.
        required: true
        type: str
      auth_type:
        choices:
        - md5
        - sha1
        description: IPsec ESP authentication algorithm.
        required: true
        type: str
      encryption_key:
        description: IPsec ESP encryption key.
        required: true
        type: str
      encryption_type:
        choices:
        - des
        - 3des
        - aes
        - none
        description: IPsec ESP encryption algorithm.
        required: true
        type: str
      spi:
        description: 'Security Parameters Index for the Security Association (SA). ESP
          SPI must be unique on a router because it is carried in IPsec protocol packet
          to enable the receiving system to select the SA to process the packet. Must
          be in [256, 4294967295].

          '
        required: true
        type: int
    type: dict

no_ipsec_ah:
    description: Remove IPsec authentication AH.
    required: false
    type: bool

other_config:
    description: Extra configuration parameters for the area
    required: false
    suboptions:
      stub_default_cost:
        description: 'Cost for the default summary route sent to the stub area

          '
        type: int
      stub_metric_type:
        choices:
        - metric_standard
        - metric_comparable_cost
        - metric_non_comparable
        default: metric_non_comparable
        description: Type of metric
        type: str
    type: dict