Compaq ACMS for OpenVMS
Remote Systems Management Guide


Previous Contents Index

7.42 ACMSMGMT_STOP_TRACE_MONITOR_1

This procedure requests that the Remote Manager stop the ACMS$TRACE_MONITOR process. The ACMS$TRACE_MONITOR process is an intermediate process used by the Remote Manager to communicate with ACMS run-time processes to enable and disable collections.


Format

int *acmsmgmt_stop_trace_monitor_1(sub_id_struct *sub_id_rec,CLIENT *cl)


Parameters

sub_id_rec

Type: Sub_id_struct
Access: Read  
Mechanism: By reference  
Usage: Structure that contains the following client authorization information.
     
  client_id
  Type: Integer
  Access: Read
  Mechanism: By value
  Usage: If explicit authentication is being used, a valid client ID must be provided. If the value for client_id is 0, proxy access is used. Client_id is obtained by calling the acms$mgmt_get_creds procedure.

cl

Type: CLIENT *
Access: Read  
Mechanism: By value  
Usage: Pointer to an RPC client handle previously obtained by calling the RPC routine CLNT_CREATE.

Return Value

Type: Integer
Access: Write
Mechanism: By reference
Usage: Pointer to status value returned. If the value is NULL or MGMT_SUCCESS, the RPC has succeeded. If the value is neither NULL nor MGMT_SUCCESS, the call failed and the value pointed to is the reason for failure.

Description

This procedure requests that the Remote Manager stop the ACMS$TRACE_MONITOR process on the target node. The ACMS$TRACE_MONITOR process is an intermediate process used by the Remote Manager to communicate with ACMS run-time processes to enable and disable collections.

In general, external entities do not require a startup and shutdown request of the trace monitor process. The Remote Manager starts the trace monitor during process initialization and stops it during process shutdown. Additionally, the Remote Manager starts the trace monitor anytime it is needed (if it is not already started). Once started, the trace monitor continues to run until the Remote Manager shuts down.

After issuing the stop command to the trace monitor, the Remote Manager waits for a period of up to trace_start_wait_time (a Parameter table parameter that is dynamic and expressed in seconds). If the trace monitor fails to stop during that period, the Remote Manager returns an error to the caller.


Example


int stop_trace(int client_id,CLIENT *cl) 
{ 
   static int *status; 
   static struct sub_id_struct sub_rec; 
 
   sub_rec.client_id = client_id; 
 
   status = acmsmgmt_stop_trace_monitor_1(&sub_rec,cl); 
 
   if (!status) { 
    printf("\nShutdown of Trace Monitor has failed"); 
    return(MGMT_FAIL); 
   } 
 
   if (*status != MGMT_SUCCESS) { 
    printf("\nShutdown of Trace Monitor has failed with return code 
%d",*status); 
    return(*status); 
   } 
 
   printf("\nTrace Monitor has been stopped "); 
 
   return(MGMT_SUCCESS); 
} 
      

In the preceding example, the acmsmgmt_stop_trace_monitor_1 procedure is called to stop the ACMS$TRACE_MON process on the target node. If the call succeeds, the process is stopped. Otherwise, any error messages associated with the failure are displayed. The example in Section 5.3.1 shows how to declare and initialize the input arguments to this procedure.

7.43 ACMSMGMT_STOP_TSC_1

This procedure requests that the Remote Manager stop a Terminal Subsystem Controller (TSC) on the same node on which the Remote Manager is running.

Format

cmd_output_rec *acmsmgmt_stop_tsc_1(sub_id_struct *sub_id_rec,CLIENT *cl)


Parameters

sub_id_rec

Type: Sub_id_struct *
Access: Read  
Mechanism: By reference  
Usage: Structure that contains the following client authorization information.
     
  client_id
  Type: Integer
  Access: Read
  Mechanism: By value
  Usage: If explicit authentication is being used, a valid client ID must be provided. If the value for client_id is 0, proxy access is used. Client_id is obtained by calling the acms$mgmt_get_creds procedure.

cl

Type: CLIENT *
Access: Read  
Mechanism: By value  
Usage: Pointer to an RPC client handle previously obtained by calling the RPC routine CLNT_CREATE.

Return Value

Type: Cmd_output_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a union. The union contains either a failure code or a structure of type cmd_rec_r, which points to a linked list containing status messages. The following are the contents of this union:
         
  status
  Type: Integer
  Access: Write
  Mechanism: By value
  Usage: Failure return code.
         
  rc
  Type: Integer
  Access: Write
  Mechanism: By value
  Usage: Failure return code.
         
  data, data_warn
  Type: Cmd_rec
  Access: Write
  Mechanism: By value
  Usage: Structure containing the first node in a linked list of status messages (type dcl_list). The following are the contents of this structure:
         
    cmd_output
    Type: Dcl_list
    Access: Write
    Mechanism: By reference
    Usage: Pointer to a linked list of records containing status messages related to the failure of any updates. This structure contains the following fields:
         
      dcl_msg
      Type: Null-terminated string
      Access: Write
      Mechanism: By reference
      Usage: The status message.
         
      pNext
      Type: Dcl_list
      Access: Write
      Mechanism: By reference
      Usage: Pointer to the next node in the linked list.

Description

This procedure requests to stop an ACMS TSC on the same node on which the Remote Manager is running.

This call executes synchronously. It does not return to the caller until the attempt to stop the TSC is complete. Any messages associated with an unsuccessful start of the TSC are returned in the cmd_output linked list.

The data and data_warn structures contain identical data. If the operation fails, the status field of both structure will be MGMT_WARN; in this case, use the data_warn structure to fetch the status messages from the cmd_output linked list.

If the operation is successful, the status field of both structures will be MGMT_SUCCESS. No status messages are associated with a successful call.

If the status field contains MGMT_FAIL, the call failed. No status messages are returned; instead, the reason for the failure is contained in the rc field.


Example


int stop_tsc(int client_id,CLIENT *cl) 
{ 
   dcl_link    *nl; 
 
   static struct sub_id_struct sub_rec; 
   static cmd_output_rec *ret_struct; 
 
   sub_rec.client_id = client_id; 
 
   ret_struct = acmsmgmt_stop_tsc_1(&sub_rec,cl); 
 
   if (!ret_struct) { 
        printf("\n Call to stop tsc failed"); 
 return(MGMT_FAIL); 
   } 
 
   if (ret_struct->status != MGMT_SUCCESS) { 
 
 if (ret_struct->status != MGMT_WARN) { 
     printf("\nCall to stop ACMS TSC failed with status 
%d",ret_struct->status); 
     return(MGMT_FAIL); 
   } 
 
        printf("\n Call to stop ACMS TSC completed with warnings or errors"); 
 
 for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL; nl 
= nl->pNext) 
     printf("\n %s",nl->dcl_msg); 
 
 return(MGMT_FAIL); 
   } 
   else { 
 printf("\nCall to stop ACMS TSC was executed"); 
 for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL; nl 
= nl->pNext) 
     printf("\n %s",nl->dcl_msg); 
   } 
 
 return(0); 
} 
      

