Pause

Temporarily limits the availability of the SAS Metadata Server.

Server control methods

rc=Pause(options);

The Pause method is issued on a running SAS Metadata Server to temporarily change the server to a more restrictive state.

A user must have administrative user status on the SAS Metadata Server to issue the Pause method.

The Pause method cannot be used to limit the availability of specific metadata repositories. To limit a metadata repository's availability, use the UpdateMetadata method to change the value in the repository's Access attribute. If a Pause method is issued that specifies the <REPOSITORY/> option, the SAS Metadata Server returns an error.

A running SAS Metadata Server supports six states in SAS 9.3:

The ADMIN, READONLY, and OFFLINE states are set with the Pause method.

The ADMIN(READONLY) and RECOVERY states are set by internal server recovery processes. The SAS Metadata Server is set to and remains in the RECOVERY state until the recovery process successfully completes. After a successful recovery, the server is returned to whatever state it was in when the recovery was requested. A server backup is performed with the server in that state. In the unlikely event the server fails to respond during the recovery process, administrators can use the Pause method with the <FORCE/> option to regain control of the server. By default, <FORCE/> changes the server to an OFFLINE state. The <FORCE/> option should be used with the <SERVER STATE="ADMIN"/> option to enable administrators to examine the server before making it available to clients. When the server is in the RECOVERY state, Pause requests are rejected. The ADMIN(READONLY) state is set by internal server recover processes that fail if the server was in a READONLY state when the recovery was started. From this state, administrators can troubleshoot the failure before making the server available to clients.

When the server has been changed to another state by the Pause method or by internal server recovery processes, the Resume method must be used to return the server to an ONLINE state. For more information, see Resume.

The <PAUSECOMMENT> element enables administrators to set a free-form text comment along with the Pause action that is retrieved with server status queries. The <PAUSECOMMENT> element is specified as follows:

<PauseComment>This is a test of the Pause method. </PauseComment>

The <PAUSECOMMENT> element can be added to any exception returned by a method that rejects a user request because of a paused status. Resume clears the text in the <PAUSECOMMENT> element.

When a paused SAS Metadata Server is stopped and restarted, it restarts in an ONLINE state. Neither a server pause, nor <PAUSECOMMENT>, is persisted between server sessions.

The state of the SAS Metadata Server is obtained by issuing the Status method. For more information, see Status.

The following example pauses the SAS Metadata Server to an OFFLINE state:

<!-- Pause the server to OFFLINE  -->
options=' ';
rc=serverObject.Pause(options);

OFFLINE is the default value when the Pause method is issued without options specified.

The following example pauses the SAS Metadata Server to an ADMIN state:

<!-- Pause the server to ADMIN  -->
options='<Server State="ADMIN"/>';
rc=serverObject.Pause(options);

The following example shows how the <PAUSECOMMENT> element is used:

<!-- Pause the server to OFFLINE with a comment  -->
options='<PauseComment>This is a test of the Pause method.  Client 
activity on the SAS Metadata Server will be resumed shortly.</PauseComment>';
rc=serverObject.Pause(options);