# Compaq ACMS for OpenVMS
Remote Systems Management Guide

Previous | Contents | Index

# 9.15 Users Table

The Users table contains information about users who have logged in to Remote Manager, either explicitly (using a user name and password) or implicitly (using a proxy account). This table is maintained internally by the Remote Manager and is read only to all external entities. Values in the table can be accessed through one of the supported interfaces. External users cannot make changes to this table. In general, the values in this table are informational only.

Table 9-15 Users Table
Field Name | Data Type | SNMP Access | RPC Access | Dynamic
--- | --- | --- | --- | ---
client_id | integer | R | R |
gid | short integer | R | R |
uid | short integer | R | R |
proxy_gid | short integer | R | R |
proxy_uid | short integer | R | R |
nodename | string | R | R |
expires | string | R | R |
uname | string | R | R |
rights | integer array | R | R |
proxy_flag | integer | R | R |

Key to Access Modes

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

## 9.15.1 Field Descriptions

Following are descriptions of the fields in Table 9-15.

- client_id
  Unique number that identifies this client.
- gid
  Group portion of the user's UIC on the client node.
- uid
  User portion of the user's UIC on the client node,
- proxy_gid
  Group portion of the UIC from the proxy account on the server node.
- proxy_uid
  User portion of the UIC from the proxy account on the server node.
- nodename
  Name of client node. This is the only node from which the client ID is valid.
- expires
  Date and time the user log in expires. Full OpenVMS ASCII date (DD-MMM-YYYY HH:MM:SS.hh).
- uname
  Account name of the account being used for authorization. This can be the account name for the proxy.

- rights
  Rights held by the user. This is an array of four elements. The first element contains the ACMS$MGMT_READ rights identifier; the second contains the ACMS$MGMT_WRITE rights identifier; the third contains the ACMS$MGMT_OPER identifier; the fourth contains the ACMS$MGMT_SYSUPD identifier. A value of 0 indicates the user does not hold the right.
- proxy_flag
  A flag indicating whether the user has explicitly logged in (value of 0) or implicitly logged in by means of proxy (value of 1).

# Chapter 10
ACMSCFG Commands

This chapter provides reference information about the commands of the ACMSCFG utility.

Note Certain ACMSCFG commands and qualifiers are designed to configure values for and return values from systems running ACMS Version 4.4 or higher. These commands and qualifiers are denoted with the double dagger (++) symbol in the individual command description sections.

# 10.1 ACMSCFG Overview

The ACMSCFG utility is provided for performing operations on the ACMS Remote Manager configuration file. Similar to the ACMSMGR utility (described in Chapter 11), the ACMSCFG utility performs only a subset of the operations that the ACMSMGR utility performs.

The ACMSCFG utility performs operations on the Remote Manager configuration file only, and only on configuration files that are directly accessible to the process running the utility.

Section 4.2 discusses the purpose and use of the configuration file, as well as file defaults.

## 10.1.1 Command Format

The format for ACMSCFG commands is as follows:

    ACMSCFG verb object qualifiers

The following verbs are supported:

- ADD
- DELETE
- HELP
- SET
- SHOW

Each verb has associated objects. The following sections list the objects and any qualifiers for each ACMSCFG command.

## 10.1.2 Command Objects and Qualifiers

The objects and qualifiers for the ACMSCFG commands are summarized in Table 10-1.

Table 10-1 ACMSCFG Command Objects and Qualifiers
Objects | Qualifiers
--- | ---
ADD Command
COLLECTION | /CLASS, /COLL_STATE, /ENTITY, /NAME, /STORAGE_END_TIME, /STORAGE_INTERVAL, /STORAGE_LOCATION, /STORAGE_START_TIME, /STORAGE_STATE
TRAP | /ENTITY, /NAME, /PARAMETER, /SEVERITY, /TRAP_MIN, /TRAP_MAX
DELETE Command
COLLECTION | /CLASS, /ENTITY, /NAME
TRAP | /ENTITY, /NAME, /PARAMETER
HELP Command
None | None
SET Command
COLLECTION | /CLASS, /COLL_STATE, /ENTITY, /NAME, /STORAGE_END_TIME, /STORAGE_INTERVAL, /STORAGE_LOCATION, /STORAGE_START_TIME, /STORAGE_STATE
INTERFACE | /INTERFACE, /STATE
PARAMETER | /DCL_AUDIT_LEVEL, /DCL_MGR_PRIORITY, /DCL_STACKSIZE, /ERROR_INTERVAL, /EVENT_LOG_PRIORITY, /LOG_STACKSIZE, /LOGIN_CREDS_LIFETIME, /MAX_LOGINS, /MAX_RPC_RETURN_RECS, /MGR_AUDIT_LEVEL, /MSG_PROC_AUDIT_LEVEL, /MSG_PROC_PRIORITY, /MSG_PROC_STACKSIZE, /MSS_COLL_INTERVAL, /PROC_MON_AUDIT_LEVEL, /PROC_MON_INTERVAL, /PROC_MON_PRIORITY, /PROC_MON_STACKSIZE, /PROXY_CREDS_LIFETIME, /RPC_AUDIT_LEVEL, /RPC_PRIORITY, /RPC_STACKSIZE, /SECURITY_AUDIT_LEVEL, /SNAP_AUDIT_LEVEL, /SNAP_PRIORITY, /SNAP_STACKSIZE, /SNMP_AGENT_TIME_OUT, /SNMP_ARE_YOU_THERE, /SNMP_AUDIT_LEVEL, /SNMP_PRIORITY, /SNMP_SEL_TIME_OUT, /SNMP_STACKSIZE, /TCP_ENABLED, /TIMER_AUDIT_LEVEL, /TIMER_INTERVAL, /TIMER_PRIORITY, /TIMER_STACKSIZE, /TOTAL_ENTITY_SLOTS, /TRACE_MSG_WAIT_TIME, /TRACE_START_WAIT_TIME, /TRAP_AUDIT_LEVEL, /TRAP_PRIORITY, /TRAP_STACKSIZE, /UDP_ENABLED, /VMS_COLL_INTERVAL, /WKSP_COLL_INTERVAL
TRAP | /ENTITY, /NAME, /PARAMETER, /SEVERITY, /TRAP_MIN, /TRAP_MAX
SHOW Command
COLLECTION | /BRIEF, /FULL
CONTROL | None
INTERFACE | None
PARAMETER | None
TRAP | None