In the preceding example, the acmsmgmt_stop_tsc_1 procedure is called to stop the terminal subsystem on the target node. If the call succeeds, the terminal subsystem is stopped on the target node. Otherwise, any error messages associated with the failure are displayed. The example in Section 5.3.1 shows how to declare and initialize the input arguments to this procedure.


Chapter 8
Remote Manager Reference Tables

This chapter contains information about data types that the Remote Manager implements and the reference tables for the Remote Manager. The Remote Manager reference tables include the following:

8.1 Data Types

The ACMS Remote Manager implements the following data types:

8.2 ACC Table

The ACC table contains a single entry for ACC management information.

Table 8-1 ACC Table
Class Field Data Type SNMP Access RPC Access Dynamic
ID record_state integer R R  
ID id_coll_state integer R R  
ID process_name string R R  
ID pid integer R R  
ID username_active string R R  
ID username_stored string R R  
ID start_time time R R  
ID end_time time R R  
ID acms_version string R R  
CONFIG config_coll_state integer R R  
CONFIG acms_state integer RW R D
CONFIG acc_priority_active integer R R  
CONFIG acc_priority_stored integer RW RW  
CONFIG max_appl_active integer R R  
CONFIG max_appl_stored integer RW RW  
CONFIG mss_maxobj_active integer R R  
CONFIG mss_maxobj_stored integer RW RW  
CONFIG mss_maxbuf_active integer R R  
CONFIG mss_maxbuf_stored integer RW RW  
CONFIG mss_poolsize_active integer R R  
CONFIG mss_poolsize_stored integer RW RW  
CONFIG mss_process_pool_active integer R R  
CONFIG mss_process_pool_stored integer RW RW  
CONFIG mss_net_retry_timer_active integer RW RW D
CONFIG mss_net_retry_timer_stored integer RW RW  
CONFIG audit_state integer RW RW D
CONFIG username_default_active integer RW RW D
CONFIG username_default_stored integer RW RW  
CONFIG node_name_active integer R R  
CONFIG node_name_stored integer RW RW  
CONFIG ws_poolsize_active integer R R  
CONFIG ws_poolsize_stored integer RW RW  
CONFIG wsc_poolsize_active integer R R  
CONFIG wsc_poolsize_stored integer RW RW  
CONFIG tws_poolsize_active integer R R  
CONFIG tws_poolsize_stored integer RW RW  
CONFIG twsc_poolsize_active integer R R  
CONFIG twsc_poolsize_stored integer RW RW  
RUNTIME runtime_coll_state integer R R  
RUNTIME current_appls gauge R R  
RUNTIME current_users gauge R R  
RUNTIME current_local_users gauge R R  
RUNTIME current_remote_users gauge R R  
RUNTIME appl_starts integer R R  
RUNTIME decnet_object integer R R  
POOL pool_coll_state integer R R  
POOL mss_shared_total integer R R  
POOL mss_shared_free min gauge R R  
POOL mss_shared_largest min gauge R R  
POOL mss_shared_failures integer R R  
POOL mss_shared_garbage integer R R  
POOL mss_process_total integer R R  
POOL mss_process_free min gauge R R  
POOL mss_process_largest min gauge R R  
POOL mss_process_failures integer R R  
POOL mss_process_garbage integer R R  
POOL mss_objects gauge R R  


Key to Access Modes
R---Read Access
RW---Read/Write Access
Blank---Not available to the interface
D---Field is dynamic.


Previous Next Contents Index