# Compaq ACMS for OpenVMS
Remote Systems Management Guide

Previous | Contents | Index

# 10.5 ACMSCFG DELETE TRAP

Deletes a record from the trap table in the configuration file.

## Format

> ### ACMSCFG DELETE TRAP [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /ENTITY=keyword | None
> /NAME=[*,entity-name] | * (all)
> /PARAMETER=keyword | EXISTS

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ### /ENTITY=[*, ACC, CP, EXC, MGR, QTI, TSC]

> This required qualifier determines the entity or entities for which a trap should be set.

> ### /NAME=[*,entity-name]

> This qualifier specifies particular instances of an entity. In general, the entity name is the process name. The exceptions are the EXC entity and the MGR entity.

> For the EXC entity, use the assigned application names.

> For the MGR entity, you must specify all (*).

> Wildcards (*) are allowed in names. The default qualifier is the asterisk (*) wildcard.

> ### /PARAMETER=[EVENT_SEVERITY,EXISTS]

> The field that should be monitored. Valid values are:
> - EVENT_SEVERITY
>   This parameter is used for monitoring internal Remote Manager events. The Remote Manager logs internal events in the Remote Manager log. (See Section 4.7 and Section 11.33 for discussions of the Remote Manager log.) Traps can be generated based on the severity levels of these events.
> - EXISTS
>   This parameter is used for monitoring process existence. Traps are generated if the associated entity type and name either start or stop.

## Notes

> When deleting trap records, the combination of entity, name, and parameter must exactly match a row in the Trap table.

## Examples

#1
    $  ACMSCFG DELETE TRAP/ENTITY=ACC/PARAMETER=EXISTS

> This command deletes a trap from the Trap table in the configuration file.

# 10.6 ACMSCFG HELP

Displays help information about the ACMS Configuration utility (ACMSCFG) and its commands.

## Format

> ### ACMSCFG HELP

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ###

> None.

## Notes

> Online help is available for each ACMSCFG command. Each help topic summarizes the valid syntax, abbreviations, parameters, and qualifiers for a particular command and also indicates all default and required values.

> For a comprehensive list of ACMS utilities that offer online help or for further instructions on how to invoke help, see ACMS Help.

## Examples

#1
    $  ACMSCFG HELP

> This command invokes online help for the ACMSCFG utility and displays a list of available topics.

# 10.7 ACMSCFG SET COLLECTION

Modifies in the Collection table in the configuration file.

## Format

> ### ACMSCFG SET COLLECTION [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /CLASS=keyword | * (all)
> /COLL_STATE=keyword | None
> /ENTITY=keyword | None
> /NAME=[*,entity-name] | * (all)
> /STORAGE_END_TIME=[NEVER, | None
> /time]++ |
> /STORAGE_INTERVAL=value++ | None
> /STORAGE_LOCATION=file-name++ | Translation of logical ACMS$MGMT_SNAPSHOT
> /STORAGE_START_TIME=[NOW, | None
> /time]++ |
> /STORAGE_STATE=keyword++ | None

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ### /CLASS=[*, CONFIG, ERROR, ID, POOL, RUNTIME]

> This qualifier determines the class that will be enabled or disabled. See Section 5.1.1 for a description of each class type.

> ### /COLL_STATE=[ENABLED, DISABLED]

> This qualifier specifies the state of the collection. When an ACMSMGR SHOW entity command is issued, data for those classes that have their collection state set to ENABLED is displayed. Note that while the collection state is DISABLED, data is not collected. As a result, data cannot be written to the data snapshot file when this qualifier is DISABLED, even when the storage state is ENABLED.

> ### /ENTITY=[*, ACC, CP, EXC, GROUP, QTI, SERVER, TSC]

> This required qualifier determines the entities for which collection should be enabled or disabled.

> ### /NAME=[*,entity-name]

> This qualifier specifies particular instances of an entity. Wildcards (*) are allowed in names.

> For ACC, CP, QTI, and TSC entity types, the entity name is the process name. For the EXC entity, the entity name is the name of the application (for example, VR_APPL).

> Server and task group names can be specified as compound names made up of application name and server or task group name, separated by a period (for example, VR_APPL.VR_READ_SERVER). Either part of server or task group names can be a wildcard (for example, *.VR_READ_SERVER or VR_APPL.*). If only one part of a server or task group name is specified, it is assumed to be the application name, and a wildcard is used as the server or task group name. For example, VR_APPL is equivalent to VR_APPL.*.

