diff --git a/connector/doc/Grass_Valley_AMPP_Manager.md b/connector/doc/Grass_Valley_AMPP_Manager.md index fee3a7d2..717b28c2 100644 --- a/connector/doc/Grass_Valley_AMPP_Manager.md +++ b/connector/doc/Grass_Valley_AMPP_Manager.md @@ -6,30 +6,18 @@ uid: Connector_help_Grass_Valley_AMPP_Manager The Grass Valley Agile Media Processing Platform (GVAMPP) connector will retrieve a list of existing workloads to be managed/configured. -## About +A smart-serial connection is needed to listen to incoming messages, and an additional two HTTP connections are needed, one for the GVAMPP and one for the SignalR Forwarder. -A smart serial connection is needed to listen to incoming messages, and an additional 2 HTTP connections are needed: one for the GVAMPP and one for the SignalR Forwarder - -### Version Info - -| Range | Description | DCF Integration | Cassandra Compliant | -|---------|-----------------|-----------------|---------------------| -| 1.0.0.x | Initial version | No | Yes | -### Product Info - -| Range | Supported Firmware Version | -|---------|----------------------------| -| 1.0.0.x | xxx | - -## Installation and configuration +## Configuration ### Connections + #### IP Connection - Main -This connector uses a smart serial connection by IP to act as listener +This connector uses a smart-serial connection by IP to act as listener. -- **IP address/host**: The polling IP or URL of the destination by default, any -- **IP port**: The IP port of the destination by default, 5001 +- **IP address/host**: The polling IP or URL of the destination (default: *any*). +- **IP port**: The IP port of the destination (default: *5001*). #### HTTP Connection - GVAMPP @@ -51,13 +39,15 @@ HTTP CONNECTION: - **IP port**: The IP port of the destination (default: *443*). - **Device address**: The bus address of the device. If the proxy server has to be bypassed, specify *BypassProxy*. -## Usage +### Web Interface -Once created, the element can be used immediately. +The web interface is only accessible when the client machine has network access to the product. + +## Usage ### General -This page contains general configuration parameters: API Key, Last Login Time, and Token Expiration. Default Token Expiration is 24 hours, but a new token will automatically be requested on API Key change and every 12 hours. +This page contains general configuration parameters: API Key, Last Login Time, and Token Expiration. Token Expiration is by default set to 24 hours, but a new token will automatically be requested whenever there is an API key change and every 12 hours. ### Application Types @@ -65,12 +55,13 @@ Here you will find the voltage the application types table. ### Workloads -Here you will find the workloads table as well as a button to refresh the workloads. Each row contains several buttons/toggle buttons: -* Get State - sends a Get State POST Command -* Disable Get State - sends a Disable Get State DELETE Command -* Start - sends a Start Workload POST Command -* Stop - sends a Stop Workload POST Command -* Refresh State on Restart - Sends a Get State command after restart of element. +Here you will find the workloads table as well as a button to refresh the workloads. Each row contains several buttons/toggle buttons: + +- **Get State**: Sends a Get State POST command. +- **Disable Get State**: Sends a Disable Get State DELETE command. +- **Start**: Sends a Start Workload POST command. +- **Stop**: Sends a Stop Workload POST command. +- **Refresh State on Restart**: Sends a Get State command after a restart of the element. ### Fabrics and Nodes @@ -79,14 +70,11 @@ Here you will find the Fabrics and Nodes tables as well as a button to refresh t ### Snapshots Here you will find the Snapshots table as well as a button to refresh the snapshots. Each row contains several buttons/toggle buttons: -* Start - sends a Start Snapshot POST Command -* Stop - sends a Stop Snapshot POST Command -* Restore Workloads After Start - restores the workload on element restart -### Debug - -This page contains the current listener message as well as the response to AMPP +- **Start**: Sends a Start Snapshot POST command. +- **Stop**: Sends a Stop Snapshot POST command. +- **Restore Workloads After Start**: Restores the workload on element restart. -### Web Inteface +### Debug -Access to the Web GUI is found here. \ No newline at end of file +This page contains the current listener message as well as the response to AMPP. diff --git a/connector/toc.yml b/connector/toc.yml index 6cf9eccb..e92b5309 100644 --- a/connector/toc.yml +++ b/connector/toc.yml @@ -4186,6 +4186,8 @@ topicUid: Connector_help_Grass_Valley_Acappella - name: Grass Valley Alchemist Live topicUid: Connector_help_Grass_Valley_Alchemist_Live + - name: Grass Valley AMPP Manager + topicUid: Connector_help_Grass_Valley_AMPP_Manager - name: Grass Valley Audio Live topicUid: Connector_help_Grass_Valley_Audio_Live - name: Grass Valley Biometrics AP