Skip to content

Commit 11b6296

Browse files
committed
Review
1 parent 45ad51b commit 11b6296

File tree

2 files changed

+23
-39
lines changed

2 files changed

+23
-39
lines changed

connector/doc/Ericsson_SAU-IP.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,25 @@ This connector monitors the Ericsson Service Access Unit (SAU).
1010

1111
### Key Features
1212

13-
- **Monitoring of Connected Devices**: The connector discovers the devices and modules connected to the main Ericsson SAU and provides detailed information of each part.
14-
- **Inputs and Outputs Alarm Configuration**: Input and Output alarm settings can be changed directly from the connector, including; port configuration, alarm severity and specific name of the monitored port.
15-
- **Alarm Monitoring**: Alarms are collected on DataMiner and easily monitored from the alarm console.
13+
- **Monitoring of connected devices**: The connector discovers the devices and modules connected to the main Ericsson SAU and provides detailed information for each part.
14+
- **Inputs and outputs alarm configuration**: Input and output alarm settings can be changed directly from the connector, including port configuration, alarm severity, and the specific name of the monitored port.
15+
- **Alarm monitoring**: Alarms are collected in DataMiner and easily monitored from the Alarm Console.
1616

1717
## Use Cases
1818

1919
### Input and Output Alarm Configuration
2020

21-
**Challenge**: Alarm monitoring can be complex on the **Ericsson SAU** as configuration is very versatile.
21+
**Challenge**: Alarm monitoring can be complex on the Ericsson SAU as its configuration is very versatile.
2222

23-
**Solution**: The connector supports the user by supplying detailed information of each configurable setting and how they affect the subsequent alarming.
24-
Name of the alarm can be changed to provide more specific details of the issue, default configuration of the alarm can be set to either Normally Closed or Normally Opened for different purposes, and severity can be set from a dropdown menu all on one page.
23+
**Solution**: The connector allows you to supply detailed information about each configurable setting and how it affects the subsequent alarming. You can change the name of an alarm to provide more specific details about the issue, set the default configuration of the alarm to either *Normally Closed* or *Normally Opened* for different purposes, and set the severity from a dropdown menu, all on one page.
2524

2625
**Benefit**: Simple, straightforward way to configure alarming.
2726

2827
### Source of Monitored Physical Entities
2928

30-
**Challenge**: The monitored physical entities are available on a generic Physical Entities table from the MIB. Although the devices are on different hierarchical levels (parent and child relationship), they are stored on the same table making it confusing to track the entire hierarchy.
29+
**Challenge**: The monitored physical entities are available in a generic Physical Entities table from the MIB. Although the devices are on different hierarchical levels (parent and child relationship), they are stored on the same table, making it confusing to track the entire hierarchy.
3130

32-
**Solution**: The connector automatically traces the hierarchy of monitored physical entity and prefixes the hierarchy to the entity, making it clear which parent component it is connected to.
31+
**Solution**: The connector automatically traces the hierarchy of each monitored physical entity and prefixes the hierarchy to the entity, making it clear which parent component it is connected to.
3332

3433
**Benefit**: Reduce the need to manually trace physical entity hierarchy.
3534

connector/doc/Ericsson_SAU-IP_Technical.md

+16-31
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,53 @@ uid: Connector_help_Ericsson_SAU-IP_Technical
44

55
# Ericsson SAU-IP
66

7-
This connector monitors the Ericsson Service Access Unit (SAU).
8-
97
## About
108

11-
### Version Info
12-
13-
| Range | Key Features | Based on | System Impact |
14-
|--------------------|---------------------------------------------------------------------------------------------------|----------|---------------|
15-
| 1.0.0.x [SLC Main] | Initial version. | - | - |
16-
17-
### Product Info
18-
19-
| Range | Supported Firmware |
20-
|-----------|------------------------|
21-
| 1.0.0.x | - |
22-
23-
### System Info
24-
25-
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
26-
|---------|-----------------|---------------------|-------------------|---------------------|
27-
| 1.0.0.x | No | Yes | - | - |
9+
This connector monitors the Ericsson Service Access Unit (SAU).
2810

2911
## Configuration
3012

3113
### Connections
3214

33-
#### SNMP Connection - [Name of the connection]
15+
#### SNMP Connection - Main
3416

3517
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
3618

3719
SNMP CONNECTION:
3820

39-
- **IP address/host**: [The polling IP or URL of the destination.]
21+
- **IP address/host**: The polling IP or URL of the destination.
4022

4123
SNMP Settings:
4224

43-
- **Port number**: [The port of the connected device, by default 161.]
44-
- **Get community string**: [The community string used when reading values from the device (default: *public*).]
45-
- **Set community string**: [The community string used when setting values on the device (default: *private*).]
25+
- **Port number**: The port of the connected device, by default 161.
26+
- **Get community string**: The community string used when reading values from the device (default: *public*).
27+
- **Set community string**: The community string used when setting values on the device (default: *private*).
4628

4729
## How to use
4830

4931
### Input Alarm Configuration
50-
These settings can be accessed on the Inputs page.
32+
33+
These settings can be accessed on the **Inputs** page.
34+
5135
- **Name**: This parameter can be set to provide a better description of what the sensor is monitoring.
5236

5337
- **State**: This parameter toggles between enabling and disabling the alarm for the row item. Disabling an enabled alarm will also clear the existing alarm, if any.
5438

55-
- **Configuration**: This parameter refers to the default state of the monitored Input; a Normally Closed Input will trigger an alarm when it opens and vice versa
39+
- **Configuration**: This parameter refers to the default state of the monitored input. A "Normally Closed" input will trigger an alarm when it opens and vice versa.
5640

57-
- **Severity**: This parameter is a configuration parameter that allows the user to set the severity of the resultant alarm for the associated Input.
41+
- **Severity**: This configuration parameter allows you to set the severity of the resulting alarm for the associated input.
5842

5943
When an Input alarm is activated, it will be indicated as 'Active' in the **Status** column. This alarm will also be represented on the Alarms table.
6044
The user can choose which location (Alarm table or Inputs table) to alarm on, noting that alarming on both locations will result in duplicate alarms for the same incident.
6145

6246
### Output Alarm Configuration
63-
These settings can be accessed on the Outputs page.
47+
48+
These settings can be accessed on the **Outputs** page.
49+
6450
- **Name**: This parameter can be set to provide a better description of what the sensor is monitoring.
6551

6652
- **State**: This parameter toggles between enabling and disabling the alarm for the row item. Disabling an enabled alarm will also clear the existing alarm, if any.
6753

68-
- **Severity**: This parameter is a configuration parameter that allows the user to set the severity of the resultant alarm for the associated Input.
69-
70-
- **Status**: As an output parameter, the status can be manually toggled between Alarm and No Alarm states. To make a valid remote set from this connector/device to the sensor, the **State** should be Enabled and **Severity** should be Remote.
54+
- **Severity**: This configuration parameter allows you to set the severity of the resulting alarm for the associated output.
7155

56+
- **Status**: For an output parameter, you can manually toggle the status between *Alarm* and *No Alarm*. To make a valid remote set from this connector to the sensor, the **State** has to be set to *Enabled* and the **Severity** has to be set to *Remote*.

0 commit comments

Comments
 (0)