> The default is all (*), which is equivalent to *.* for a compound name.

> ### /STORAGE_END_TIME=[NEVER,time]

> This qualifier specifies a time after which the collection data should no longer be written to the snapshot file. The format of time is DD-MMM-YY:hh:mm:ss.nn. Partial dates and times (for example, 10-OCT or 09:00) are supported. The keyword NEVER is also supported, which equates to the OpenVMS zero date of 17-NOV-1858 00:00:00.00. With a value of NEVER, collection data continues to be written to the snapshot file until the storage state is set to DISABLED.

> If this qualifier is not specified, the existing value remains unchanged. This value can be modified dynamically.

> ### /STORAGE_INTERVAL=value

> This qualifier controls the frequency (in seconds) at which data snapshots are performed.

> The storage interval value should be a multiple of the timer interval parameter (SET PARAMETER/TIMER_INTERVAL). The timer interval value determines the minimum elapsed time for many Remote Manager parameters, including the storage interval setting. The relationship of these values determine how often data snapshots are performed, for example:

> - If the timer interval value is greater, its value is used by default. For instance, if the timer interval is 10 and the storage interval is 5, snapshots will be written at 10 second intervals.
> - If the storage interval value is greater and is a multiple of the timer interval, the storage interval value is used. For example, if the timer interval is 10 and the storage interval is 30, snapshots will be written at 30 second intervals.
> - If the storage interval value is greater and is not a multiple of the timer interval, the next multiple of the timer interval value is used. For example, if the timer interval is 10 and the storage interval is 15, snapshots will be written at 20 second intervals.

> ### /STORAGE_LOCATION=file-name

> This qualifier specifies an OpenVMS file specification to which collection data is to be written. The format of file-name is a valid OpenVMS pathname or logical (such as DISK$1:[SYSTEM.SNAPSHOTS] or SYS$SYSTEM:SNAPSHOTS.DAT).

> If the /STORAGE_LOCATION qualifier is not specified, the current value remains unchanged. If a directory is not provided as part of the specification, the file is written to the default directory of the account under which the Remote Manager process is running.

> Multiple collections can share a single snapshot file or be stored in separate files. For continuity, Compaq recommends that EXC, Server, and Task Group collection information be written to the same snapshot file.

> This value can be modified dynamically.

> ### /STORAGE_START_TIME=time

> This qualifier specifies a time after which the collection data should be written to the snapshot file. The format of time is DD-MMM-YY:hh:mm:ss.nn. Partial dates and times (for example, 10-OCT or 09:00) are supported. The keyword NOW is also supported, which equates to the OpenVMS zero date of 17-NOV-1858 00:00:00.00. With a value of NOW, collection data is written to the snapshot file immediately, or as soon as the storage state is set to ENABLED.

> If this qualifier is not specified, the current value remains unchanged. This value can be modified dynamically.

> ### /STORAGE_STATE=[ENABLED, DISABLED]

> This qualifier specifies the state of the data snapshots. To fully enable data snapshots, both the storage state and the collection state (/COLL_STATE) must be set to ENABLED. If this qualifier is not specified, the current value remains unchanged. This value can be modified dynamically.

## Notes

> When updating collection records, the combination of class, entity, and name must exactly match a record in the collection table.

> By default, processes collect only ID and CONFIG class data during process initialization. If these classes were disabled during process startup, that information would not be available until the class was enabled and the process was restarted.

> ACMS processes read the Collection table during process startup to determine which classes to begin collecting. Once the Remote Manager has been started, the ACMSMGR SHOW PROCESS command can be used to determine the class states for the currently running ACMS processes.

> In order for collection data to be written to a snapshot file, the following conditions must be met:

> - A qualifying entity must be running (one with an entity type and name matching fields in the Collection table).
> - The collection state and storage state for that entity must be enabled.
> - The current time must fall between the storage start time and storage end time.

> If all these conditions are met, the Remote Manager opens the snapshot file for shared write operations. The file remains open until the storage state is set to DISABLED or until the snapshot period expires.

> Changes to snapshot values are processed dynamically. Updated storage interval and storage state values are applied immediately; updated storage location and storage end time values are applied during the next snapshot interval.

> When multiple collection records apply to a given process, the records are assigned weights according to a precedence of name, then entity, and then class. Within a column, wildcard entries are weighted less than nonwildcard entries. The row with the highest weight that applies to a process is used. The command ACMSMGR SHOW COLLECTION displays weights for each row in the table. See Section 5.1.1 for a discussion of the Collection table and how weights are assigned.

