diff --git a/connector/doc/Advantech_ADAM6050_SNMP.md b/connector/doc/Advantech_ADAM6050_SNMP.md new file mode 100644 index 00000000..c2c800fa --- /dev/null +++ b/connector/doc/Advantech_ADAM6050_SNMP.md @@ -0,0 +1,48 @@ +--- +uid: Connector_help_Advantech_ADAM6050_SNMP +--- + +# Advantech ADAM6050 SNMP + +The Advantech ADAM6050 SNMP connector enables monitoring and management of digital and analog inputs and outputs from Advantech ADAM6050 devices. By leveraging SNMP, the connector provides real-time data access, facilitating efficient monitoring and control within the DataMiner platform. + +## About + +### Version Info + +| Range | Features | Based on | System Impact | +|--------------------|-----------------|----------|---------------| +| 1.0.0.x [SLC Main] | Initial version | - | - | + +### Product Info + +| Range | Supported Firmware | +|-------------|---------------------| +| 1.0.0.x | - | + +### System Info + +| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components | +|-------------|-----------------|---------------------|-------------------|----------------------| +| 1.0.0.x | No | Yes | - | - | + +## Configuration + +### Connections + +#### SNMP Connection + +This connector uses an SNMP connection to communicate with the Advantech ADAM6050 device. During element creation, configure the following SNMP settings: + +- **IP address/host**: The polling IP or URL of the destination. +- **IP port**: The IP port of the destination. +- **Get community string**: Community string for reading device values (default: *public*). +- **Set community string**: Community string for writing values to the device (default: *private*). + +### Web Interface + +The web interface is accessible when the client machine has network access to the device. + +## How to use + +When an element has been created with this connector, you will be able to monitor and control input and output values for the Advantech ADAM6050 device in real time. The connector will retrieve device data over SNMP and display it in DataMiner, allowing you to manage device statuses effectively. diff --git a/connector/doc/Appear_X_Platform.md b/connector/doc/Appear_X_Platform.md new file mode 100644 index 00000000..d07e77f2 --- /dev/null +++ b/connector/doc/Appear_X_Platform.md @@ -0,0 +1,333 @@ +--- +uid: Connector_help_Appear_X_Platform +--- + +# Appear X Platform + +The Appear X Platform connector allows users to configure and display information from the Appear X10/X20 chassis and its associated module cards. + +> [!NOTE] +> This connector is the successor of the **AppearTV X20 platform** connector, which will be gradually phased out and will eventually become deprecated. For new greenfield deployments, we strongly recommend using this **Appear X platform** connector instead. + +On the U.S. market, the same chassis is also offered under the Sencore brand, with the following model names: **Sencore DMG-3200** (X10 chassis), **Sencore DMG-4100**, and **Sencore DMG-4200** (X20 chassis). + +The connector establishes an **HTTP connection**, utilizing the MMI, IpGateway, XGER, ASI, SDI APIs, and Prometheus endpoints to retrieve and configure device data. Information is exchanged in JSON format. + +The connector operates sequentially, requesting data from the device, processing responses, and displaying the results. Users can send configuration requests and receive updated information in real-time. + +## About + +### Version Info + +| Range | Features | Based on | System Impact | +|--------------------|------------------|----------|---------------| +| 1.0.0.x [SLC Main] | Initial version. | - | - | + +### Product Info + +#### Range 1.0.0.x + +| Card Type | Supported (Card) Firmware | API Version | Supported System Release | +|-----------------------------|---------------------------|----------------------|--------------------------| +| IP Switch Control (SWx) | SW 3.10 | MMI API 4.1+ | SR 5 | +| IP I/O (SWx) | SW 3.22 | IP Gateway API 1.31+ | SR 7 | +| IP I/O (IPx) | SW 3.22 | IP Gateway API 1.31+ | SR 7 | +| SRT (IPx) | SW 1.12 | IP Gateway API 1.31+ | SR 10 | +| IP 2022 Coder (ECx) | SW 3.12 | XGER API 2.40+ | SR 7 | +| IP 2110 Coder (ECx) | SW 1.16 | XGER API 2.40+ | SR 7 | +| SDI Decoder (ECx) | SW 6.2 | XGER API 2.40+ | SR 8 | +| SDI Encoder (ECx) | SW 5.24 | XGER API 2.40+ | SR 7 | +| SDI Transcoder (ECx) | SW 2.2 | XGER API 2.40+ | SR 8 | +| SDI I/O (SIx) | SW 2.14 | SDI API 2.17+ | SR 7 | +| IP JPEG XS TS Encoder (IPx) | SW 1.8 | HipEnc API 1.2+ | SR 8 | +| IP JPEG XS TS Decoder (IPx) | SW 1.10 | HipDec API 1.3+ | SR 9 | +| ASI I/O (SIx) | SW 2.14 | ASI API 1.17+ | SR 7 | +| DVB-S/2/X (SRx) | SW 2.12 | S2XIn API 2.40+ | SR 7 | +| DVB-S/2/X (SMx) | SW 3.22 | S2XOut API 2.40+ | SR 7 | +| Scrambler (CAx) | SW 2.6 | API 1.5+ | SR 7 | +| Descrambler (DSx) | SW 2.4 | Descr API 1.1+ | SR 7 | + +### System Info + +| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components | +|---------|-----------------|---------------------|-------------------|---------------------| +| 1.0.0.x | Yes | Yes | - | - | + +## Configuration + +### Connections + +#### HTTP Connection + +This connector uses an HTTP connection and requires the following input during element creation: + +HTTP CONNECTION: + +- **IP address/host**: The polling IP or URL of the destination. +- **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*. + +### Initialization + +#### API Login Credentials + +When you have created an element with this connector , navigate to the **General** > **Authentication** data page of the element, and specify the API account (username and password) that the element needs to use to gain authenticated API access. + +> [!IMPORTANT] +> Only after a successful API login, will the element be able to establish proper communication with the Appear X platform API. + +#### Configurable API Versions + +It is possible to configure a specific API version for each card type. To do so, go to the **General** > **Module Config** page. + +Increasing the API version will result in extra data being filled in if that API version is supported on the chassis. + +### Redundancy + +When the Appear Chassis is configured with 2 MMI boards, the device is able to present the APIs DataMiner is consuming on IP interfaces of both MMI boards. This will allow DataMiner to implement API-level redundancy. It will automatically switch over to the secondary IP interface if it detects that the first one becomes unavailable or unresponsive. + +To set up this API-level redundancy, go to the **General** > **Redundancy** page of an active Appear X platform element + +### Configurable API Polling + +To tailor the API requests issued by DataMiner towards the Appear X platform API, go to the data page **General** \> **Poll Manager**. You can enable or disable specific API endpoints as well as set a different polling frequency. + +### DCF Connections + +#### External Connections + +- **[IP Physical Ports]** connection property of type **[inout]**. +- **[IP Coder Interfaces]** connection property of type **[inout]**. +- **[IP JPEG XS Interfaces]** connection property of type **[inout]**. +- **[ASI Input Ports]** connection property of type **[in]**. +- **[ASI Output Ports]** connection property of type **[out]**. +- **[SDI Input Ports]** connection property of type **[in]**. +- **[SDI Output Ports]** connection property of type **[out]**. +- **[S2X Input Ports]** connection property of type **[in]**. +- **[S2X Output Ports]** connection property of type **[out]**. + + + +## How to use + +### General + +This page displays the **Chassis Cards Table**, which contains one row per card in the chassis, detailing **Serial**, **Name**, **Hardware**, **Software**, **Slot**, **Features**, **Licenses**, and **State** information. + +The following page buttons are available: + +- **Authentication**: Displays the current authentication status and allows you to specify a **Username** and **Password** to connect to the device. +- **Redundancy**: The chassis can have two management boards with two separate IP addresses to communicate with. On this subpage, you can specify the redundant IP address and port to be polled for the second gateway in case the first IP gateway goes into timeout. If a redundant IP is configured, the connector will try and switch to this address if a timeout occurs. +- **Module Config**: On this subpage, you can select the implemented API version per card. Increasing the API version for a card will result in extra data being retrieved from the device. For compatibility reasons, the lower API version can be selected to ensure a functional connector in case you are not running a higher API version yet. + +### Alarms + +This page displays two tables, the **Active Alarms Table** and **Alarms History Table**. These contain information regarding the alarm **Name**, **Severity**, **Time Set** and, for cleared alarms in the history table, **Time Clear**. + +### Web Interface + +The web interface page is only accessible when the client machine hosting the DataMiner Cube application has network access to the device web GUI. + +### Backplane Media + +This page displays the **Flow Sources Table**, with information about the service **ID**, **Name**, **Bitrate** status, **CC Errors**, **RTP Errors**, and **Slot** of the flow source. + +> [!NOTE] +> All parameters within the connector that are named "Source" or "Source Selection" use display key references to this Flow Sources Table. To create or edit items, look up the correct flow source within this table and provide the display key as input. + +### Output Service Config + +This page displays the content of all outputs configured with the chassis. Currently supported types: **IP**, **SRT**, **Modulator**. + +To add a **new service** to an existing output, go to the **Add Output Content** subpage. + +To **replace the existing content** of an output, edit the **Source** parameter [1705] within the **Output Contents** table. This action is the same as the **Replace Content** action from the web interface. + +You can also configure and manage the following output-related content through the right-click menu: + +- PID component filtering +- Component generation +- Extra PMT descriptors + +### Output Redundancy Config + +This page allows you to manage the redundancy settings per output or output Service. Currently supported types: **IP**, **SRT**, **Modulator**. + +The **Redundancy Settings** table contains details on which source is currently active and when or how to switch to the backup. The **Redundant Sources** table contains the configured backups per output. + +Adding a new backup to an existing output or output service can be done via **Add Input Backup Source**. + +### Output Mapping Config + +This page allows you to add extra PID mapping to existing outputs via the right-click menu. Currently supported types: **IP**, **SRT**, **Modulator**. + +### IP Ports + +This page contains two tables with information about **physical and virtual ports**. + +Several subpages are available with information on the IP interfaces connected to the ports: + +- IP Interfaces +- IP Coder Interfaces (IP 2022/IP 2110) +- IP JPEG XS Interfaces + +### ASI Ports + +This page contains an overview of all ASI ports, indicating for each port whether it is configured as **input** or **output**. You can also adjust this configuration in the table. + +### SDI Ports + +This page contains the **Cards Info Table**, **SDI IO Physical Ports Table**, and **Status Table**. + +### S2X Ports + +This page allows you to manage the number of demodulators per port and tune the port according to the **LNB Frequency**, **LNB DC Voltage**, and **LNB 22KHz Tone**. + +### IP Inputs + +This page displays the **IP Inputs Table**, with configurable information related to the IP inputs. + +Via the **Add Input** page button, you can add a new input to the selected IP switch card. To do so, you must specify the **Label**, **Type** (*Single* or *Seamless*), **Analyze Mode** (*DVB*, *MPEG*, or *RTP*), **Slot**, and **Interface ID**, **IP**, and **Port** for the selected type. + +### IP Outputs + +This page displays the **IP Outputs Table**, with configurable information related to the IP outputs. + +Via the **Add Output** page button, you can add a new output to the selected IP switch card. To do so, you must specify the **Label**, **Type** (*Single* or *Cloned*), **Service**, **Slot**, and **Interface ID**, **IP** and **Port** for the selected type. + +### IP Output TS Status + +This page lists all IP outputs with their respective **effective bitrates**. + +Per output, the list of services with their outgoing configurations is shown, and per output/service, the list of PIDs with their outgoing configuration, bitrate, and CC errors is shown. + +### SRT Inputs + +This page displays the **SRT Inputs Table**, with configurable information related to the SRT inputs. You can view the Input Status, with the **Bitrate**, and **Socket State**. + +> [!NOTE] +> The status information is only available through the Prometheus API endpoint on the chassis. To verify if the Prometheus setting has been enabled, go to the **General** > **Module Overview Config** page. + +### SRT Outputs + +This page displays the **SRT Outputs Table**, with configurable information related to the SRT inputs. + +### SRT Output TS Status + +For each output, you can see the Output Status, with the **Bitrate** and **Socket State**, as well as a list of services with their outgoing configurations. + +In addition, per output/service, the list of PIDs with their outgoing configuration, bitrate, and CC errors is shown. + +> [!NOTE] +> The status information is only available through the Prometheus API endpoint on the chassis. To verify if the Prometheus setting has been enabled, go to the **General** > **Module Overview Config** page. + +### Encoder Services + +This page contains the **Encoder Services**, **Audio Encoder Services**, and **VANC Services** tables. The Audio Encoder Services table links the data with encoder services and audio profiles. The VANC Services table links the data with encoder services and VANC profiles. + +The page contains the page buttons **Add IP/SDI Encoder Service**, **Add IP/SDI Audio Encoder Services**, and **Add IP/SDI VANC Services**, which can be used to add new entries to the tables. + +The **IP/SDI Options** are applicable for the different card types, IP (ECx210) and SDI (ECx100). To delete one or more table entries, use the right-click menu. + +### Encoder Services - Overview + +This page contains a tree control for the **Encoder Services** and **Audio Encoder Services** per encoder service. + +### Decoder Services + +This page contains the **Decoder Services** and **Audio Decoder Services** tables. + +The page contains two page buttons, **Add Decoder Service** and **Add Audio Decoder Services**, which can be used to add new entries to the tables. + +To delete one or more table entries, use the right-click menu. + +### Decoder Services - Overview + +This page contains a tree control for the **Decoder Services** and **Audio Decoder Services** per decoder service. + +### Input Profiles + +This page contains the **Input Profiles** table. Via the **Add Input Profile** page button, you can add new entries to this table. + +To delete one or more table entries, use the right-click menu. + +### Output Profiles + +This page contains the **Output Profiles** table. Via the **Add Output Profile** page button, you can add new entries to this table. + +To delete one or more table entries, use the right-click menu. + +### Video Profiles + +This page contains the **Video Profiles** table. Via the **Add Video Profile** page button, you can add new entries to this table. + +To delete one or more table entries, use the right-click menu. + +### Audio Profiles + +This page contains the **Audio Profiles** table. Via the **Add Audio Profile** page button, you can add new entries to this table. + +To delete one or more table entries, use the right-click menu. + +### VANC Profiles + +This page contains the **VANC Profiles**, **VANC Services**, and **Teletext Pages** tables. The VANC Services table links data with encoder services and VANC profiles. + +For each of the tables, a page button is available that allows you to add more entries to the table. + +To delete one or more table entries, use the right-click menu. + +### Color Profiles + +This page contains the **Color Profiles** table. Via the **Add Color Profile** page button, you can add new entries to the table. + +To delete one or more table entries, use the right-click menu. + +### Multi Services + +This page displays two tables. + +- The **Multi Services** table lists the current services with detailed information, including the current profile used by each service. +- The **Service Profiles** table contains all the data about the profiles. For each profile, the audio and video resolution are displayed. + +> [!NOTE] +> To retrieve the information on this page, an **additional external DLL** is required. This DLL must be added **in the ProtocolScripts folder**. + +### ASI I/O + +This page contains the **ASI Input** and **ASI Output Table**. + +> [!NOTE] +> To configure the contents of the ASI Output, refer to the [Output Service Config](#output-service-config), [Output Redundancy Config](#output-redundancy-config), and [Output Mapping Config](#output-mapping-config) pages. + +### S2X Input + +This section contains an overview of all demodulators with their configuration (Port, Frequency, Symbol Rate, State, etc.) as well as status information (Lock, Bitrate, etc.). + +More detailed information on the contents received from the tuned demodulators is available on the following pages: + +- S2X Input Descrambling +- S2X Input Services + +### S2X Output + +This page contains an overview of the **S2X Ports**, related **Port Profiles** and **Modulators**. + +Status data per port is available in the **S2X OUT Physical Port Status** Table. + +### Scrambler + +Here you can find an overview of all **Conditional Access Groups** and configured **Scrambled Services** available per slot. + +### Descrambler + +Here you can find an overview of all **descrambled services**. You can manage or add descrambled services using the **Flow Descrambling** section on this page. + +### Flow Engineering + +This page contains reserved tables for integration with the Flow Engineering solution. diff --git a/connector/doc/Asentria_SiteBoss_360.md b/connector/doc/Asentria_SiteBoss_360.md new file mode 100644 index 00000000..7212b1c3 --- /dev/null +++ b/connector/doc/Asentria_SiteBoss_360.md @@ -0,0 +1,58 @@ +--- +uid: Connector_help_Asentria_SiteBoss_360 +--- + +# Asentria SiteBoss 360 + +This connector allows you to monitor general parameters (e.g. system uptime, location, tech support details, etc.) as well as input and output interfaces such as contacts, relays, sensors, and analog inputs. + +## About + +### Version Info + +| Range | Features | Based on | System Impact | +|--------------------|-----------------------------------|----------|---------------| +| 1.0.0.x [SLC Main] | - SNMP monitoring
- SNMP traps | - | - | + +### Product Info + +| Range | Supported Firmware | +|---------|--------------------| +| 1.0.0.x | - | + +### System Info + +| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components | +|---------|-----------------|---------------------|-------------------|---------------------| +| 1.0.0.x | No | Yes | - | - | + +## Configuration + +### Connections + +#### SNMP Connection + +This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation: + +SNMP CONNECTION: + +- **IP address/host**: The polling IP or URL of the destination. +- **IP port**: The IP port of the destination (default: *161*). +- **Bus address**: The bus address of the device. + +SNMP Settings: + +- **Get community string**: The community string used when reading values from the device (default: *public*). +- **Set community string**: The community string used when setting values on the device (default: *private*). + +## How to use + +The connector is divided in three main parts: + +- A single **General** page with standard device information. +- Several pages with information regarding data traffic: **Interface**, **Ports**, and **Ethernet**. +- The specific device functions, such as the **power**, **battery**, and **event sensor** information + +All tables are polled over SNMP. + +For event sensor information, information is updated whenever traps are received to ensure accurate alarm monitoring. diff --git a/connector/doc/Aviat_Networks_Provision.md b/connector/doc/Aviat_Networks_Provision.md index 87abc860..48f12711 100644 --- a/connector/doc/Aviat_Networks_Provision.md +++ b/connector/doc/Aviat_Networks_Provision.md @@ -24,6 +24,7 @@ In addition, the connector offers several possibilities for **alarm monitoring** | 1.0.0.x | Initial version | No | Yes | | 1.0.1.x | Adaptation to new SoW | No | Yes | | 1.0.2.x | Primary key is based on rowkey from change request | No | Yes | +| 2.0.0.x | EPM compatible | No | Yes | ### Product Info @@ -32,18 +33,19 @@ In addition, the connector offers several possibilities for **alarm monitoring** | 1.0.0.x | 6.10 | | 1.0.1.x | 6.10 | | 1.0.2.x | | +| 2.0.0.x | 6.10 | -### Exported connectors +### Exported connectors - Range 1.0.2.x -| Exported Connector | Description | -|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Exported Connector | Description | +|--|--| | Aviat Networks Provision - Device | Alarms of each device connected to the Aviat Networks Provision. A table with information related to the alarm (event ID, severity, location, etc.) is displayed. | -## Installation and configuration +## Configuration -### Creation +### Connections -#### SNMP Trap Input connection +#### SNMP Connection - Trap Input This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation: @@ -60,13 +62,13 @@ SNMP Settings: ## Usage (1.0.0.1) -### Traps +### Traps Page SNMP traps received from the EMS are displayed in the **Traps Table**. The **Number of Traps** parameter displays how many rows are available in this table. You can remove specific rows by clicking the **Delete Trap** button (available in the last column of the table). Additional configuration is available on the **Configuration page** (see below). -### Known IP Addresses +### Known IP Addresses Page This page displays the **Devices Table**, which contains an overview of all the devices known by the connector. Note that every incoming trap has a source IP (see below) and this source IP address is used to match the trap to a specific device. Only traps with a source IP address known by the connector will be processed; any other traps will be discarded. @@ -78,7 +80,7 @@ The **Number of Known IP Addresses** parameter at the top of this page displays To manage the devices further, e.g. to delete multiple devices or create or delete all DVEs at once, refer to the Configuration page (see below). -### Configuration +### Configuration Page This page consists of several sections, corresponding to different aspects of the configuration. @@ -119,7 +121,7 @@ Please note the following: This section also contains the **DVE Table** page button, which opens a subpage with a table that displays all DVEs created by the connector. The last column of this table contains a **Delete DVE** button, which can be used to erase DVEs one by one. -### Debug +### Debug Page This page displays the **Deleted Traps Table**, which lists the stored deleted traps, ordered from young to old. Above the table, the **Number of Deleted Traps** parameter indicates the number of rows in the table. For more information on how to further manage the traps, delete multiple traps or configure the processing, refer to the **Configuration page**. @@ -134,21 +136,21 @@ This page displays the **Deleted Traps Table**, which lists the stored deleted t ## Usage (1.0.1.1) -### Traps +### Traps Page On this page, the **NorthBound Status** parameter will display an error if the Northbound Status Trap (heartbeat) is not received in time, i.e. within the heartbeat interval, which has to be the same as the value set in the **Heartbeat Time Interval** parameter. The **display key** of the traps table is obtained by concatenating the **Service ID** and **Event Name** column parameters. -### Known IP Addresses +### Known IP Addresses Page In last column of the Device Table, **Create DVE**, you can enable or disable the creation of a single Dynamic Virtual Element (DVE). If DVE creation is enabled, a new element with the same name as the Device Name will appear in the Surveyor in the view that corresponds to the Site Name. -### Service +### Service Page This page displays the **Service Table**. Each entry in this table represents a known **Service ID**, which is linked to the respective Device Name. The page also displays the **DAC/Port** parameter, as the concatenation of these three parameters is used as the **Index** of the table. -### Configuration +### Configuration Page This page consists of several sections, corresponding to different aspects of the configuration. @@ -169,8 +171,22 @@ If a provision file is imported and a mismatch is detected between one of the en ## Usage (1.0.2.1) -### Traps +### Traps Page On this page, the **NorthBound Status** parameter will display an error if the Northbound Status Trap (heartbeat) is not received in time, i.e. within the heartbeat interval, which has to be the same as the value set in the **Heartbeat Time Interval** parameter. The **primary key** of the traps table is obtained by concatenating the **Service ID** and **Event Name** column parameters. + +## Usage (2.0.0.X) + +### Configuration Page + +This page contains the following parameters: + +- **Entity Import Directory**: Directory where the element will import the devices information from EPM. + +- **Entity Export Directory**: Directory from which the element will export the devices inventory information to EPM. + +- **System Username**: Username used to retrieve files from a remote directory. + +- **System Password**: Password used to retrieve files from a remote directory. diff --git a/connector/doc/Cisco_CBR-8.md b/connector/doc/Cisco_CBR-8.md index a72d638c..ab3d02d2 100644 --- a/connector/doc/Cisco_CBR-8.md +++ b/connector/doc/Cisco_CBR-8.md @@ -16,13 +16,13 @@ The connector uses regular timers that trigger every 60 and 120 seconds, as well | Range | Description | DCF Integration | Cassandra Compliant | |--|--|--|--| -| 1.0.1.x | Initial version. | No | No | -| 1.0.2.x | Implemented changes on the Physical Upstream Channel Table and Upstream Bounding table. | No | No | -| 1.0.3.x | Index of the Measurement Upstream Channel table changed to the instance of the channel. | No | Yes | -| 1.0.4.x | DCF feature added. | Yes | Yes | -| 2.0.0.x | Connector review. Added CCAP parameters. | No | Yes | +| 1.0.1.x [Deprecated] | Initial version. | No | No | +| 1.0.2.x [Deprecated] | Implemented changes on the Physical Upstream Channel Table and Upstream Bounding table. | No | No | +| 1.0.3.x [Deprecated] | Index of the Measurement Upstream Channel table changed to the instance of the channel. | No | Yes | +| 1.0.4.x [DCF] | DCF feature added. | Yes | Yes | +| 2.0.0.x [Deprecated] | Connector review. Added CCAP parameters. | No | Yes | | 2.0.1.x [SLC Main] | Split up MPEG table into 4 tables because of possibility of multiple programs per transport stream. | No | Yes | -| 3.0.0.x | Customer specific branch. | No | Yes | +| 3.0.0.x [Deprecated] | Customer-specific branch. | No | Yes | ### Product Info diff --git a/connector/doc/EVS_Neuron_NAP_-_COMPRESS.md b/connector/doc/EVS_Neuron_NAP_-_COMPRESS.md index 1234bf74..ba2d4be6 100644 --- a/connector/doc/EVS_Neuron_NAP_-_COMPRESS.md +++ b/connector/doc/EVS_Neuron_NAP_-_COMPRESS.md @@ -10,21 +10,24 @@ This connector is intended to be used with the Neuron COMPRESS, which provides t ### Version Info -| Range | Key Features | Based on | System Impact | -|----------------------|------------------|--------------|-------------------| -| 1.0.0.x [SLC Main] | Initial version. | - | - | +| Range | Key Features | Based on | System Impact | +|----------------------|------------------|--------------|----------------------------------------------------------| +| 1.0.0.x | Initial version. | - | - | +| 1.1.0.x [SLC Main] | Support v5.9.1 | 1.0.0.2 | Possible impact on alarms, trending, and Visual Overview | ### Product Info | Range | Supported Firmware | |-----------|------------------------| | 1.0.0.x | 5.0.0 | +| 1.1.0.x | 5.9.1 | ### System Info | Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components | |-----------|---------------------|-------------------------|-----------------------|-------------------------| | 1.0.0.x | No | Yes | - | - | +| 1.1.0.x | No | Yes | - | - | ## Configuration diff --git a/connector/doc/Harmonic_Proview_PVR8130.md b/connector/doc/Harmonic_Proview_PVR8130.md index b3e2c446..7b819c8e 100644 --- a/connector/doc/Harmonic_Proview_PVR8130.md +++ b/connector/doc/Harmonic_Proview_PVR8130.md @@ -15,7 +15,7 @@ The connector is used to control and monitor the Harmonic Proview PVR8000. | **Range** | **Description** | **DCF Integration** | **Cassandra Compliant** | |----------------------|------------------------------------------------------------------|---------------------|-------------------------| | 1.0.0.x | Initial version. | No | Yes | -| 1.0.1.x [SLC Main] | Combine DVB-S2 port receiver and carrier parameters into a table | No | Yes | +| 1.0.1.x [SLC Main] | Combine DVB-S2 port receiver and carrier parameters into a table | Yes | Yes | ### Product Info diff --git a/connector/doc/Harmonic_RD9000_Decoder.md b/connector/doc/Harmonic_RD9000_Decoder.md index 98957ceb..123c6800 100644 --- a/connector/doc/Harmonic_RD9000_Decoder.md +++ b/connector/doc/Harmonic_RD9000_Decoder.md @@ -12,10 +12,10 @@ This SNMP connector contains different tables that allow the user to monitor and ### Version Info -| Range | Key Features | Based on | System Impact | -|--------------------|--------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------| -| 1.0.0.x | - Monitoring.
- Configuration of both inputs and outputs. | - | - | -| 1.0.1.x [SLC Main] | - Renamed "Primary SRC" to "Primary Source" (same change applied to "Backup SRC").
- Updated "Ts Bitrate" from bps to Mbps.
- Modified "Ts Sync" from "Lock Locked" to "Locked" and from "Lock Unlock" to "Unlock".
- Made "Primary Source" a dropdown, dependent on the "Label" column in the "Input Source" table.
- Updated display keys in the "Input Source" and "MPEG IP Receive" tables. | 1.0.0.4 | Display key updates and parameter name/value changes. | +| Range | Key Features | Based on | System Impact | +|--------------------|------------------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------| +| 1.0.0.x | - Monitoring.
- Configuration of both inputs and outputs. | - | - | +| 1.0.1.x [SLC Main] | - Renamed "Primary SRC" to "Primary Source" (same change applied to "Backup SRC").
- Updated "Ts Bitrate" from bps to Mbps.
- Modified "Ts Sync" from "Lock Locked" to "Locked" and from "Lock Unlock" to "Unlock".
- Made "Primary Source" a dropdown box, dependent on the "Label" column in the "Input Source" table.
- Updated display keys in the "Input Source" and "MPEG IP Receive" tables.
- DCF interfaces added. | 1.0.0.4 | Display key updates and parameter name/value changes. | ### Product Info @@ -29,7 +29,7 @@ This SNMP connector contains different tables that allow the user to monitor and | Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components | |-----------|---------------------|-------------------------|-----------------------|-------------------------| | 1.0.0.x | No | Yes | - | - | -| 1.0.1.x | No | Yes | - | - | +| 1.0.1.x | Yes | Yes | - | - | ## Configuration diff --git a/connector/doc/Icinga_2.md b/connector/doc/Icinga_Icinga_2.md similarity index 97% rename from connector/doc/Icinga_2.md rename to connector/doc/Icinga_Icinga_2.md index 8e11703f..3d79cd93 100644 --- a/connector/doc/Icinga_2.md +++ b/connector/doc/Icinga_Icinga_2.md @@ -1,5 +1,5 @@ --- -uid: Connector_help_Icinga_2 +uid: Connector_help_Icinga_Icinga_2 --- # Icinga 2 diff --git a/connector/doc/Infoblox_NIOS_Platform.md b/connector/doc/Infoblox_NIOS_Platform.md index 40f6d828..06a9fa62 100644 --- a/connector/doc/Infoblox_NIOS_Platform.md +++ b/connector/doc/Infoblox_NIOS_Platform.md @@ -67,3 +67,19 @@ The Infoblox NIOS Platform connector uses both SNMP and HTTP connections to gath The HTTP connection provides access to important KPIs related to networks, members, and nodes, such as high-availability status and utilization metrics. The connector also allows users to verify the license validity for the platform. + +### Single Range Switching + +In the **Network Ranges** table, you can switch a specific range to a different member. This is done through the **Member Name** column, which shows the currently active member for each range. Clicking on a member's name will open a dropdown list with all available members. To complete the switch, you only need to select a new member from the list. + +### Bulk Range Switching + +You can switch multiple ranges in bulk via the **Switch** subpage of the **Network Ranges** page. + +On this subpage, select an **Active Member** and a **Switch Member** from their respective dropdown lists, which display all available members. + +Once you click the **Switch** button, all ranges currently assigned to the selected **Active Member** will be reassigned to the specified **Switch Member**. + +### Default Switching + +You can reset all ranges to their default member, as listed in the **IBX DHCP Member** column of the **Network Ranges** table. To do this, navigate to the **Switch** subpage of the **Network Ranges** page and click the **Switch Default** button. diff --git a/connector/doc/Meinberg_LANTIME_IMS-LSG_API_V17.md b/connector/doc/Meinberg_LANTIME_IMS-LSG_API_V17.md new file mode 100644 index 00000000..b8da2c3e --- /dev/null +++ b/connector/doc/Meinberg_LANTIME_IMS-LSG_API_V17.md @@ -0,0 +1,94 @@ +--- +uid: Connector_help_Meinberg_LANTIME_IMS-LSG_API_V17 +--- + +# Meinberg LANTIME IMS-LSG API V17 + +The **LSG** (Line Signal Generator) generates different reference signals (Clock/BITS) derived from the GNSS-locked master oscillator of a preconnected satellite receiver, which means that the module maintains high precision by synchronizing with global navigation satellite systems (like GPS). + +## About + +### Version Info + +| Range | Key Features | Based On | System Impact | +|--------------------|------------------|----------|-------------------------------------------------------------| +| 1.0.0.x [SLC Main] | Initial version. | - | Minimum required DataMiner version is **10.2.0.0 - 12603**. | + +### Product Info + +| Range | Supported Firmware | REST API Version | Supported Types | +|---------|--------------------|------------------|-----------------| +| 1.0.0.x | 7.08.x | 17.x.y | LSG180 | + +### System Info + +| Range | DCF Integration | Cassandra Compliant | Linked Components | +|--|--|--|--|--| +| 1.0.0.x | Yes | Yes | DataMiner connector:
- [Meinberg LANTIME Modular API V10](xref:Connector_help_Meinberg_LANTIME_Modular_API_V10) | + +## Configuration + +### Connections + +#### HTTP Main Connection + +This connector uses an HTTP connection and requires the following input during element creation: + +HTTP CONNECTION: + +- **IP address/host**: The polling IP or URL of the destination. +- **IP port**: The IP port of the destination. +- **Bus address**: If the proxy server has to be bypassed, specify *bypassproxy*. + +### Initialization + +#### Slot ID + +The DataMiner element will not know which slot it needs to represent until the slot ID has been provided. + +On the **General** page, the **slot ID** must be configured. + +#### REST API + +The HTTP communication uses a REST API, which needs to be enabled. + +On the device's web interface, make sure the **Enable REST API** option is selected under the **general settings** on the **System** page. + +#### HTTP Credentials + +The HTTP communication will not be up and running until the necessary HTTP credentials have been provided. + +On the **Credentials** page of the element, the **user name** and **password** must be configured. + +### Web Interface + +The web interface is only accessible when the client machine has network access to the product. + +## How to Use + +REST (Representational State Transfer) calls are used to retrieve the device information. + +### HTTP Communication + +On the **HTTP Communication** page, you can track the HTTP sessions used for communicating with the device. + +This makes it possible to follow the communication flow and provides some useful statistics, e.g. request time, response time, time span (RTT), etc. + +- **HTTP Sessions State**: If you enable this setting, the active HTTP sessions will be tracked. +- **HTTP Sessions Max Count**: This determines the maximum number of HTTP sessions that will be tracked. + +### Inter App + +On the **Inter App** page, an overview is provided that allows you to track the inter application communication and the related handlers. + +#### Inter App Communication + +Overview of the inter application communication events and messages. + +The state of a communication object indicates whether it is waiting to be processed, being processed, executed successfully, or failed. + +#### Inter App Handlers + +Overview of the inter application handlers of the received events and messages. + +Every communication object will be represented by a related handler. The handler is responsible for taking the necessary actions depending on the related communication object. diff --git a/connector/doc/Microsoft_Azure_-_File_Pusher.md b/connector/doc/Microsoft_Azure_-_File_Pusher.md new file mode 100644 index 00000000..5eadc73c --- /dev/null +++ b/connector/doc/Microsoft_Azure_-_File_Pusher.md @@ -0,0 +1,41 @@ +--- +uid: Connector_help_Microsoft_Azure_-_File_Pusher +--- + +# Microsoft Azure - File Pusher + +## About + +**Azure File Pusher** is used to enable periodic or manually triggered uploads of local files to Azure Blob Storage, where their content can be used for further analysis or online access. It helps automate file synchronization from local storage to Azure Blob Storage in an easy and intuitive way. + +Credentials for authentication are securely stored within the collector and used every time files are uploaded. + +You can configure multiple file path combinations, each with dedicated upload settings, allowing flexible file transfers to the Azure Blob Storage that best fits your use case. + +> [!TIP] +> For a better user experience, this connector can be used together with the [**Microsoft Azure Cloud Platform**](xref:Connector_help_Microsoft_Azure) connector, which allows you to monitor relevant resource metrics available in Azure. + +## Key Features + +- Configure Azure Storage Authentication. + + ![General Page](~/connector/images/MicrosoftAzure_FilePusher_General_Page.png) + +- Manage file path combinations and their configurations in the File Paths table. + + ![File Paths Page](~/connector/images/MicrosoftAzure_FilePusher_FilePaths_Page.png) + +- Configure an upload interval for each file path combination. + +- Configure upload options (*Overwrite*, *Recursive*, *Auto Delete on Success*, *Tries*) for each file path combination. + +- Trigger a manual upload for one or all file path combinations. + +## Prerequisites + +To deploy this integration, you will need: + +- DataMiner version **10.2.0 CU15 or higher** + +> [!NOTE] +> For detailed technical information, refer to our [technical documentation page](xref:Connector_help_Microsoft_Azure_-_File_Pusher_Technical_Page). diff --git a/connector/doc/Microsoft_Azure_-_File_Pusher_Technical.md b/connector/doc/Microsoft_Azure_-_File_Pusher_Technical.md new file mode 100644 index 00000000..ac3b6bfd --- /dev/null +++ b/connector/doc/Microsoft_Azure_-_File_Pusher_Technical.md @@ -0,0 +1,58 @@ +--- +uid: Connector_help_Microsoft_Azure_-_File_Pusher_Technical_Page +--- + +# Microsoft Azure - Storage Accounts + +The Azure File Pusher connector is used to automate file synchronization from local storage to Azure Blob Storage. + +Azure File Pusher acts as an enhanced Azure Storage Upload wrapper, providing an easy and intuitive way to configure links between local storage and Azure Storage. It allows periodic uploads of local files to Azure Storage, where their content can be used for further analysis or online access. + +Credentials for authentication are securely stored withing the collector and used every time files are uploaded. Credentials can also be tested within the connector to make sure a valid token for file uploads is received when authenticating. + +You can configure multiple file path combinations, each with dedicated upload settings, allowing flexible file transfers to the Azure Storage that best fits your use case. File paths are added, edited or deleted through the right-click context menu in the File Paths table. + +## Configuration + +### Connections + +#### HTTP Main Connection + +This connector uses an HTTP connection. However, this requires no input from the user during element creation. + +### Initialization + +When the element has been created, on the **General** page, configure and test the Azure Storage credentials (Tenant ID, Client ID, and Client Secret) and the Storage URL before you proceed with setting up file path combinations. + +## How to use + +### General Page + +On the **General** page, the authentication parameters and storage URL should be configured: + +- **Tenant ID**: A unique identifier associated with an Azure Active Directory (Azure AD) instance that represents a specific organization or tenant in Azure's directory structure. It can be found in the Overview section of Azure Active Directory under the Tenant Information. +- **Client ID**: A unique identifier, also known as Application ID, assigned to an application registered in Azure Active Directory (Azure AD). It is linked to the application registered in Azure and can be found in the application overview. +- **Client Secret**: A password-like credential used by applications registered in Azure Active Directory (Azure AD) to securely authenticate. +- **Blob Storage URL**: The endpoint used to access resources within an Azure Storage account (e.g. `https://dataminer.blob.core.windows.net`). + +The **Test Authentication** button can be used to test whether the provided credentials can retrieve the valid token used to access the blob storage. The **Authentication Test** parameter will indicate whether the authentication test was successful (*OK*) or unsuccessful (*Error*). + +### File Paths Page + +On the **File Paths** page, you can find a table containing source-destination information and settings for file uploads. Table rows can be added, edited, or deleted through the right-click menu. + +- **Source Path**: The local absolute source path, from which the files are uploaded. +- **Container**: The Azure container name, relative to storage mentioned in the Storage URL parameter, to which files are uploaded. +- **Custom Path Prefix**: The prefix path, added to the original file path, when the file is uploaded to Azure. +- **Timer**: Timer defining the frequency with which rows of the File Paths table are uploaded to Azure. +- **Recursive**: Defines if files in the source path are searched recursively in all directories or only in the top directory of the path. +- **Overwrite**: Determines whether files will be overwritten if these same files have already been uploaded. +- **Tries**: Specifies the number of attempts to retry uploading a file if the initial upload fails. +- **Auto Delete on Success**: Determines whether successfully pushed files are deleted from the source path. +- **Upload**: Triggers an upload of files from the selected local path to the container path. + +The **Upload All** button will trigger an upload of all files from the File Paths table. + +## Notes + +For a better user experience, this connector can be used together with the [**Microsoft Azure Cloud Platform**](xref:Connector_help_Microsoft_Azure) connector, which allows you to monitor relevant resource metrics available in Azure. diff --git a/connector/doc/Miranda_RCP-200.md b/connector/doc/Miranda_RCP-200.md index 3aae4a19..695f3647 100644 --- a/connector/doc/Miranda_RCP-200.md +++ b/connector/doc/Miranda_RCP-200.md @@ -8,18 +8,18 @@ This connector can be used as a remote controller for Miranda RCP-200 devices. ## About -The objective is to control DMA elements, using the RCP-200 keyboards. DMA acts as a gateway: +The objective of this connector is to control DataMiner elements using RCP-200 keyboards. DataMiner acts as a gateway: -- Provide some parameter values from elements -- Change parameters of elements, based on requests sent by RCP-200 +- Providing some parameter values from elements. +- Changing parameters of elements, based on requests sent by RCP-200. -DMA is responsible for providing all the information to be displayed on the RCP-200 buttons: +DataMiner is responsible for providing all the information to be displayed on the RCP-200 buttons: -- String ( HTML formatted ) -- Background Color -- Text Color +- String (HTML formatted) +- Background color +- Text color -Also, the layout is dynamic. This means that the parameters displayed on the keyboard could change , depending on which button the user clicks on. This is the case when parameters are on different pages. +Also, the layout is dynamic. This means that the parameters displayed on the keyboard could change, depending on which button is clicked. This is the case when parameters are on different pages. CSV files can be used to provision the data (devices, pages, buttons) in the element. @@ -27,104 +27,107 @@ CSV files can be used to provision the data (devices, pages, buttons) in the ele The RCP-200 devices can interact with the DMA using a REST API, with the DMA element acting as the server. All data is transferred in **JSON** format. -One single method is available to indicate which button on which page the user clicks on. The API replies with a response containing the complete design of the requested page. +One single method is available to indicate which button on which page is clicked. The API replies with a response containing the complete design of the requested page. Request URI: http://\:\/restapi/SetParameter?panelIp=\&page=\&buttonID=\