Automation Services Application Program Interface › $RMSTSET

$RMSTSET

This API procedure sets the actual state of a defined resource.

Syntax

This API procedure function call has the following format:

$RMSTSET CLASS={USRCLS|class-name}
         NAME=resource-name
         STATUS=actual-state

Operands

This API procedure function call has the following operands:

CLASS={USRCLS|class-name}

Specifies the class of the resource that is the subject of the status change.

Default: USRCLS that specifies a user-defined resource class

NAME=resource-name

Specifies the resource that is the subject of the status change.

STATUS=actual-state

Specifies the actual state to which the resource is to be set.

Return Variable

This API procedure function call returns the following variable:

&SYSMSG

Contains the returned message.

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Set Resource Actual State

This example sets the actual state of MYRES01 to FAILED:

$RMSTSET NAME=MYRES01 STATUS=FAILED