> In contrast to typical collections, weighting for data snapshot threads does not apply. Therefore, it is possible for redundant collection data to be written to one or more snapshot files. If multiple collection records compile overlapping data, and each has their storage state set to ENABLED, each record writes data to the designated snapshot file.

## Examples

#1
    $  ACMSCFG SET COLLECTION/ENTITY=EXC/CLASS=RUNTIME/NAME=VR_APPL/COLL_STATE=DISABLED

> This command disables run-time data collection for the VR_APPL application.

Note #### ++ Only for use on systems running ACMS Version 4.4 or higher.

# 10.8 ACMSCFG SET INTERFACE

Allows Remote Manager interfaces to be enabled or disabled in the configuration file.

## Format

> ### ACMSCFG SET INTERFACE [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /INTERFACE=interface | None
> /STATE=keyword | DISABLED

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ### /INTERFACE=interface

> This required qualifier determines which interface to modify. Valid values are:
> - RPC
> - SNMP

> ### /STATE=[DISABLED, ENABLED]

> This qualifier determines the operation to perform. If the value supplied is ENABLED, the interface will be started (if it is not already running). If the value supplied is DISABLED, the interface will be stopped.

## Notes

> The ACMSMGR uses the RPC interface. Stopping an interface disables communication to the Remote Manager through that interface. Stopping the RPC interface on a given node prevents ACMSMGR from communicating with the Remote Manager on that node.

## Examples

#1
    $  ACMSCFG SET INTERFACE/INTERFACE=SNMP/STATE=DISABLED
    ACMS Remote Management Option -- Command line utility
    Call to modify interface on server sparks was executed
    %ACMSMGMT-S-SUCCESS, Operation completed

> This command stops the SNMP interface on the node specified by the logical name ACMS$MGMT_SERVER_NODE.

# 10.9 ACMSCFG SET PARAMETER

Allows Remote Manager parameters to be updated in the configuration file.

## Format

> ### ACMSMGR SET PARAMETER [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /DCL_AUDIT_LEVEL=value | None
> /DCL_MGR_PRIORITY=value | None
> /DCL_STACKSIZE=value | None
> /ERROR_INTERVAL=value++ | None
> /EVENT_LOG_PRIORITY=value | None
> /LOG_STACKSIZE=value | None
> /LOGIN_CREDS_LIFETIME=value | None
> /MAX_LOGINS=value | None
> /MAX_RPC_RETURN_RECS=value | None
> /MGR_AUDIT_LEVEL=value | None
> /MSG_PROC_AUDIT_LEVEL=value | None
> /MSG_PROC_PRIORITY=value | None
> /MSG_PROC_STACKSIZE=value | None
> /MSS_COLL_INTERVAL=value | None
> /PROC_MON_AUDIT_LEVEL=value | None
> /PROC_MON_INTERVAL=value | None
> /PROC_MON_PRIORITY=value | None
> /PROC_MON_STACKSIZE=value | None
> /PROXY_CREDS_LIFETIME=value | None
> /RPC_AUDIT_LEVEL=value | None
> /RPC_PRIORITY=value | None
> /RPC_STACKSIZE=value | None
> /SECURITY_AUDIT_LEVEL=value | None
> /SNAP_AUDIT_LEVEL=value++ | None
> /SNAP_PRIORITY=value++ | None
> /SNAP_STACKSIZE=value++ | None
> /SNMP_AGENT_TIME_OUT | None
> /SNMP_ARE_YOU_THERE=value | None
> /SNMP_AUDIT_LEVEL=value | None
> /SNMP_PRIORITY=value | None
> /SNMP_SEL_TIME_OUT=value | None
> /SNMP_STACKSIZE=value | None
> /TCP_ENABLED=value++ | None
> /TIMER_AUDIT_LEVEL=value | None
> /TIMER_INTERVAL=value | None
> /TIMER_PRIORITY=value | None
> /TIMER_STACKSIZE=value | None
> /TOTAL_ENTITY_SLOTS=value | None
> /TRACE_MSG_WAIT_TIME=value | None
> /TRACE_START_WAIT_TIME=value | None
> /TRAP_AUDIT_LEVEL=value | None
> /TRAP_PRIORITY=value | None
> /TRAP_STACKSIZE=value | None
> /UDP_ENABLED=value++ | None
> /VMS_COLL_INTERVAL=value++ | None
> /WKSP_COLL_INTERVAL=value | None

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ### /[parameter]=value

