| Previous | Contents | Index |
Adds records to the Collection table.
ACMSMGR ADD COLLECTION [/qualifiers]
Command Qualifier Default /CLASS=class-name * (all) /COLL_STATE=keyword DISABLED /ENTITY=[*,entity-name] Qualifier is required. /NAME=[*,entity-name] * (all) /NODE=node-name Translation of logical ACMS$MGMT_SERVER_NODE /USER=user-name Translation of logical ACMS$MGMT_USER
ACMS$MGMT_WRITE
None.
/CLASS=[*, ID, CONFIG, POOL, RUNTIME]
This qualifier specifies the class to be enabled or disabled. The default is * (all). See Section 4.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./ENTITY=[*, ACC, CP, EXC, GROUP, QTI, SERVER, TSC]
This required qualifier specifies the entity or 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 type, 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 an application name and a 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 the server or task group name is wildcarded. For example, VR_APPL is equivalent to VR_APPL.*.
The default is all (*), which is equivalent to *.* for a compound name.
/NODE=node-name
This qualifier specifies a fully or partially qualified TCP/IP node name. To execute the command on more than one node, you can specify the node names in a comma-separated list. The ACMSMGR utility attempts to perform the operation sequentially on each node in the list.If the /NODE qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_SERVER_NODE. If the logical is defined, the value of the logical is used by default.
In order for the command to execute, either the /NODE qualifier must be provided on the command line, or the ACMS$MGMT_SERVER_NODE logical must be defined.
/USER=user-name
This qualifier specifies the name of the OpenVMS account on the server node to be used for authorization. If this qualifier is specified, an explicit login must already have been completed successfully (see Section 10.6).If the /USER qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_USER. If the logical is defined, the value of the logical is used by default.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not defined, the ACMSMGR utility attempts proxy access. See Section 3.4.1.2 for a discussion of proxy access.
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.
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 command ACMSMGR SHOW COLLECTIONS displays weights for each row in the table. See also Section 4.1.1 for a discussion of the Collection table and of how weights are assigned.
Collections begin or end immediately after collection records are added. The Remote Manager signals the appropriate ACMS process as soon as it has reevaluated the Collection table following an addition. Messages are sent to ACMS process using the ACMS Trace Monitor.
ACMS processes read the Collection table during process startup to determine which classes to begin collecting.
The command ACMSMGR SHOW PROCESS can be used to determine the class states for the currently running ACMS processes.
$ ACMSMGR ADD COLL/ENT=EXC/CLASS=RUNTIME/NAME=VR_APPL
|
This command creates an entry in the Collection table. As a result of this command, the VR_APPL will begin collecting run-time information.
10.3 ACMSMGR ADD TRAP
Adds records to the Remote Manager Trap table.
ACMSMGR ADD TRAP [/qualifiers]
Command Qualifier Default /ENTITY=[*,entity-name] Qualifier is required. /NAME=[*,entity-name] * (all) /NODE=node-name Translation of logical ACMS$MGMT_SERVER_NODE /PARAMETER=keyword EXISTS /SEVERITY=[I,W,E,F] E /TRAP_MIN=value -1 /TRAP_MAX=value -1 /USER=user-name Translation of logical ACMS$MGMT_USER
ACMS$MGMT_OPERATE
None.
/ENTITY=[*, ACC, CP, EXC, MGR, QTI, TSC]
This required qualifier specifies the entity or entities for which a trap should be set./NAME=[*, entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*, !) are allowed in names.This field is ignored for the MGR entity.
For ACC, CP, QTI, and TSC entity types, the entity name is the process name. For the EXC entity type, the entity name is the name of the application (for example, VR_APPL).
The default is all (*).
/NODE=node-name
This qualifier specifies a fully or partially qualified TCP/IP node name. To execute the command on more than one node, you can specify the node names in a comma-separated list. The ACMSMGR utility attempts to perform the operation sequentially on each node in the list.If the /NODE qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_SERVER_NODE. If the logical is defined, the value of the logical is used by default.
In order for the command to execute, either the /NODE qualifier must be provided on the command line, or the ACMS$MGMT_SERVER_NODE logical must be defined.
/PARAMETER=[EVENT_SEVERITY, EXISTS]
This parameter specifies the field that should be monitored.
- EVENT_SEVERITY
Internal Remote Manager events are to be monitored. The Remote Manager logs internal events in the Remote Manager log. (See Section 3.7 and Section 10.25 for discussions of the Remote Manager log.) Traps can be generated based on the severity levels of these events.- EXISTS
Process existence is to be monitored. Traps are generated if the associated entity type and name either starts or stops./SEVERITY=[I, W, E, F]
This qualifier specifies the 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), or 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. See Section 8.12.2 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. See Section 8.12.2 for a list of valid values./USER=user-name
This qualifier specifies the name of the OpenVMS account on the server node to be used for authorization. If this qualifier is specified, an explicit login must already have been completed successfully (see Section 10.6).If the /USER qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_USER. If the logical is defined, the value of the logical is used by default.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not defined, the ACMSMGR utility attempts proxy access. See Section 3.4.1.2 for a discussion of proxy access.
When adding new trap records, the combination of entity, name, and parameter must be unique.Traps become active as soon as they are added to the Trap table and the SNMP interface is running.
See Section 8.12.2 for a discussion about setting appropriate trap minimums and maximums. See also Section 8.12.3 for a description of the trap message generated.
$ ACMSMGR ADD TRAP /ENT=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 ACMSMGR DELETE COLLECTION
Deletes records from the Collection table.
ACMSMGR DELETE COLLECTION [/qualifiers]
Command Qualifier Default /CLASS=class-name * (all) /ENTITY=[*,entity-name] Qualifier is required. /NAME=[*,entity-name] * (all) /NODE=node-name Translation of logical ACMS$MGMT_SERVER_NODE /USER=user-name Translation of logical ACMS$MGMT_USER
ACMS$MGMT_WRITE
None.
/CLASS=[*, ID, CONFIG, POOL, RUNTIME]
This qualifier specifies the class to be enabled or disabled. The default is * (all). See Section 4.1.1 for a description of each class type./ENTITY=[*, ACC, CP, EXC, GROUP, QTI, SERVER, TSC]
This required qualifier specifies the entity or 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 type, 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 an application name and a 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 the server or task group name is wildcarded. For example, VR_APPL is equivalent to VR_APPL.*.
The default is all (*), which is equivalent to *.* for a compound name.
/NODE=node-name
This qualifier specifies a fully or partially qualified TCP/IP node name. To execute the command on more than one node, you can specify the node names in a comma-separated list. The ACMSMGR utility attempts to perform the operation sequentially on each node in the list.If the /NODE qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_SERVER_NODE. If the logical is defined, the value of the logical is used by default.
In order for the command to execute, either the /NODE qualifier must be provided on the command line, or the ACMS$MGMT_SERVER_NODE logical must be defined.
/USER=user-name
This qualifier specifies the name of the OpenVMS account on the server node to be used for authorization. If this qualifier is specified, an explicit login must already have been completed successfully (see Section 10.6).If the /USER qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_USER. If the logical is defined, the value of the logical is used by default.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not defined, the ACMSMGR utility attempts proxy access. See Section 3.4.1.2 for a discussion of proxy access.
When deleting collection records, the combination of class, entity, and name must exactly match the row to be deleted.It is not possible to delete records for the ID and CONFIG class. By default, all ACMS processes collect ID and CONFIG class data.
Collections begin or end immediately after collection records are deleted. The Remote Manager signals the appropriate ACMS process as soon as it has reevaluated the Collection table following a deletion. Messages are sent to the ACMS process using the ACMS Trace Monitor.
ACMS processes read the Collection table during process startup to determine which classes to begin collecting.
The ACMSMGR SHOW PROCESS command can be used to determine the class states for the currently running ACMS processes.
$ ACMSMGR DELETE COLL/ENT=EXC/CLASS=RUNTIME/NAME=VR_APPL
|
This command deletes the entry in the Collection table for run-time collection by the VR_APPL application. After the deletion, if there are no other Collection table entries that apply to the run-time class for VR_APPL, run-time collection is disabled.
10.5 ACMSMGR DELETE TRAP
Deletes a record from the trap table.
ACMSMGR DELETE TRAP [/qualifiers]
Command Qualifier Default /ENTITY=[*,entity-name] Qualifier is required. /NAME=[*,entity-name] * (all) /NODE=node-name Translation of logical ACMS$MGMT_SERVER_NODE /PARAMETER=keyword EXISTS /USER=user-name Translation of logical ACMS$MGMT_USER
ACMS$MGMT_OPERATE
None.
/ENTITY=[*, ACC, CP, EXC, MGR, QTI, TSC]
This required qualifier specifies the entity or entities for which a trap should be set./NAME=[*, entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*, !) are allowed in names.For the MGR entity, this field should always be set to asterisk (*).
For ACC, CP, QTI, and TSC entity types, the entity name is the process name. For the EXC entity type, the entity name is the name of the application (for example, VR_APPL).
The default is all (*).
/NODE=node-name
This qualifier specifies a fully or partially qualified TCP/IP node name. To execute the command on more than one node, you can specify the node names in a comma-separated list. The ACMSMGR utility attempts to perform the operation sequentially on each node in the list.If the /NODE qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_SERVER_NODE. If the logical is defined, the value of the logical is used by default.
In order for the command to execute, either the /NODE qualifier must be provided on the command line, or the ACMS$MGMT_SERVER_NODE logical must be defined.
/PARAMETER=[EVENT_SEVERITY, EXISTS]
This parameter specifies the field that should be monitored.
- EVENT_SEVERITY
Internal Remote Manager events are to be monitored. The Remote Manager logs internal events in the Remote Manager log. (See Section 10.25 and Section 3.7 for discussions of the Remote Manager log.) Traps can be generated based on the severity levels of these events.- EXISTS
Process existence is to be monitored. Traps are generated if the associated entity type and name either starts or stops./USER=user-name
This qualifier specifies the name of the OpenVMS account on the server node to be used for authorization. If this qualifier is specified, an explicit login must already have been completed successfully (see Section 10.6).If the /USER qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_USER. If the logical is defined, the value of the logical is used by default.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not defined, the ACMSMGR utility attempts proxy access. See Section 3.4.1.2 for a discussion of proxy access.
When deleting trap records, the combination of entity, name and parameter must exactly match a row in the trap table.Traps become deactive as soon as they are deleted from the Trap table.
$ ACMSMGR DELETE TRAP/ENT=ACC/PARAM=EXISTS
|
This command deletes a trap from the Trap table.
10.6 ACMSMGR LOGIN
Logs in to a server on one or more nodes.
ACMSMGR LOGIN [/qualifiers]
Command Qualifier Default /NODE=node-name Translation of logical ACMS$MGMT_SERVER_NODE /USER=user-name Translation of logical ACMS$MGMT_USER /PASSWORD=password None
ACMS$MGMT_READ
None.
/NODE=node-name
This qualifier specifies a fully or partially qualified TCP/IP node name. To execute the command on more than one node, you can specify the node names in a comma-separated list. The ACMSMGR utility attempts to perform the operation sequentially on each node in the list.If the /NODE qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_SERVER_NODE. If the logical is defined, the value of the logical is used by default.
In order for the command to execute, either the /NODE qualifier must be provided on the command line, or the ACMS$MGMT_SERVER_NODE logical must be defined.
/USER=user-name
This qualifier specifies the name of the OpenVMS account on the server node on which to log in.If the /USER qualifier is not specified, the ACMSMGR utility checks for the presence of the logical name ACMS$MGMT_USER. If the logical is defined, the value of the logical is used by default.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not defined, the ACMSMGR utility prompts the user for a user name. Login cannot be attempted without a user name.
/PASSWORD=password
This qualifier specifies the password of the OpenVMS account on the server node to log in as. It is sent encrypted to the server node for verification.If the /PASSWORD parameter is not specified, the ACMSMGR will prompt the user for a password. Login will not be attempted without a password.
In order to access any remote management functions, a valid login is required if proxy access is not enabled or if proxy accounts have not been set up.A credentials file is created for each node logged in to. Credentials files are specific for a user, process, and node. In addition, a separate credentials file is created for each combination of user name and node. Subsequent ACMSMGR commands pass the authentication information in the appropriate credentials file to the Remote Manager server, which then performs function authorization. Users determine which credentials are used either by using the /USER qualifier or by defining the ACMS$MGMT_USER logical.
For example, suppose user BOB on node CLIENT logs in to node SERV1 as ACMS_ADMIN. Also, suppose user BOB on node CLIENT logs in to node SERV2 as ACMS_USER. BOB will have two active logins (two credentials files). He can specify which one to use by either defining the logical ACMS$MGMT_USER, or specifying a user name using the /USER qualifier.
Logins are valid for the duration of the login_credentials_lifetime parameter (specified using the ACMSMGR SET PARAMETER command).
See Section 3.4 for a complete discussion of how logins are processed and how credentials files are handled.
| #1 |
|---|
$ ACMSMGR LOGIN /NODE=SPARKS /USER=VANPEENEN /PASSWORD=12345678
|
This command logs in user VANPEENEN to node SPARKS.
| #2 |
|---|
$ ACMSMGR LOGIN /NODE=SPARKS,NELSON /USER=VANPEENEN /PASSWORD=12345678
|
This command logs in user VANPEENEN to nodes SPARKS and NELSON.
| #3 |
|---|
$ ACMSMGR LOGIN /USER=VANPEENEN
|
This command logs in user VANPEENEN to the node specified by the logical name ACMS$MGMT_SERVER_NODE. The ACMSMGR utility will prompt the user for the password.
| #4 |
|---|
$ ACMSMGR LOGIN
|
This command logs in the user defined by the logical name ACMS$MGMT_USER to the node specified by the logical name ACMS$MGMT_SERVER_NODE. If the logical name ACMS$MGMT_USER is not defined, the ACMSMGR utility will prompt for the user name. The ACMSMGR utility also will prompt for the password.
| Previous | Next | Contents | Index |