cisco.meraki.networks_switch_routing_ospf module – Resource module for networks _switch _routing _ospf
Note
This module is part of the cisco.meraki collection (version 2.17.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.networks_switch_routing_ospf.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource networks _switch _routing _ospf.
Update layer 3 OSPF routing configuration.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
OSPF areas. |
|
OSPF area ID. |
|
Name of the OSPF area. |
|
Area types in OSPF. Must be one of “normal”, “stub”, “nssa”. |
|
Time interval to determine when the peer will be declared inactive/dead. Value must be between 1 and 65535. |
|
Boolean value to enable or disable OSPF routing. OSPF routing is disabled by default. Choices:
|
|
Time interval in seconds at which hello packet will be sent to OSPF neighbors to maintain connectivity. Value must be between 1 and 255. Default is 10 seconds. |
|
Boolean value to enable or disable MD5 authentication. MD5 authentication is disabled by default. Choices:
|
|
MD5 authentication credentials. This param is only relevant if md5AuthenticationEnabled is true. |
|
MD5 authentication key index. Key index must be between 1 to 255. |
|
MD5 authentication passphrase. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
NetworkId path parameter. Network ID. |
|
OSPF v3 configuration. |
|
OSPF v3 areas. |
|
OSPF area ID. |
|
Name of the OSPF area. |
|
Area types in OSPF. Must be one of “normal”, “stub”, “nssa”. |
|
Time interval to determine when the peer will be declared inactive/dead. Value must be between 1 and 65535. |
|
Boolean value to enable or disable V3 OSPF routing. OSPF V3 routing is disabled by default. Choices:
|
|
Time interval in seconds at which hello packet will be sent to OSPF neighbors to maintain connectivity. Value must be between 1 and 255. Default is 10 seconds. |
Notes
Note
SDK Method used are switch.Switch.update_network_switch_routing_ospf,
Paths used are put /networks/{networkId}/switch/routing/ospf,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for switch updateNetworkSwitchRoutingOspf
Complete reference of the updateNetworkSwitchRoutingOspf API.
Examples
- name: Update all
cisco.meraki.networks_switch_routing_ospf:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
areas:
- areaId: '1284392014819'
areaName: Backbone
areaType: normal
deadTimerInSeconds: 40
enabled: true
helloTimerInSeconds: 10
md5AuthenticationEnabled: true
md5AuthenticationKey:
id: 1234
passphrase: abc1234
networkId: string
v3:
areas:
- areaId: '1284392014819'
areaName: V3 Backbone
areaType: normal
deadTimerInSeconds: 40
enabled: true
helloTimerInSeconds: 10
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |