cisco.meraki.meraki_ms_ospf (2.18.0) — module

Install collection

Install with ansible-galaxy collection install cisco.meraki:==2.18.0

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 2.18.0

Description

Configure OSPF for compatible Meraki MS switches.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Query OSPF settings
    meraki_ms_ospf:
      auth_key: abc123
      org_name: YourOrg
      net_name: YourNet
      state: query
    delegate_to: localhost

Scanned by Steampunk Spotter

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

  - name: Enable OSPF with check mode
    meraki_ms_ospf:
      auth_key: abc123
      org_name: YourOrg
      net_name: YourNet
      state: present
      enabled: true
      hello_timer: 20
      dead_timer: 60
      areas:
        - area_id: 0
          area_name: Backbone
          area_type: normal
        - area_id: 1
          area_name: Office
          area_type: nssa
      md5_authentication_enabled: false

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

areas:
    description:
    - List of areas in OSPF network.
    elements: dict
    suboptions:
      area_id:
        aliases:
        - id
        description:
        - OSPF area ID
        type: int
      area_name:
        aliases:
        - name
        description:
        - Descriptive name of OSPF area.
        type: str
      area_type:
        aliases:
        - type
        choices:
        - normal
        - stub
        - nssa
        description:
        - OSPF area type.
        type: str
    type: list

state:
    choices:
    - present
    - query
    default: present
    description:
    - Read or edit OSPF settings.
    type: str

net_id:
    description:
    - ID of network containing OSPF configuration.
    type: str

org_id:
    description:
    - ID of organization.
    type: str

enabled:
    description:
    - Enable or disable OSPF on the network.
    type: bool

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

net_name:
    aliases:
    - name
    - network
    description:
    - Name of network containing OSPF configuration.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    default: false
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

dead_timer:
    description:
    - Time interval to determine when the peer will be declared inactive.
    - Value must be between 1 and 65535.
    type: int

hello_timer:
    description:
    - Time interval, in seconds, at which hello packets will be sent to OSPF neighbors
      to maintain connectivity.
    - Value must be between 1 and 255.
    - Default is 10 seconds.
    type: int

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

md5_authentication_key:
    description:
    - MD5 authentication credentials.
    suboptions:
      id:
        description:
        - MD5 authentication key index.
        - Must be between 1 and 255.
        type: str
      passphrase:
        description:
        - Plain text authentication passphrase
        type: str
    type: dict

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

md5_authentication_enabled:
    description:
    - Whether to enable or disable MD5 authentication.
    type: bool

Outputs

data:
  contains:
    areas:
      contains:
        area_id:
          description:
          - OSPF area ID
          type: int
        area_name:
          description:
          - Descriptive name of OSPF area.
          type: str
        area_type:
          description:
          - OSPF area type.
          type: str
      description:
      - List of areas in OSPF network.
      type: complex
    dead_timer_in_seconds:
      description:
      - Time interval to determine when the peer will be declared inactive.
      type: int
    enabled:
      description:
      - Enable or disable OSPF on the network.
      type: bool
    hello_timer_in_seconds:
      description:
      - Time interval, in seconds, at which hello packets will be sent to OSPF neighbors
        to maintain connectivity.
      type: int
    md5_authentication_enabled:
      description:
      - Whether to enable or disable MD5 authentication.
      type: bool
    md5_authentication_key:
      contains:
        id:
          description:
          - MD5 key index.
          type: int
        passphrase:
          description:
          - Passphrase for MD5 key.
          type: str
      description:
      - MD5 authentication credentials.
      type: complex
  description: Information about queried object.
  returned: success
  type: complex