W3cubDocs

/Ansible

cisco.meraki.meraki_ms_ospf – Manage OSPF configuration on MS switches

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_ms_ospf.

Synopsis

  • Configure OSPF for compatible Meraki MS switches.

Parameters

Parameter Choices/Defaults Comments
areas
list / elements=dictionary
List of areas in OSPF network.
area_id
integer
OSPF area ID

aliases: id
area_name
string
Descriptive name of OSPF area.

aliases: name
area_type
string
    Choices:
  • normal
  • stub
  • nssa
OSPF area type.

aliases: type
auth_key
string / required
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
dead_timer
integer
Time interval to determine when the peer will be declared inactive.
Value must be between 1 and 65535.
enabled
boolean
    Choices:
  • no
  • yes
Enable or disable OSPF on the network.
hello_timer
integer
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.
host
string
Default:
"api.meraki.com"
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
internal_error_retry_time
integer
Default:
60
Number of seconds to retry if server returns an internal server error.
md5_authentication_enabled
boolean
    Choices:
  • no
  • yes
Whether to enable or disable MD5 authentication.
md5_authentication_key
dictionary
MD5 authentication credentials.
id
string
MD5 authentication key index.
Must be between 1 and 255.
passphrase
string
Plain text authentication passphrase
net_id
string
ID of network containing OSPF configuration.
net_name
string
Name of network containing OSPF configuration.

aliases: name, network
org_id
string
ID of organization.
org_name
string
Name of organization.

aliases: organization
output_format
string
    Choices:
  • snakecase ←
  • camelcase
Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).
output_level
string
    Choices:
  • debug
  • normal ←
Set amount of debug output during module execution.
rate_limit_retry_time
integer
Default:
165
Number of seconds to retry if rate limiter is triggered.
state
string
    Choices:
  • present ←
  • query
Read or edit OSPF settings.
timeout
integer
Default:
30
Time to timeout for HTTP requests.
use_https
boolean
    Choices:
  • no
  • yes ←
If no, it will use HTTP. Otherwise it will use HTTPS.
Only useful for internal Meraki developers.
use_proxy
boolean
    Choices:
  • no ←
  • yes
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether to validate HTTP certificates.

Notes

Note

  • More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
  • Some of the options are likely only used for developers within Meraki.
  • As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the ANSIBLE_MERAKI_FORMAT environment variable to camelcase.
  • Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
  • Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.

Examples

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

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

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


Authors

  • Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_ms_ospf_module.html