| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
JSON-RPC Cascade Manager. More...
import <CascadeManager.idl;
| 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. | |
| int | setPrimaryUnitSettings (in PrimaryUnitSettings primaryUnitSettings) | 
| Set settings for the primary unit. | |
| Status | getStatus () | 
| Retrieve the full cascading status for this unit. | |
| LinkPortStatus | getLinkPortStatus () | 
| Retrieve the current Link Port status. | |
| 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. | |
| int | addLinkUnit2 (in int linkId, in string host, in string login, in string password, in string newPassword, in boolean disableStrongPasswordReq) | 
| Put a new link unit under this primary unit's control. | |
| int | releaseLinkUnit (in int linkId) | 
| Release a link unit from this primary unit's control. | |
| int | requestLink (in string token) | 
| Request to make this unit a link unit and put it under the remote primary unit's control. | |
| void | finalizeLink (in string token) | 
| Finalize the link with this link unit. | |
| void | unlink () | 
| Release this link unit from the remote primary unit's control. | |
| vector< Role > | getSupportedRoles () | 
| Check which cascading roles this unit supports. | |
| vector< LinkUnitType > | getSupportedLinkUnitTypes () | 
| Check which type of link units this unit supports. | |
| 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. | |
| int | addLinkPortLinkUnit () | 
| Add a neighbor that was discovered on the link port as link unit. | |
| int | addSecureSerialLinkUnit (in int linkId, in string installKey) | 
| Add a serial link unit (ScalePoint Base). | |
| Public Attributes | |
| constant int | NO_ERROR = 0 | 
| Operation successful, no error. | |
| constant int | ERR_INVALID_PARAM = 1 | 
| A parameter was invalid. | |
| constant int | ERR_UNSUPPORTED_ON_PRIMARY_UNIT = 2 | 
| Operation not allowed for a primary unit. | |
| constant int | ERR_UNSUPPORTED_ON_LINK_UNIT = 3 | 
| Operation not allowed for a link unit. | |
| constant int | ERR_LINK_ID_IN_USE = 4 | 
| The specified link ID is already used. | |
| constant int | ERR_HOST_IN_USE = 5 | 
| The specified host is already in use. | |
| constant int | ERR_LINK_UNIT_UNREACHABLE = 6 | 
| Could not connect to the link device. | |
| constant int | ERR_LINK_UNIT_ACCESS_DENIED = 7 | 
| Login to link device failed. | |
| constant int | ERR_LINK_UNIT_REFUSED = 8 | 
| Remote device refused to become a link unit. | |
| constant int | ERR_UNIT_BUSY = 9 | 
| The unit could not respond because it was busy. | |
| constant int | ERR_NOT_SUPPORTED = 10 | 
| Operation not supported on this device. | |
| constant int | ERR_PASSWORD_CHANGE_REQUIRED = 11 | 
| The unit requires a password change. | |
| constant int | ERR_PASSWORD_POLICY = 12 | 
| The given password did not meet the requirements. | |
| constant int | ERR_LINK_UNIT_COMM_FAILED = 13 | 
| Communication with the link unit failed. | |
| constant int | ERR_LINK_UNIT_NOT_SUPPORTED = 14 | 
| Link unit does not support cascading. | |
| constant int | ERR_FIRMWARE_VERSION_MISMATCH = 15 | 
| The firmware versions between primary and link unit do not match. | |
JSON-RPC Cascade Manager.
Definition at line 12 of file CascadeManager.idl.
Link Unit Communication Status.
Definition at line 50 of file CascadeManager.idl.
| Enumerator | |
|---|---|
| NETWORK | High-level linking via JSON-RPC API. | 
| SECURE_SERIAL | Linking via encrypted serial bus (ScalePoint) | 
Definition at line 44 of file CascadeManager.idl.
JSON-RPC Cascade Role.
| Enumerator | |
|---|---|
| STANDALONE | Standalone unit, not in cascade. | 
| PRIMARY_UNIT | Primary unit controlling other devices. | 
| LINK_UNIT | Link unit under primary unit control. | 
Definition at line 38 of file CascadeManager.idl.
| 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 default 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. loginmust be the default admin. | 
| int cascading::CascadeManager::addLinkUnit2 | ( | in int | linkId, | 
| in string | host, | ||
| in string | login, | ||
| in string | password, | ||
| in string | newPassword, | ||
| in boolean | disableStrongPasswordReq ) | 
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 default 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. loginmust be the default admin. | 
| disableStrongPasswordReq | if true, this disables the strong password requirements on the link unit ifnewPasswordis set | 
| 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.
| constant int cascading::CascadeManager::ERR_FIRMWARE_VERSION_MISMATCH = 15 | 
The firmware versions between primary and link unit do not match.
Definition at line 29 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_HOST_IN_USE = 5 | 
The specified host is already in use.
Definition at line 19 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_INVALID_PARAM = 1 | 
A parameter was invalid.
Definition at line 15 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_ID_IN_USE = 4 | 
The specified link ID is already used.
Definition at line 18 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_UNIT_ACCESS_DENIED = 7 | 
Login to link device failed.
Definition at line 21 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_UNIT_COMM_FAILED = 13 | 
Communication with the link unit failed.
Definition at line 27 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_UNIT_NOT_SUPPORTED = 14 | 
Link unit does not support cascading.
Definition at line 28 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_UNIT_REFUSED = 8 | 
Remote device refused to become a link unit.
Definition at line 22 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_LINK_UNIT_UNREACHABLE = 6 | 
Could not connect to the link device.
Definition at line 20 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_NOT_SUPPORTED = 10 | 
Operation not supported on this device.
Definition at line 24 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_PASSWORD_CHANGE_REQUIRED = 11 | 
The unit requires a password change.
Definition at line 25 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_PASSWORD_POLICY = 12 | 
The given password did not meet the requirements.
Definition at line 26 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_UNIT_BUSY = 9 | 
The unit could not respond because it was busy.
Definition at line 23 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_UNSUPPORTED_ON_LINK_UNIT = 3 | 
Operation not allowed for a link unit.
Definition at line 17 of file CascadeManager.idl.
| constant int cascading::CascadeManager::ERR_UNSUPPORTED_ON_PRIMARY_UNIT = 2 | 
Operation not allowed for a primary unit.
Definition at line 16 of file CascadeManager.idl.
| constant int cascading::CascadeManager::NO_ERROR = 0 | 
Operation successful, no error.
Definition at line 14 of file CascadeManager.idl.