> All qualifiers correspond directly to fields in the Parameter table. See Section 9.9.1 for descriptions of each field.

## Notes

> See Section 9.9 for a description of each parameter.

## Example

    $  ACMSCFG SET PARAMETER /MGR_AUDIT_LEVEL=E

> This command modifies the dynamic parameter field mgr_audit_level.

Note #### ++ Only for use on systems running ACMS Version 4.4 or higher.

# 10.10 ACMSCFG SET TRAP

Updates records in the Trap table in the configuration file.

## Format

> ### ACMSCFG SET TRAP [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /ENTITY=keyword | None
> /NAME=[*,entity-name] | * (all)
> /PARAMETER=keyword | EXISTS
> /SEVERITY=[I,W,E,F] | None
> /TRAP_MIN=value | None
> /TRAP_MAX=value | None

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

> ### /ENTITY=[*, ACC, CP, EXC, MGR, QTI, TSC]

> This required qualifier determines the entity or entities for which a trap should be set.

> ### /NAME=[*,entity-name]

> This qualifier specifies particular instances of an entity. Specify the value of the name field for the record you wish to modify.

> ### /PARAMETER=[EVENT_SEVERITY, EXISTS]

> The field that should be monitored. Valid values are:
> - EVENT_SEVERITY
>   This parameter is used for monitoring internal Remote Manager events. The Remote Manager logs internal events in the Remote Manager log. (See Section 4.7 and Section 11.33 for discussions of the Remote Manager log.) Traps can be generated based on the severity levels of these events.
> - EXISTS
>   This parameter is used for monitoring process existence. Traps are generated if the associated entity type and name either starts or stops.

> ### /SEVERITY=[I,W,E,F]

> A severity to be associated with the trap. Severity codes are embedded in the trap message and must be parsed by the trap receiver. Severities are informational (I), warning (W), error (E), and fatal (F).

> ### /TRAP_MIN=value

> This qualifier specifies the minimum allowable value for the parameter being monitored. A trap is generated if the parameter value is less than the minimum value. See Table 9-12 for a list of valid values.

> ### /TRAP_MAX=value

> This qualifier specifies the maximum allowable value for the parameter being monitored. A trap is generated if the parameter value is greater than the maximum value. See Table 9-12 for a list of valid values.

## Notes

> When updating trap records, the combination of entity, name, and parameter must exactly match a record in the trap table.

> See Section 9.13.2 for a discussion about setting appropriate trap minimums and maximums. See Section 9.13.3 for a description of the trap message generated.

## Examples

#1
    $  ACMSCFG SET TRAP /ENTITY=QTI/PARAMETER=EXISTS/TRAP_MAX=0

> This command causes an SNMP trap to be generated whenever the QTI process is started if the SNMP interface is running.

# 10.11 ACMSCFG SHOW COLLECTION

Displays Collection table data from the configuration file.

## Format

> ### ACMSCFG SHOW COLLECTION [/qualifiers]

> Command Qualifier | Default
> --- | ---
> /[BRIEF,FULL] | /BRIEF

## Privileges Required

> None.

## Parameters

> None.

## Qualifier

> ### /[BRIEF,FULL]

> This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to be displayed. The default is /BRIEF.

> Note that storage start and end times for data snapshots are only visible when /FULL is provided. When not specified, the resulting summary display may contain truncated values for some of the longer fields (such as, entity name and storage location).

## Notes

> See Section 9.3 for a discussion of each field displayed. See Section 5.1 for a discussion of collections.

## Examples

#1
    $  ACMSCFG SHOW COLLECTION
    Entity                 Collect  Collect                       Storage   Storage
    Type    Entity Name    Class    State    Storage location     State     Interval
    ------- -------------- -------- -------- -------------------  --------- --------
    *       *              id       enabled  acms$mgmt_snapshot   enabled   3600
    *       *              config   enabled  acms$mgmt_snapshot   disabled  3600
    *       *              runtime  enabled  acms$mgmt_snapshot   disabled  10
    *       *              pool     enabled  acms$mgmt_snapshot   disabled  10
    *       *              error    enabled  acms$mgmt_snapshot   disabled  10

> This command shows the current contents of the Collection table as stored in the configuration file.

Previous | Next | Contents | Index