Legrand / Raritan / Server Technology Xerus™ PDU JSON-RPC API
|
JSON-RPC Cascade Manager. More...
Classes | |
struct | LinkPortStatus |
Status of the Link Port. More... | |
struct | LinkPortStatusChangedEvent |
Link Port Status changed. More... | |
struct | LinkUnit |
Link Unit Status. More... | |
struct | LinkUnitAddedEvent |
Event: A new link unit has been added. More... | |
struct | LinkUnitReleasedEvent |
Event: A link unit has been released. More... | |
struct | LinkUnitStatusChangedEvent |
Event: A link unit's communication status has changed. More... | |
struct | PrimaryUnitSettings |
Settings for primary unit. More... | |
struct | RoleChangedEvent |
Event: This unit's role in the cascade has changed. More... | |
struct | Status |
Full Cascading Status. More... | |
Public Types | |
enum | Role { STANDALONE , PRIMARY_UNIT , LINK_UNIT } |
JSON-RPC Cascade Role. More... | |
enum | LinkUnitType { NETWORK , SECURE_SERIAL } |
enum | LinkUnitStatus { UNKNOWN , OK , UNREACHABLE , ACCESS_DENIED , FIRMWARE_UPDATE , FIRMWARE_MISMATCH , PENDING } |
Link Unit Communication Status. More... | |
Public Member Functions | |
PrimaryUnitSettings | getPrimaryUnitSettings () |
Retrieve settings for the primary unit. More... | |
int | setPrimaryUnitSettings (in PrimaryUnitSettings primaryUnitSettings) |
Set settings for the primary unit. More... | |
Status | getStatus () |
Retrieve the full cascading status for this unit. More... | |
LinkPortStatus | getLinkPortStatus () |
Retrieve the current Link Port status. More... | |
int | addLinkUnit (in int linkId, in string host, in string login, in string password, in string newPassword) |
Put a new link unit under this primary unit's control. More... | |
int | releaseLinkUnit (in int linkId) |
Release a link unit from this primary unit's control. More... | |
int | requestLink (in string token) |
Request to make this unit a link unit and put it under the remote primary unit's control. More... | |
void | finalizeLink (in string token) |
Finalize the link with this link unit. More... | |
void | unlink () |
Release this link unit from the remote primary unit's control. More... | |
vector< Role > | getSupportedRoles () |
Check which cascading roles this unit supports. More... | |
vector< LinkUnitType > | getSupportedLinkUnitTypes () |
Check which type of link units this unit supports. More... | |
int | addCascadeLinkUnit (in int linkId, in int nodeIndex, in string login, in string password, in boolean positionDependent) |
Can be called on a network cascade primary unit to add expansion units of the network cascade as link units. More... | |
int | addLinkPortLinkUnit () |
Add a neighbor that was discovered on the link port as link unit. More... | |
int | addSecureSerialLinkUnit (in int linkId, in string installKey) |
Add a serial link unit (ScalePoint Base). More... | |
JSON-RPC Cascade Manager.
Link Unit Communication Status.
int cascading::CascadeManager::addCascadeLinkUnit | ( | in int | linkId, |
in int | nodeIndex, | ||
in string | login, | ||
in string | password, | ||
in boolean | positionDependent | ||
) |
Can be called on a network cascade primary unit to add expansion units of the network cascade as link units.
linkId | The ID for the new link unit |
nodeIndex | The expansion unit's index in the network cascade (1 - 15) |
login | The administrator login for the link unit |
password | The administrator password for the link unit |
positionDependent | If true, host names that depend on the nodex index will be used. If false, unique link-local IPv6 addresses will be used for linking. |
int cascading::CascadeManager::addLinkPortLinkUnit | ( | ) |
Add a neighbor that was discovered on the link port as link unit.
If a new password needs to be set, it will be generated.
int cascading::CascadeManager::addLinkUnit | ( | in int | linkId, |
in string | host, | ||
in string | login, | ||
in string | password, | ||
in string | newPassword | ||
) |
Put a new link unit under this primary unit's control.
The login credentials must have administrator privileges on the link unit. They are only used to establish a trust relationship between primary and link unit and not stored.
This method can also be used to re-authenticate a link unit that denies access. In that case the linkId and host parameter must exactly match the existing values.
linkId | The ID for the new link unit |
host | The link unit's host name or IP address |
login | The administrator login for the link unit |
password | The administrator password for the link unit |
newPassword | The new administrator password for the unit. This is needed for adding a link unit that still has default settings and requires a password change. Otherwise it can be left empty. |
int cascading::CascadeManager::addSecureSerialLinkUnit | ( | in int | linkId, |
in string | installKey | ||
) |
Add a serial link unit (ScalePoint Base).
As a special case, link ID 1 is used to pair the primary unit on the "internal" RS485 bus. It will not be added to the list of link units.
linkId | The ID for the new link unit |
installKey | The install key from the Base unit's label |
void cascading::CascadeManager::finalizeLink | ( | in string | token | ) |
Finalize the link with this link unit.
token | same authorization token as used for requestLink() |
This method should only be called by the primary unit in order to acknowledge the establishment of the link to the link unit and finalize the link build-up. The linking will only take effect once the link unit received this acknowledgement.
If this method fails, you will get the ACCESS_DENIED status for this link unit and you will have to re-authenticate it.
LinkPortStatus cascading::CascadeManager::getLinkPortStatus | ( | ) |
Retrieve the current Link Port status.
PrimaryUnitSettings cascading::CascadeManager::getPrimaryUnitSettings | ( | ) |
Retrieve settings for the primary unit.
Status cascading::CascadeManager::getStatus | ( | ) |
Retrieve the full cascading status for this unit.
vector< LinkUnitType > cascading::CascadeManager::getSupportedLinkUnitTypes | ( | ) |
Check which type of link units this unit supports.
vector< Role > cascading::CascadeManager::getSupportedRoles | ( | ) |
Check which cascading roles this unit supports.
int cascading::CascadeManager::releaseLinkUnit | ( | in int | linkId | ) |
Release a link unit from this primary unit's control.
linkId | The ID of the link unit |
int cascading::CascadeManager::requestLink | ( | in string | token | ) |
Request to make this unit a link unit and put it under the remote primary unit's control.
This method is usually called by the primary unit when adding a new link unit. The link will only be established once finalizeLink() is successfully called.
token | Authorization token for future requests |
int cascading::CascadeManager::setPrimaryUnitSettings | ( | in PrimaryUnitSettings | primaryUnitSettings | ) |
Set settings for the primary unit.
primaryUnitSettings | Primary unit settings |
void cascading::CascadeManager::unlink | ( | ) |
Release this link unit from the remote primary unit's control.
This method is usually called by the primary unit when releasing a link unit. This unit will become a standalone unit.