# 10.2 ACMSCFG ADD COLLECTION

Adds records to the collection table in the configuration file.

## Format

> ### ACMSCFG ADD COLLECTION [/qualifiers]

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

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

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

> This qualifier determines the class that will be enabled or disabled. The default is all (*).

> See Section 5.1.1 for a description of each class type.

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

> This qualifier specifies the state of the collection. The default is DISABLED. When a 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, the data displayed for an entity may not be accurate. 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 entity 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 EXCs, 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 name 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. If this qualifier is not specified, the default keyword of NEVER is applied, 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.

> ### /STORAGE_INTERVAL=value

> This qualifier controls the frequency (in seconds) at which data snapshots are performed. The default value is 300 seconds.

> 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 ACMSCFG utility checks for the presence of the logical name ACMS$MGMT_SNAPSHOT. If the logical is defined, the value of the logical is used by default. 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.

> ### /STORAGE_START_TIME=[NOW, 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. If this qualifier is not specified, the default keyword of NOW is applied, 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.

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

> This qualifier specifies the state of the data snapshots. If this qualifier is not specified, data snapshots are disabled by default. To fully enable data snapshots, both the storage state and the collection state (/COLL_STATE) must be set to ENABLED.

## Notes

> When adding new collection records, the combination of class, entity, and name must be unique.

> It is not possible to add records for the ID and CONFIG class. By default, all ACMS processes collect ID and CONFIG class data.

> 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.

> 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 COLLECTIONS 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.

> See Section 11.2 for a discussion about adding collection records at run time.

## Examples

#1
    $  ACMSCFG ADD COLLECTION/ENTITY=EXC/CLASS=RUNTIME/NAME=VR_APPL

> This command creates an entry in the Collection table in the configuration file. Both the collection state and storage state for this collection are disabled by default; run-time data for EXC is not collected or written to a snapshot file.

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

# 10.3 ACMSCFG ADD TRAP

Adds records to the trap table in the configuration file.

## Format

> ### ACMSCFG ADD TRAP [/qualifiers]

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

## Privileges Required

> None.

## Parameters

> None.

## Qualifiers

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

> This required qualifier determines the 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 name.

> 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.

> ### /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 can be 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 /TRAP_MIN 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 /TRAP_MAX values.

## Notes

> When adding new trap records, the combination of entity, name, and parameter must be unique.

> 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 ADD TRAP /ENTITY=ACC/PARAMETER=EXISTS/TRAP_MIN=1

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

# 10.4 ACMSCFG DELETE COLLECTION

Deletes records from the collection table in the configuration file.

## Format

> ### ACMSCFG DELETE COLLECTION [/qualifiers]

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

## 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.

> ### /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 EXCs, 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.

## Notes

> When deleting collection records, the combination of class, entity, and name must exactly match the row to be deleted. Deleting a collection record automatically terminates all related snapshot threads.

> It is not possible to delete records for the ID and CONFIG class. By default, all ACMS processes collect ID and CONFIG class data.

> When multiple collection records apply to a given process, the records are assigned weights according to a precedence of name, then entity, 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 ACMSMGR SHOW COLLECTIONS command displays weights for each row in the table. See also Section 5.1.1 for a discussion of the Collection table and how weights are assigned.

> See Section 11.5 for a discussion about deleting collection records at run time.

## Examples

#1
    $  ACMSCFG DELETE COLLECTION/ENTITY=EXC/CLASS=RUNTIME/NAME=VR_APPL

> This command deletes the entry in the Collection table for run-time collection by the VR_APPL application.

Previous | Next | Contents | Index