Grass Valley AMPP Core Integration Configuration
Caution
Compatibility Note: This information is a general guide and may be incomplete, may not match a specific project implementation, and is subject to change as supported products and versions evolve. Confirm the exact implementation and requirements for each project with Riedel and the relevant equipment vendor, then validate the required functions end to end in the target environment before deployment.
Configuration Overview
hi connects to the AMPP platform with an API key, controls only the fabrics you select, and can exchange names with AMPP aliases.
|
Configuration |
What hi Sees |
Use When |
|---|---|---|
|
Platform Connection |
The selected AMPP fabrics, Nodes, workloads, Sources, and Destinations. |
You set up the integration for the first time. |
|
Alias Synchronization |
hi Primary Names matched to AMPP aliases. |
You align names between hi and AMPP. |
Caution
Write Aliases changes names in the AMPP platform. Confirm alias ownership before using it on a production deployment.
Before You Begin
-
Use Node admin and open Inventory > Nodes. See Manage Nodes.
-
Confirm the license and hi version in Required Configuration.
-
Confirm the network access in Network Requirements.
-
Have access to AMPP identity management to create an API key.
Configure Platform Connection
Use this configuration to connect hi to AMPP and select fabrics.
Device Configuration
-
In AMPP identity management, create an API key with the permissions that the selected fabrics and routing operations need. Allow the API key the
platform,cluster.readonly, andclusterscopes. hi requests these scopes when it signs in. See the Grass Valley documentation.-
Select the Add new client button at the top right.
-
Enter a unique Name. Location and Type help you trace the key later.
-
Set Grant type to
ClientCredentials. -
In Allowed scopes, select
platform,cluster.readonly, andcluster, and then select Ok.
-
-
Store the API key that the pop-up shows. Do not share it or include it in screenshots. To withdraw the key, remove the client. To regenerate it, right-click the client in the list.
-
Confirm that the platform URL and the AMPP APIs that hi uses are reachable from the hi server.
hi Configuration
-
Add the GV AMPP Core Integration in Inventory. Only one GV AMPP Core Integration Node can exist in a system.
-
Enter the platform URL and the key in Api Key.
-
Create the Node and wait for it to initialize.
-
In Fabrics, select only the AMPP fabrics that hi should control. The list is populated after the connection is established.
-
Confirm that the expected Nodes, workloads, Sources, and Destinations appear before you use Write Aliases.
Settings Summary
|
Setting |
Device Side |
hi Side |
|---|---|---|
|
Access |
API key from AMPP identity management |
Api Key |
|
Scope |
Fabrics available to the key |
Fabrics |
Configure Alias Synchronization
Use this configuration to align names. All three actions are buttons in the Labels group of the Node.
Device Configuration
-
Decide which system owns the names and review the existing AMPP aliases.
hi Configuration
-
To take AMPP names into hi, select Read Aliases. This reads all aliases from AMPP and sets them as Primary Names.
-
To send hi names to AMPP, select Write Aliases. This writes the Primary Names as aliases to AMPP.
-
To discard local names, select Reset Primary Name. This reads all names from AMPP and sets them as Primary Names.
Common Checks
|
Symptom |
Check |
|---|---|
|
Fabrics offers no choices. |
Confirm that the integration is connected, and that the API key and platform URL are valid and permitted. |
|
Expected resources are missing. |
Confirm that the fabrics are selected and that the key has the needed permissions. |
Verify the Configuration
Confirm that the selected fabrics, Nodes, Sources, and Destinations appear in hi. Route one test connection and confirm that the route state updates through AMPP notifications.