Automation Services Application Program Interface › Application Programming Interface Procedures

Application Programming Interface Procedures

The application program interface enables sources external to products that use Automation Services to call Automation Services functions, and retrieve information about resources and services.

The following API procedures are supplied for this purpose:

$RMCALL

Allows you to execute Automation Services commands, retrieve information about definitions in the knowledge base, retrieve resource and service status information, and delete extraneous link records.

$RMDBAPI

Allows you to maintain the ResourceView definitions and, in a CA NetMaster FTM region, file transfer rule sets and rules in the knowledge base.

$RMEVENT

Allows you to send a message to a (typically user-defined) resource or service.

$RMSTSET

Allows you to set the actual state of a defined resource or service.

$RECALL

Allows you to process EventView variables from NCL procedures.

$REDBAPI

Allows you to maintain the EventView definitions in the knowledge base.

The API can be called from:

• OCS or the system console
• Batch programs
• NCL procedures
• State change exits

Each of the APIs and their calling conventions are described in the following sections.

Note: Services are considered to be a specific type of resource—that is, a resource with a class of SVC.