Errata exists for this version of the document.
The Method RequestServerStateChange allows a Client to request a state change in the Server.
The Client shall provide credentials with administrative rights when invoking this Method on the Server.
Signature
RequestServerStateChange(
[in] ServerState state
[in] DateTime estimatedReturnTime
[in] UInt32 secondsTillShutdown
[in] LocalizedText reason
[in] Boolean restart
);
|
Argument |
Description |
|
state |
The requested target state for the Server. If the new state is accepted by the Server, the State in the ServerStatus is updated with the new value. |
|
estimatedReturnTime |
Indicates the time at which the Server is expected to be available in the state RUNNING_0. If no estimate is known, a null DateTime shall be provided. This time will be available in the EstimatedReturnTime Property. This parameter shall be ignored by the Server and the Property EstimatedReturnTime shall be set to null if the new state is RUNNING_0. |
|
secondsTillShutdown |
The number of seconds until a Server shutdown. This parameter is ignored unless the state is set to SHUTDOWN_4 or restart is set to True. |
|
reason |
A localized text string that describes the reason for the state change request. |
|
restart |
A flag indicating if the Server should be restarted before it attempts to change into the requested change. If the restart is True the server changes it state to SHUTDOWN_4 before the restart if secondsTillShutdown is not 0. |
Method Result Codes (defined in Call Service)
|
Result Code |
Description |
|
Bad_UserAccessDenied |
The current user is not authorized to invoke the method |
|
Bad_InvalidState |
The requested state was not accepted by the server |
Table 97 specifies the AddressSpace representation for the RequestServerStateChange Method.
Table 97 – RequestServerStateChange Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
RequestServerStateChange |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |