Network Management
How to Override Meraki Orchestrator Base URI per Polling Engine When Advanced Configuration Page's Server Specific Tab Is Inaccessible
This article provides instructions for overriding the Meraki orchestrator base URI when the Server Specific tab in Advanced Configuration is inaccessible due to timeouts. This is useful for environments that have organizations hosted in different regions.
First published date
Last published date
Overview
SolarWinds Self-Hosted Platform uses api.meraki.com as the default Meraki orchestrator base URI. In some environments, Meraki organizations are hosted in alternative regional domains such as api.meraki.cn or api.meraki.ca. In these cases, the Meraki cloud hostname must be overridden to ensure successful communication between SolarWinds polling engines and the Meraki API.
Normally, this configuration is performed through Advanced Configuration using the Server Specific tab. However, access to this tab may be unavailable due to UI timeouts or performance issues.
This knowledge base article explains how to override the MerakiCloudHostname at the polling engine level by directly updating the SolarWinds Platform database.
Product section
Cause
The issue occurs because SolarWinds Network Performance Monitor (NPM) is configured to use the default Meraki orchestrator base URI (api.meraki.com) for all polling engines. In environments where the Meraki organization is hosted in a different regional Meraki cloud (for example, api.meraki.cn or api.meraki.ca), API requests are sent to an incorrect endpoint.
Resolution
Resolution:
Step 1: Verify the Orion Server ID
- Connect to the SolarWinds Platform server.
- Open Database Manager from the SolarWinds Platform folder of the start menu.
- Select Add Orion Server and expand the SQL server in bold.
- Right-click the SolarWindsOrion database and select New Query.
- Paste the SQL query below into the window on the right and select Execute query:
SELECT OrionServerID, HostName FROM OrionServers
-- Scripts are not supported under any SolarWinds support program or service.
-- Scripts are provided AS IS without warranty of any kind. SolarWinds further
-- disclaims all warranties including, without limitation, any implied warranties
-- of merchantability or of fitness for a particular purpose. The risk arising
-- out of the use or performance of the scripts and documentation stays with you.
-- In no event shall SolarWinds or anyone else involved in the creation,
-- production, or delivery of the scripts be liable for any damages whatsoever
-- (including, without limitation, damages for loss of business profits, business
-- interruption, loss of business information, or other pecuniary loss) arising
-- out of the use of or inability to use the scripts or documentation.
6. Locate the polling engine that requires the Meraki cloud hostname override and take note of its OrionServerID.
Step 2: Insert the MerakiCloudHostname Override
- Create a Backup of the Database.
- Using the OrionServerID obtained in Step 1, run the SQL query below.
- Replace <
OrionServerID> with the appropriate value. - Replace
<api.meraki.com>with the correct Meraki API endpoint if your organization uses a different regional domain (for example,api.meraki.cnorapi.meraki.ca).
- Replace <
Insert INTO SettingOverride VALUES('Orchestrators.Meraki.MerakiCloudHostname',<OrionServerID>,'<api.meraki.com>')
-- Scripts are not supported under any SolarWinds support program or service.
-- Scripts are provided AS IS without warranty of any kind. SolarWinds further
-- disclaims all warranties including, without limitation, any implied warranties
-- of merchantability or of fitness for a particular purpose. The risk arising
-- out of the use or performance of the scripts and documentation stays with you.
-- In no event shall SolarWinds or anyone else involved in the creation,
-- production, or delivery of the scripts be liable for any damages whatsoever
-- (including, without limitation, damages for loss of business profits, business
-- interruption, loss of business information, or other pecuniary loss) arising
-- out of the use of or inability to use the scripts or documentation.
- Disable HA Pool if you have any.
- Restart all services on the Polling Engine