Skip to content

Commit

Permalink
Added Raritan Xerus Platform connector help
Browse files Browse the repository at this point in the history
Added Raritan Xerus Platform connector help
  • Loading branch information
SlcRobinME committed Jul 2, 2024
1 parent aa0e916 commit 3875fe7
Show file tree
Hide file tree
Showing 3 changed files with 168 additions and 0 deletions.
3 changes: 3 additions & 0 deletions connector/doc/Raritan_Dominion_PXG2.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ uid: Connector_help_Raritan_Dominion_PXG2

The Raritan Dominion PXG2 connector facilitates the monitoring of this line of Power Distribution Units (PDU).

> [!NOTE]
> This connector is based on the Xerus Platfor MIB and the implementation has been moved to the [Raritan Xerus Platform connector](xref:Connector_help_Raritan_Xerus_Platform). Please migrate to this connector instead.
## About

This connector uses **SNMP** to extract all relevant information concerning the configuration and operating configuration of Raritan's PDU.
Expand Down
163 changes: 163 additions & 0 deletions connector/doc/Raritan_Xerus_Platform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
uid: Connector_help_Raritan_Xerus_Platform
---

# Raritan Xerus Platform

The Raritan Xerus Platform connector facilitates the monitoring and control of the following Raritan device types:
- SRC
- PX3
- PX2
- PXC
- PX0
- BCM2
- PX3TS
- SmartLock
- DX2 SmartSensors
- AMS2

> [!NOTE]
> The Xerus MIB implements all Raritan Product types. Therefor this connector is a generic connector type that supports all these devices.
> Dependant on the type, some tables might be empty.
## About

This connector uses **SNMP** to extract all relevant information concerning the configuration and operating configuration of Raritan's PDU.

### Version Info

| Range | Key Features | Based on | System Impact |
|----------------------|------------------|--------------|-------------------|
| 1.0.0.x [SLC Main] | Initial version | - | - |

### Product Info

| Range | Supported Firmware |
|-----------|------------------------|
| 1.0.0.x | 4.1.1.5-49961 |

### System Info

| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|-----------|---------------------|-------------------------|-----------------------|-------------------------|
| 1.0.0.x | No | Yes | - | - |

## Installation and configuration

### Creation

#### SNMP Main 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.]

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*)]

## Usage

### Unit

In this page can be found information regarding the hardware configuration and the state of operation of the sensors of the connected PDU(s) unit(s).

### Inlets

In this page can be found the specifications of each inlet. It also shows the current operating configuration and the options allowing changes to said configuration of each inlet sensor.

### Over Current Protector

In this page can be found the specifications of each Over Current Protector. It also shows the current operating configuration and the options allowing changes to said configuration of each sensor.

### Outlets

In this page can be found the specifications of all the outlets of the device. It also shows the current operating configuration and the options allowing changes to said configuration.

### External Sensors

In this page can be found the specifications of external sensors. It also shows the current operating configuration and the options allowing changes to said configuration of each sensor.

### Server Reachability

In this page are listed the servers connected to the device, their respective IPs and whether or not they are reachable.

### Transfer Switch

In this page are identified the transfers switches of the device. It also shows the current operating configuration and the options allowing changes to said configuration.

### Control

The Control Page presents the options allowing to control the operation of the connected elements of this device.

### Measurements Unit

This page shows the availability of and the values of each Unit sensor.

### Measurements Inlet

This page shows the availability of and the values of each Inlet sensor.

### Measurements Over Current Protector

This page shows the availability of and the values of each Over Current Protector sensor.

### Measurements Outlet

This page shows the availability of and the values of each Outlet sensors.

### Measurements External Sensor

This page shows the availability of and the values of each External sensor.

### Measurements Transfer Switch

This page shows the availability of and the values of each Transfer Switch sensor.

### Log Unit

This page logs the Unit sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Log Inlet

This page logs the Inlet sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Log Over Current Protector

This page logs the Over Current Protector sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Log Outlet

This page logs the Outlet sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Log External Sensor

This page logs the External sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Log Transfer Switch

This page logs the Transfer Switch sensor information in a span of 2 hours. One entity is added to the table corresponding to each minute, therefore there will be 120 entries per sensor.

For each sensor it is logged the state, maximum, minimum and average value. There is also an indication whether the logged information is available.

### Reliability Data

This page contains a list of PDU reliability data entries.

### Reliability Error Log

This page contains a list of PDU reliability ErrorLog entries.
2 changes: 2 additions & 0 deletions connector/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6886,6 +6886,8 @@
topicUid: Connector_help_Raritan_Dominion_KX
- name: Raritan Dominion PXG2
topicUid: Connector_help_Raritan_Dominion_PXG2
- name: Raritan Xerus Platform
topicUid: Connector_help_Raritan_Xerus_Platform
- name: RCI
items:
- name: RCI RC2000
Expand Down

0 comments on commit 3875fe7

Please sign in to comment.