HP ACMS For Open VMS Remote Systems Management Guide
HP ACMS For Open VMS Remote Systems Management Guide
January 2006
Hewlett-Packard Company
Palo Alto, California
© Copyright 2006 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP required for possession, use or copying.
Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software
Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government
under vendor’s standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP
products and services are set forth in the express warranty statements accompanying such products
and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors, or omissions contained herein.
Motif is a registered trademark of The Open Group.
Oracle is a registered US trademark of Oracle Corporation, Redwood City, California.
Oracle CODASYL DBMS, Oracle CDD/Administrator, Oracle CDD/Repository, Oracle Rdb, Oracle
SQL/Services, Oracle Trace, and Oracle Trace Collector are registered US trademarks of Oracle
Corporation, Redwood City, California.
Printed in the US
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Part I Introduction
iii
2.5.1 Problems Starting ACMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–19
2.5.2 Problems Starting the ACMS Remote Manager . . . . . . . . . . . . . . . . . . 2–20
2.5.2.1 ACMS$MGMT_SERVER.OUT Messages . . . . . . . . . . . . . . . . . . . . 2–20
2.5.2.2 Remote Manager Log Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–21
2.5.3 Problems with the ACMSMGR Utility . . . . . . . . . . . . . . . . . . . . . . . . . 2–23
2.5.3.1 ACMSMGMT-W-NOCLNT_ATTACH Messages . . . . . . . . . . . . . . . 2–23
2.5.3.2 ACMSMGR Hangs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–23
iv
4.6.1 Using ACMSCFG to Modify Management Parameters . . . . . . . . . . . . . 4–9
4.6.2 Using ACMSMGR to Modify Management Parameters . . . . . . . . . . . . 4–10
4.7 Managing the Remote Manager Log File . . . . . . . . . . . . . . . . . . . . . . . . . . 4–10
4.7.1 Setting Audit Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–10
4.7.2 Displaying Audit Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–12
4.7.3 Resetting the Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–13
v
6 Management Programming Using ONC RPC
6.1 ONC RPC Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–1
6.2 Building Multithreaded Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–4
6.3 API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–4
6.4 Initialization and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–4
6.4.1 Initialization Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–5
6.5 Get Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–6
6.5.1 Get Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–6
6.6 List Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–7
6.6.1 Linked List Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–8
6.7 Set Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–11
6.7.1 Set Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–12
6.8 Delete Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–13
6.8.1 Delete Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–13
6.9 Add Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–14
6.9.1 Add Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–14
6.10 Start, Stop, and Replace Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–15
6.10.1 Start Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–16
8 Management APIs
8.1 Common RPC Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–1
8.1.1 Collection Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–1
8.1.2 Interface Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8.1.3 Enable States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8.1.4 Entity Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8.1.5 Facility Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
8.1.6 Running States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
8.1.7 Severity Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
vi
8.1.8 Trap Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–4
8.2 Thread-Safe and Non-Thread Safe Clients . . . . . . . . . . . . . . . . . . . . . . . . . 8–4
8.3 ACMSMGMT_ADD_COLLECTION_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–5
8.4 ACMSMGMT_ADD_ERR_FILTER_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–8
8.5 ACMSMGMT_ADD_TRAP_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–11
8.6 ACMSMGMT_DELETE_COLLECTION_1 . . . . . . . . . . . . . . . . . . . . . . . . . 8–14
8.7 ACMSMGMT_DELETE_ERR_FILTER_2 . . . . . . . . . . . . . . . . . . . . . . . . . . 8–17
8.8 ACMSMGMT_DELETE_TRAP_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–19
8.9 ACMSMGMT_GET_ACC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–22
8.10 ACMS$MGMT_GET_CREDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–24
8.11 ACMSMGMT_GET_ERR_FILTER_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–27
8.12 ACMSMGMT_GET_MGR_STATUS_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–30
8.13 ACMSMGMT_GET_PARAM_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–33
8.14 ACMSMGMT_GET_QTI_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–35
8.15 ACMSMGMT_GET_TSC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–37
8.16 ACMSMGMT_GET_VERSION_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–39
8.17 ACMSMGMT_LIST_AGENT_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–41
8.18 ACMSMGMT_LIST_COLLECTIONS_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–45
8.19 ACMSMGMT_LIST_CP_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–49
8.20 ACMSMGMT_LIST_ERR_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–53
8.21 ACMSMGMT_LIST_EXC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–59
8.22 ACMSMGMT_LIST_INTERFACES_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–63
8.23 ACMSMGMT_LIST_LOG_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–66
8.24 ACMSMGMT_LIST_PROC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–72
8.25 ACMSMGMT_LIST_SERVER_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–77
8.26 ACMSMGMT_LIST_TG_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–81
8.27 ACMSMGMT_LIST_TRAP_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–85
8.28 ACMSMGMT_LIST_USERS_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–88
8.29 ACMSMGMT_REPLACE_SERVER_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–94
8.30 ACMSMGMT_RESET_LOG_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–98
8.31 ACMSMGMT_RESET_ERR_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–100
8.32 ACMSMGMT_SAVE_ERR_FILTER_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–102
8.33 ACMSMGMT_SET_ACC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–106
8.34 ACMSMGMT_SET_AGENT_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–112
8.35 ACMSMGMT_SET_COLLECTION_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–117
8.36 ACMSMGMT_SET_CP_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–120
8.37 ACMSMGMT_SET_EXC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–123
8.38 ACMSMGMT_SET_INTERFACE_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–128
8.39 ACMSMGMT_SET_PARAM_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–131
8.40 ACMSMGMT_SET_QTI_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–134
8.41 ACMSMGMT_SET_SERVER_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–140
8.42 ACMSMGMT_SET_TRAP_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–145
8.43 ACMSMGMT_SET_TSC_2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–148
8.44 ACMSMGMT_START_ACC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–154
8.45 ACMSMGMT_START_EXC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–158
8.46 ACMSMGMT_START_QTI_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–162
8.47 ACMSMGMT_START_TRACE_MONITOR_1 . . . . . . . . . . . . . . . . . . . . . . . 8–166
8.48 ACMSMGMT_START_TSC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–169
8.49 ACMSMGMT_STOP_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–173
8.50 ACMSMGMT_STOP_ACC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–175
8.51 ACMSMGMT_STOP_EXC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–179
8.52 ACMSMGMT_STOP_QTI_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–183
8.53 ACMSMGMT_STOP_TRACE_MONITOR_1 . . . . . . . . . . . . . . . . . . . . . . . . 8–187
8.54 ACMSMGMT_STOP_TSC_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–190
vii
9 Remote Manager Reference Tables
9.1 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–2
9.2 ACC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–3
9.2.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–6
9.3 Agent Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–12
9.3.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–15
9.4 Collection Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–21
9.4.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–21
9.5 CP Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–23
9.5.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–26
9.6 Error Filter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–30
9.6.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–31
9.7 EXC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–31
9.7.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–34
9.8 Interfaces Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–40
9.8.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–41
9.9 Manager Status Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–42
9.9.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–42
9.10 Parameter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–43
9.10.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–45
9.11 QTI Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–49
9.11.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–51
9.12 Server Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–54
9.12.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–55
9.13 Task Group Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–56
9.13.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–57
9.14 Trap Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–58
9.14.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–59
9.14.2 Valid Trap Minimums and Maximums . . . . . . . . . . . . . . . . . . . . . . . . . 9–60
9.14.3 SNMP Trap Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–61
9.15 TSC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–62
9.15.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–64
9.16 Users Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–67
9.16.1 Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–68
10 ACMSCFG Commands
10.1 ACMSCFG Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–1
10.1.1 Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–1
10.1.2 Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–2
10.2 ACMSCFG ADD COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–4
10.3 ACMSCFG ADD TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–8
10.4 ACMSCFG DELETE COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–10
10.5 ACMSCFG DELETE TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–12
10.6 ACMSCFG HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–14
10.7 ACMSCFG SET COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–15
10.8 ACMSCFG SET INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–19
10.9 ACMSCFG SET PARAMETER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–20
10.10 ACMSCFG SET TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–22
10.11 ACMSCFG SHOW COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–24
10.12 ACMSCFG SHOW CONTROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–25
10.13 ACMSCFG SHOW INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–26
10.14 ACMSCFG SHOW PARAMETER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–27
10.15 ACMSCFG SHOW TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–29
viii
11 ACMSMGR Commands
11.1 ACMSMGR Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–1
11.1.1 Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–1
11.1.2 Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–2
11.2 ACMSMGR ADD COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–7
11.3 ACMSMGR ADD FILTER‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–11
11.4 ACMSMGR ADD TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–13
11.5 ACMSMGR DELETE COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–16
11.6 ACMSMGR DELETE FILTER‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–18
11.7 ACMSMGR DELETE TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–20
11.8 ACMSMGR HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–22
11.9 ACMSMGR LOGIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–23
11.10 ACMSMGR LOGOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–25
11.11 ACMSMGR REPLACE SERVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–27
11.12 ACMSMGR RESET ERROR‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–29
11.13 ACMSMGR RESET LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–31
11.14 ACMSMGR SAVE FILTER‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–33
11.15 ACMSMGR SET ACC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–35
11.16 ACMSMGR SET AGENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–40
11.17 ACMSMGR SET COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–42
11.18 ACMSMGR SET CP‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–46
11.19 ACMSMGR SET EXC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–48
11.20 ACMSMGR SET INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–51
11.21 ACMSMGR SET PARAMETER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–53
11.22 ACMSMGR SET QTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–56
11.23 ACMSMGR SET SERVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–59
11.24 ACMSMGR SET TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–62
11.25 ACMSMGR SET TSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–64
11.26 ACMSMGR SHOW ACC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–68
11.27 ACMSMGR SHOW AGENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–73
11.28 ACMSMGR SHOW COLLECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–78
11.29 ACMSMGR SHOW CP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–80
11.30 ACMSMGR SHOW ERROR‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–83
11.31 ACMSMGR SHOW EXC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–86
11.32 ACMSMGR SHOW FILTER‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–89
11.33 ACMSMGR SHOW GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–91
11.34 ACMSMGR SHOW INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–94
11.35 ACMSMGR SHOW LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–96
11.36 ACMSMGR SHOW MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–101
11.37 ACMSMGR SHOW PARAMETER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–103
11.38 ACMSMGR SHOW PROCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–106
11.39 ACMSMGR SHOW QTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–109
11.40 ACMSMGR SHOW SERVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–112
11.41 ACMSMGR SHOW TRAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–115
11.42 ACMSMGR SHOW TSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–117
11.43 ACMSMGR SHOW USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–121
11.44 ACMSMGR SHOW VERSION‡ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–124
11.45 ACMSMGR START EXC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–126
11.46 ACMSMGR START QTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–128
11.47 ACMSMGR START SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–130
11.48 ACMSMGR START TERMINALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–132
11.49 ACMSMGR START TRACE_MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . 11–134
11.50 ACMSMGR STOP EXC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–136
11.51 ACMSMGR STOP MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–138
ix
11.52 ACMSMGR STOP QTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–140
11.53 ACMSMGR STOP SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–142
11.54 ACMSMGR STOP TERMINALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–144
11.55 ACMSMGR STOP TRACE_MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–146
12 ACMSSNAP Commands
12.1 ACMSSNAP Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–1
12.1.1 Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–1
12.1.2 Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–2
12.2 ACMSSNAP CLOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–4
12.3 ACMSSNAP EXIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–5
12.4 ACMSSNAP HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–6
12.5 ACMSSNAP NEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–7
12.6 ACMSSNAP OPEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–8
12.7 ACMSSNAP PREV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–10
12.8 ACMSSNAP QUIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–11
12.9 ACMSSNAP RESET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–12
12.10 ACMSSNAP SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–13
12.11 ACMSSNAP TRACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–17
Index
Figures
1–1 ACMS Remote Manager Architecture . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
3–1 Remote Manager Web Agent Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–6
3–2 Select Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8
3–3 Show TSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9
3–4 Set ACC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
3–5 Add Error Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–11
6–1 ONC RPC Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
6–2 ONC RPC Programming Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
6–3 Linked List: Return Structure and Construction . . . . . . . . . . . . . . . . . 6–10
7–1 SNMP Program Interface with Remote Manager . . . . . . . . . . . . . . . . . 7–2
x
Tables
3–1 Remote Manager Web Agent Conventions . . . . . . . . . . . . . . . . . . . . . . 3–7
4–1 Audit Level Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–11
4–2 Auditing Levels and Their Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–11
4–3 Auditing Level Combinations and Their Values . . . . . . . . . . . . . . . . . . 4–12
5–1 Example 1: Collection with Wildcards . . . . . . . . . . . . . . . . . . . . . . . . 5–3
5–2 Example 2: Collection with Wildcards . . . . . . . . . . . . . . . . . . . . . . . . 5–4
6–1 Procedures for Accessing Remote Manager Functions . . . . . . . . . . . . . 6–3
6–2 Get Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–6
6–3 List Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–7
6–4 Set Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–11
6–5 Delete Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–13
6–6 Add Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–14
6–7 Start, Stop, and Replace Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . 6–16
7–1 Static Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–6
7–2 EXC Table (OID 1.3.6.1.4.1.36.2.18.48.13) . . . . . . . . . . . . . . . . . . . . . . 7–7
7–3 Server Table (OID 1.3.6.1.4.1.36.2.18.48.13) . . . . . . . . . . . . . . . . . . . . 7–7
7–4 Task Group Table (OID 1.3.6.1.4.1.36.2.18.48.13) . . . . . . . . . . . . . . . . . 7–8
7–5 Remote Manager eSNMP Routines Return Codes . . . . . . . . . . . . . . . . 7–12
8–1 Collection Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8–2 Interface Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8–3 Enable States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8–4 Entity Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–2
8–5 Facility Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
8–6 Running States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
8–7 Severity Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–4
8–8 Trap Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–4
9–1 ACC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–3
9–2 Agent Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–12
9–3 Collection Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–21
9–4 CP Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–23
9–5 Error Filter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–30
9–6 EXC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–31
9–7 Interfaces Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–40
9–8 Manager Status Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–42
9–9 Parameter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–43
9–10 QTI Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–49
9–11 Server Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–54
9–12 Task Group Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–56
9–13 Trap Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–58
9–14 Trap Minimums and Maximums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–61
9–15 TSC Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–62
9–16 Users Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–68
10–1 ACMSCFG Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . . 10–2
11–1 ACMSMGR Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . . 11–2
12–1 ACMSSNAP Command Objects and Qualifiers . . . . . . . . . . . . . . . . . . 12–2
xi
B–1 RPC Procedures and Corresponding Rights Identifiers . . . . . . . . . . . . B–1
xii
Preface
This manual explains how to use the Remote Manager to manage local and
remote systems running HP ACMS for OpenVMS (ACMS) software. The manual
describes the features of the Remote Manager and explains how to use those
features to manage ACMS systems as well as the Remote Manager itself. It also
provides reference information for the utilities and commands you use in working
with the Remote Manager.
Intended Audience
This manual is intended for ACMS system managers.
Document Structure
The chapters in this manual are grouped into two main sections (parts). The
first part describes the installation, configuration, and use of the Remote
Manager application (through the supported interfaces) and the Remote Manager
web agent. The second part contains associated API and command reference
information.
Part I Introduction
Chapter 1 Introduces the architecture, implementation, and capabilities of ACMS
remote management.
Chapter 2 Describes how to get started using the Remote Manager including
preparation and startup of the server and client nodes; setting up
TCP/IP; setting up SNMP; and troubleshooting the Remote Manager.
Chapter 3 Describes how to get started using the Remote Manager web agent
including installation of the web agent and associated software,
overview of the browser interface, and general troubleshooting tips.
Chapter 4 Describes how to manage the ACMS Remote Manager including
configuring startup; starting, stopping, and logging in to the Remote
Manager; starting and stopping interfaces; and modifying management
parameters and log files.
Chapter 5 Describes how to use the Remote Manager to manage ACMS, including
managing data collection, displaying collected data, and modifying
ACMS systems.
xiii
Chapter 6 Describes how programmers can use the Open Network Computing
(ONC) remote procedure call (RPC) interface to the ACMS Remote
Manager to develop their own programs for managing ACMS systems.
Chapter 7 Describes how programmers can use the Simple Network Management
Protocol (SNMP) interface to the ACMS Remote Manager to develop
their own programs for managing ACMS systems.
Part II Reference Information
Chapter 8 Provides reference information about the ACMS remote management
APIs, which are procedures that are intended to be called from ONC
RPC clients.
Chapter 9 Provides reference information about data types and tables for the
ACMS Remote Manager.
Chapter 10 Provides reference information about the commands of the ACMSCFG
utility for performing operations on the Remote Manager configuration
file.
Chapter 11 Provides reference information about the commands of the ACMSMGR
utility for performing operations on running ACMS systems.
Chapter 12 Provides reference information about the commands of the ACMSSNAP
utility for performing operations on Remote Manager data snapshot
files.
Appendixes
Appendix A Contains information about the logical names used by the Remote
Manager server and the Remote Manager client (ACMSMGR utility).
Appendix B Contains information providing cross-references of remote procedure
call (RPC) procedures to rights identifiers.
Appendix C Lists all error messages related to the Remote Manager server process,
as well as the ACMSCFG, ACMSMGR, and ACMSSNAP utilities.
ACMS Help
ACMS and its components provide extensive online help.
• DCL level help
Enter HELP ACMS at the DCL prompt for complete help about the ACMS
command and qualifiers, and for other elements of ACMS for which
independent help systems do not exist. DCL level help also provides
brief help messages for elements of ACMS that contain independent help
systems (such as the ACMS utilities) and for related products used by ACMS
(such as HP DECforms or Oracle CDD/Repository).
• ACMS utilities help
Each of the following ACMS utilities has an online help system:
ACMS Debugger
ACMSGEN Utility
ACMS Remote Manager Configuration Utility (ACMSCFG)
ACMS Remote Manager Client (ACMSMGR)
ACMS Remote Manager Data Snapshot Utility (ACMSSNAP)
ACMS Queue Manager (ACMSQUEMGR)
Application Definition Utility (ADU)
Application Authorization Utility (AAU)
Device Definition Utility (DDU)
User Definition Utility (UDU)
Audit Trail Report Utility (ATR)
Software Event Log Utility Program (SWLUP)
xiv
The two ways to get utility-specific help are:
Run the utility and type HELP at the utility prompt.
Use the DCL HELP command. At the ‘‘Topic?’’ prompt, type @ followed by
the name of the utility. Use the ACMS prefix, even if the utility does not
have an ACMS prefix (except for SWLUP). For example:
Topic? @ACMSQUEMGR
Topic? @ACMSADU
However, do not use the ACMS prefix with SWLUP:
Topic? @SWLUP
Note that if you run the ACMS Debugger Utility and then type HELP, you
must specify a file. If you ask for help from the DCL level with @, you do not
need to specify a file.
• ACMSPARAM.COM and ACMSEXCPAR.COM help
Help for the command procedures that set parameters and quotas is a subset
of the DCL level help. You have access to this help from the DCL prompt, or
from within the command procedures.
• LSE help
ACMS provides ACMS-specific help within the LSE templates that assist
in the creation of applications, tasks, task groups, and menus. The ACMS-
specific LSE help is a subset of the ADU help system. Within the LSE
templates, this help is context-sensitive. Type HELP/IND (PF1-PF2) at any
placeholder for which you want help.
• Error help
ACMS and each of its utilities provide error message help. Use HELP ACMS
ERRORS from the DCL prompt for ACMS error message help. Use HELP
ERRORS from the individual utility prompts for error message help for that
utility.
• Terminal user help
At each menu within an ACMS application, ACMS provides help about
terminal user commands, special key mappings, and general information
about menus and how to select tasks from menus.
• Forms help
For complete help for HP DECforms or HP TDMS, use the help systems for
these products.
Related Documents
The following table lists the books in the HP ACMS for OpenVMS documentation
set.
HP ACMS Version 5.0 for OpenVMS Information about the latest release of the software
Release Notes†
xv
ACMS Information Description
HP ACMS Version 5.0 for OpenVMS Description of installation requirements, the installation
Installation Guide procedure, and postinstallation tasks.
HP ACMS for OpenVMS Getting Overview of ACMS software and documentation.
Started Tutorial for developing a simple ACMS application.
Description of the AVERTZ sample application.
HP ACMS for OpenVMS Concepts Description of how to design an ACMS application.
and Design Guidelines
HP ACMS for OpenVMS Writing Description of how to write task, task group, application, and
Applications menu definitions using the Application Definition Utility.
Description of how to write and migrate ACMS applications on
an OpenVMS Alpha system.
HP ACMS for OpenVMS Writing Description of how to write programs to use with tasks and
Server Procedures how to debug tasks and programs.
Description of how ACMS works with the APPC/LU6.2
programming interface to communicate with IBM CICS
applications.
Description of how ACMS works with third-party database
managers, with ORACLE used as an example.
HP ACMS for OpenVMS Systems Description of using Systems Interface (SI) Services to submit
Interface Programming tasks to an ACMS system.
HP ACMS for OpenVMS ADU Reference information about the ADU commands, phrases,
Reference Manual and clauses.
HP ACMS for OpenVMS Quick List of ACMS syntax with brief descriptions.
Reference
HP ACMS for OpenVMS Managing Description of authorizing, running, and managing ACMS
Applications applications, and controlling the ACMS system.
HP ACMS for OpenVMS Remote Description of the features of the Remote Manager for
Systems Management Guide managing ACMS systems, how to use the features, and how to
manage the Remote Manager.
Online help† Online help about ACMS and its utilities.
http://h71000.www7.hp.com/openvms
Reader’s Comments
HP welcomes your comments on this manual.
Print or edit the online form SYS$HELP:OPENVMSDOC_COMMENTS.TXT and
send us your comments by:
Internet [email protected]
Mail Hewlett-Packard Company
OSSG Documentation Group, ZKO3-4/U08
110 Spit Brook Rd.
Nashua, NH 03062-2698
xvi
How To Order Additional Documentation
Use the following World Wide Web address for information about how to order
additional documentation:
http://www.hp.com/go/openvms/doc
To reach the OpenVMS documentation website, click the Documentation link.
If you need help deciding which documentation best meets your needs, call
1–800–ATCOMPA.
Conventions
The following conventions are used in this manual:
Ctrl/x A sequence such as Ctrl/x indicates that you must press and
hold the key labeled Ctrl while you press another key or a
pointing device button.
PF1 x A sequence such as PF1 x indicates that you must first press
and release the key labeled PF1 and then press and release
another key or a pointing device button.
Return In examples, a key name enclosed in a box indicates that
you press a key on the keyboard. (In text, a key name is not
enclosed in a box.)
In the HTML version of this document, this convention appears
as brackets rather than a box.
... A horizontal ellipsis in examples indicates one of the following
possibilities:
• Additional optional arguments in a statement have been
omitted.
• The preceding item or items can be repeated one or more
times.
• Additional parameters, values, or other information can be
entered.
xvii
bold text Bold text represents the introduction of a new term or the
name of an argument, an attribute, or a reason.
In the HMTL version of this document, this text style may
appear as italics.
italic text Italic text indicates important information, complete titles
of manuals, or variables. Variables include information that
varies in system output (Internal error number), in command
lines (/PRODUCER=name), and in command parameters in
text (where dd represents the predefined code for the device
type).
UPPERCASE Uppercase text indicates the name of a routine, the name of a
file, the name of a file protection code, or the abbreviation for a
system privilege.
In command format descriptions, uppercase text is an optional
keyword.
UPPERCASE In command format descriptions, uppercase text that is
underlined is a required. You must include it in the statement
if the clause is used.
lowercase In command format descriptions, a lowercase word indicates a
required element.
<lowercase> In command format descriptions, lowercase text in angle
brackets indicates a required clause or phrase.
() In command format descriptions, parentheses indicate that you
must enclose the options in parentheses if you choose more
than one.
[] In command format descriptions, brackets indicate optional
elements. You can choose one, none, or all of the options.
(Brackets must be included, however, in the syntax of a
directory name in an OpenVMS file specification or in
the syntax of a substring specification in an assignment
statement.)
[|] In command format descriptions, vertical bars separating items
inside brackets indicate that you choose one, none, several, or
all of the options.
{} In command format descriptions, braces indicate required
elements; you must choose one of the options listed.
[| |] In command format descriptions, vertical bars within square
brackets indicate that you can choose any combination of the
enclosed options, but you can choose each option only once.
{| |} In command format descriptions, vertical bars within braces
indicate that you must choose one of the options listed, but you
can use each option only once.
References to Products
The ACMS documentation set to which this manual belongs often refers to certain
products by abbreviated names:
Abbreviation Product
ACMS HP ACMS for OpenVMS Alpha, and HP ACMS for OpenVMS I64
Ada HP Ada for OpenVMS Alpha Systems, and HP Ada for OpenVMS I64
Systems
BASIC HP BASIC for OpenVMS
xviii
Abbreviation Product
xix
Part I
Introduction
Part I contains information about configuring and using the remote management
features of ACMS. It contains an overview of the Remote Manager as well as
information on how it is managed and operates.
Chapter 2 and Chapter 3 describe how to install and configure both the Remote
Manager and the Remote Manager web agent. Chapter 4 and Chapter 5 explain
how to manage data collection and how to use the Remote Manager to modify a
running ACMS system.
Finally, Chapter 6 and Chapter 7 show you how to write programs that perform
remote management using RPC and SNMP.
1
Overview of Remote Management
Web
Browser http://managed-element-URL
RPC ACMSGEN
SNMP
DCL ACMS
Subprocess Process
Using SNMP or RPC commands, ACMS system managers can configure and
control the system data being collected, automatic variable monitoring, and
operation of the interfaces themselves.
Communications between the ACMS Remote Manager and the ACMS run-time
system are transparent. Users may be on the same or a different node than the
Remote Manager, but the Remote Manager must be running on the same node as
the ACMS run-time system it is monitoring or accessing.
This chapter describes how to prepare and run the ACMS Remote Manager
software on a node where HP ACMS for OpenVMS, Version 5.0 has been installed.
This chapter does not describe the actual installation. For information about
installing HP ACMS for OpenVMS, Version 5.0, refer to the HP ACMS Version 5.0
for OpenVMS Installation Guide.
Note
The procedures in this chapter assume HP TCP/IP Services Version 5.0A
for OpenVMS (TCP/IP) or higher is installed. The image and process
names changed in Version 5.0 from UCX* to TCPIP*. If you are using a
machine with an older version of TCP/IP Services installed, you should
substitute UCX wherever you see TCPIP in the instructions in this
chapter.
Terminology
The following terms are used in this chapter:
• Server node
A node on which ACMS Version 5.0 has been installed and on which the
ACMS Remote Manager server will run. Server nodes can be either ACMS
application or submitter nodes, and can be managed either locally or remotely
using one of the supported interfaces (RPC or SNMP). Server nodes are
automatically client nodes, but not all client nodes are server nodes.
• Client node
A node on which ACMS Version 5.0 may or may not be installed. Client nodes
can get information from and perform operations on server nodes. However,
users cannot obtain ACMS system management information from or perform
system management functions on nodes that are client nodes only.
When you complete the following procedures, the ACMS Remote Manager will be
running on your system and you can access it using the ACMSMGR command
line utility, the Remote Manager web agent, or a third-party or user-written client
that uses one of the supported interfaces.
Note that the Remote Manager web agent requires some configuration before
use. See Chapter 3 for detailed configuration instructions as well as for a brief
overview of the browser interface.
2. If you will be using ACMS proxies to access the Remote Manager, and you
already know that you have a valid proxy account, go to step 3. If you have
not set up proxies but would like to use them, create a proxy file on the
node on which the Remote Manager will run. (For more information, see
Section 2.3.5.2.)
$ SET DEFAULT SYS$SYSTEM
$ MCR ACMSUDU
UDU> CREATE/PROXY
Now you can add a proxy. To add a proxy, you need to know the following
information:
• The nodes and accounts from which you will access the Remote Manager
• The account on the Remote Manager node you will use
For example, assume you will be on node CLIENT using account MYACCT,
and you will be accessing node SERVER using account SRVACCT. Enter the
following command on node SERVER:
UDU> ADD/PROXY CLIENT::MYACCT SRVACCT
3. You can now enter any of the ACMSMGR commands. For example:
$ ACMSMGR SHOW INTERFACES
This command results in output similar to the following:
ACMS Remote Management -- Command line utility
ACMS V4.4-0 Interfaces Display Time: 18-APR-2001 13:59:15.51
Enabled Running Get Set Alarms Time Last
Node Interface State State Requests Requests Sent Alarm Sent
------ --------- ------- ------- -------- -------- ------ -----------------------
SERVER rpc enabled started 987 0 0 17-NOV-1858 00:00:00.00
SERVER snmp enabled started 0 0 0 17-NOV-1858 00:00:00.00
If you get error messages instead, refer to Section 2.5.
The information in the following sections applies mainly to server nodes on which
the ACMS Remote Manager will run. Section 2.2.2 and Section 2.2.3 do not apply
to ACMS Remote Manager client nodes.
Note
When you configure RPC, you are providing network access to the node.
This may have significant security implications. Be sure you understand
these implications before you configure SNMP. If you are in doubt, consult
your network or security administrator.
Note
If you logged in to this node using TCP/IP, you will lose connectivity after
the first command executes. You may have to reboot the machine in order
to log in and complete the procedure. To avoid this problem, put the
shutdown and startup commands into a command procedure, and submit
the procedure to a batch queue that is guaranteed to run on this node.
A - Configure options 1 - 4
[E] - Exit configuration procedure
Enter configuration option: 3
Note
If you logged in to this node using TCP/IP, you will lose connectivity after
the first command executes. You may have to reboot the machine in order
to log in and complete the procedure. To avoid this problem, put the
shutdown and startup commands into a command procedure, and submit
the procedure to a batch queue that is guaranteed to run on this node.
After TCP/IP starts up, the Portmapper should be ready to use. The Portmapper
process itself does not start until it is needed, but you should make sure it is
defined as described in Section 2.2.2.1.
You can test RPC access to the Remote Manager by using ACMSMGR commands.
But you will need to get the ACMSMGR running first (see Section 2.3).
This procedure may require that you restart TCP/IP on the node you are using.
Note
When you configure SNMP, you must configure the SNMP communities to
which the node will belong. SNMP communities govern SNMP network
access to the node, which may have significant security implications. Be
sure you understand these implications before you configure SNMP. If
you are in doubt, consult your network or security administrator. If the
SNMP communities are not configured properly, you may be unable to
access the ACMS Remote Manager.
Note
Configuring SNMP communities must be coordinated among all nodes
that will participate. If you are unsure which SNMP communities to
configure, contact your network administrator.
$ @SYS$MANAGER:TCPIP$CONFIG
HP TCP/IP Services for OpenVMS Configuration Menu
Configuration options:
1 - Core environment
2 - Client components
3 - Server components
4 - Optional components
5 - Shutdown HP TCP/IP Services for OpenVMS
6 - Startup HP TCP/IP Services for OpenVMS
7 - Run tests
A - Configure options 1 - 4
[E] - Exit configuration procedure
Enter configuration option: 3
Note
If you logged in to this node using TCP/IP, you will lose connectivity after
the first command executes. You may have to reboot the machine in order
to log in and complete the procedure. To avoid this problem, put the
shutdown and startup commands into a command procedure, and submit
the procedure to a batch queue that is guaranteed to run on this node.
After TCP/IP starts, SNMP should be ready to use. The following SNMP
processes should be running:
TCPIP$ESNMP
TCPIP$OS_MIBS
2.2.3.4 Test SNMP
TCP/IP includes a DCL command line utility that can be used to issue SNMP
commands to SNMP agents on OpenVMS. To use this utility, define the following
foreign commands:
$ SNMPGET :== $SYS$SYSTEM:TCPIP$SNMP_REQUEST <your node name> PUBLIC GET -W 20
$ SNMPSET :== $SYS$SYSTEM:TCPIP$SNMP_REQUEST <your node name> PUBLIC SET -W 20
Then, after starting the ACMS Remote Manager (see Section 2.3), test access to
SNMP:
$ SNMPGET 1.3.6.1.4.1.36.2.18.48.5.1.10.1
1.3.6.1.4.1.36.2.18.48.5.1.10 = 14
$ SNMPSET 1.3.6.1.4.1.36.2.18.48.5.1.10.1 -I 15
1.3.6.1.4.1.36.2.18.48.5.1.10 = 15
In this example, the first command issues an SNMP GET to get the value
of the parameter mgr_audit_level (the audit level of the main thread). The
second command sets the value of the mgr_audit_level parameter to 15 (log all
messages). Following each command, the current value of the field is returned.
If these commands fail to return the expected results, refer to Section 2.5.
Either press Return to accept the default, or type the file specification you want
to use.
(ACMS$MGMT_TEMP) Enter the directory where the temp command procedures
will be created
Equivalence string [ SYS$SPECIFIC:[SYSMGR] ]:
The Remote Manager uses temporary command procedures (see Section 5.4.2)
to update the ACMS run-time system. The default location of the command
procedures is SYS$MANAGER. This directory should not be a cluster common
directory.
Either press Return to accept the default, or type the directory specification you
want to use. If the directory does not exist, the command procedure creates it for
you.
(ACMS$MGMT_LOG) Enter the directory for the ACMS Remote Manager’s Log file
Equivalence string [ SYS$SPECIFIC:[ACMS_RM.LOG] ]:
The Remote Manager log file (described in Section 4.7) contains a variety of
messages generated by the Remote Manager at run time. The default location
of the log is SYS$SPECIFIC:[ACMS_RM.LOG]ACMS$MGMT_LOG.LOG. If you
choose to place this log in a cluster common directory, be sure that the file name
is different for each node.
Either press Return to accept the default, or type the file specification you want
to use.
(ACMS$MGMT_CREDS_DIR) Enter the directory for the ACMS Remote Manager
Credential’s Equivalence string [ SYS$SPECIFIC:[ACMS_RM.CREDS] ]:
Client credential files (described in Section 4.4.1.1) contain encrypted client
identity information used for client authorization. The default location for these
files is SYS$SPECIFIC:[ACMS_RM.CREDS]. Credential files are created with
unique names and can be safely placed in a cluster common directory.
Either press Return to accept the default, or type the directory specification you
want to use. If the directory does not exist, the command procedure creates it for
you.
(ACMS$MGMT_SNAPSHOT) Enter the directory where the snapshot data will be stored
Equivalence string [ SYS$SPECIFIC:[ACMS_RM.SNAPSHOT] ]:
Data snapshot files (described in Section 5.2) contain ACMS system management
information (parameter and process quota settings) for one or more ACMS
systems. The default location for these files is SYS$SPECIFIC:[ACMS_
RM.SNAPSHOT]ACMS$MGMT_SNAPSHOT.DAT. If you choose to place this
log in a cluster common directory, be sure that the file name is different for each
node.
Either press Return to accept the default, or type the directory specification you
want to use. If the directory does not exist, the command procedure creates it for
you.
(ACMS$MGMT_ERR_LOG) Enter the directory where the Error Log data will be stored
Equivalence string [ SYS$SPECIFIC:[ACMS_RM.ERR_LOG] ]:
Error log files (described in Section 5.5) contain errors generated by ACMS run-
time processes. The default location for these files is SYS$SPECIFIC:[ACMS_
RM.ERR_LOG]ACMS$MGMT_LOG.LOG. If you choose to place this log in a
cluster common directory, be sure that the file name is different for each node.
Either press Return to accept the default, or type the directory specification you
want to use. If the directory does not exist, the command procedure creates it for
you.
Please enter the UIC for the ACMS$SNMP account, in the form [ggggg,nnnnnn]
UIC:
This account is used to control SNMP access to ACMS system management
information and functions. Section 4.4.1 and Section 7.2 describe the uses of this
account. In general, if you will be using an SNMP-based management console to
access ACMS, you should create this account.
Please enter a password of at least 8 characters, using only
the following characters: ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789$_
Password:
The password for this account is never used. Enter any combination of the
characters shown. However, keep in mind that you will be prompted to verify
whatever you type.
After you run the postinstallation procedure, you should rerun
SYS$STARTUP:ACMSTART.COM to ensure that the newly created
ACMS$MGMT_SETUP.COM is run.
The configuration file contains the startup configuration for ACMS data
collections and provides many defaults for the Remote Manager. Section 4.2
describes how to use the ACMSCFG utility to manage this file.
In particular, consider the following:
• Interfaces
By default, both RPC and SNMP interfaces are enabled. The RPC interface
must be enabled if you intend to use the ACMSMGR command line utility, or
if you will be writing programs that use the RPC API. The SNMP interface is
required only if you will use a third-party SNMP management tool to manage
ACMS. The following command disables the SNMP interface:
$ ACMSCFG SET INTERFACE/INTERFACE=SNMP/STATE=DISABLED
• Data collections
By default, only ID and CONFIG class data is collected by all ACMS
processes. If you intend to use the Remote Manager to monitor run-time,
pool, or error data, you must enable data collection for those classes. The
following commands enable run-time, pool, and error data collection for all
processes:
$ ACMSCFG ADD COLL/ENT=*/CLASS=RUNTIME/COLL_STATE=ENABLED
$ ACMSCFG ADD COLL/ENT=*/CLASS=POOL/COLL_STATE=ENABLED
$ ACMSCFG ADD COLL/ENT=*/CLASS=ERROR/COLL_STATE=ENABLED
• Traps
Configuring traps is optional. Traps are used only if your SNMP management
console listens for traps. Section 7.8 discusses traps in more detail. If you are
unsure about whether you need to configure traps, use the defaults.
• Parameters
The parameters in the configuration file control various aspects of the
Remote Manager. In general, use the default values unless you have a
particular reason to modify them. Refer to Section 9.10 includes a table with
descriptions of each parameter.
The remote account is the account on the remote node that will be accessing the
Remote Manager. This is the user name on the remote node.
The local account is the account on the local node that will be used for
authorization. It must be a valid account on the local node.
To add the proxy record, use the following command:
UDU> ADD/PROXY remote-node::remote-account local-account
Once the proxy record has been added, you can attempt to access the Remote
Manager. Using a proxy does not require a separate login; you just issue the
command. Also, do not define the ACMS$MGMT_USER logical. If it is defined,
the ACMSMGR utility will look for login information and will not attempt proxy
access.
Try this command:
$ AMCMSGR SHOW USERS/NODE=remote-manager-node
If no error messages are returned, a list of users logged in to the Remote Manager
will be displayed. To reduce typing when issuing more commands, define the
process logical ACMS$MGMT_SERVER_NODE to be the name of the node
you want to access; this eliminates the need for using the /NODE qualifier in
ACMSMGR commands.
If an error is returned, refer to Section 2.5.
HP TP Desktop Connector
The Remote Manager may be used to monitor user-written and HP supplied
agents.
To allow the ACMS Remote Manager to monitor the HP TP Desktop Connector
(ACMSDI$SERVER), the file SYS$STARTUP:ACMSDI$STARTUP.COM needs to
be modified as follows:
Edit SYS$STARTUP:ACMSDI$STARTUP.COM and search for the lines:
$ if _server_name .nes. ""
$ then
$ write tmpstartup "$ define/process ACMSDI$SERVER_NAME ", _server_name
$ endif
Insert the following before the lines above:
$ write tmpstartup "$ define/process ACMS$RM_AGENT_INIT ", "T"
$ write tmpstartup "$ define/process ACMS$RM_AGENT_KEEP ", "T"
The ACMSDI$SERVER must be restarted after the changes are made.
You should save a copy of this file. If you re-install or update the HP TP Desktop
Connector, the installation procedure will replace the file that you have edited.
TP Web Connector
To allow the ACMS Remote Manager to monitor the TP Web Connector
(ACMSDA$GATEWAY), the file SYS$STARTUP:ACMSDA$STARTUP.COM needs
to be modifed as follows:
Edit SYS$STARTUP:ACMSDA$STARTUP.COM and search for the lines:
$ write tmpstartup "$ define/process ACMSDI$ACMS_ERROR_MSG ", _acms_error_msg
$ write tmpstartup "$ define/process ACMSDI$PASSWORD_EXP ", _password_exp
$ write tmpstartup "$ define/process ACMSDI$INTEGRITY_CHECK ", _integrity_check
Inserver the following after the lines above:
$ write tmpstartup "$ define/process ACMS$RM_AGENT_INIT ", "T"
$ write tmpstartup "$ define/process ACMS$RM_AGENT_KEEP ", "T"
The ACMSDA$GATEWAY must be restarted after the changes are made.
You should save a copy of this file. If you re-install or update the TP Web
Connector, the installation procedure will replace the file that you have edited.
If the bottom two lines are missing (program number 20000099, version 1), then
the Remote Manager is not connected to the Portmapper. Either the Remote
Manager is not started or has terminated, or the RPC interface is not enabled.
If no lines are displayed (that is, if a ‘‘record not found’’ message is displayed), the
Portmapper is not started. Refer to Section 2.2 for more information.
Solution: Correct the problem with the Remote Manager or the Portmapper.
This chapter describes how to prepare and run the ACMS Remote Manager web
agent.
Note
ACMS HMMO will work only with Insight Management Agents using
the ELM HTTP/HTTPS server. It will not work with versions of Insight
Management Agent using the System Management Homepage as the
HTTP/HTTPS server.
The Remote Manager web agent environment consists of the following host
systems:
• Web client – One or more local systems running a web browser that
supports Java plug-ins, JavaScript, and Cascading Style Sheets (CSS).
• Web server – An OpenVMS Alpha system where the web agent
(ACMS$MGMT_HMMO) and WBEM management server (WBEM$SERVER)
processes are running. This system serves the ACMS Remote Management
web page and handles all communication between the web client and Remote
Manager server systems.
• Remote Manager server – One or more OpenVMS Alpha or I64 systems
where Remote Manager server processes (ACMS$MGMT_SVR) are running.
The ACMS information displayed on the web agent home page is a result of
executing ACMSMGR commands on the Remote Manager servers.
As shown in Figure 1–1, the Remote Manager web agent (ACMS$MGMT_HMMO)
relies on the WBEM management server (WBEM$SERVER) to relay data to and
from the web browser. The web agent uses its internal web server to connect
to the ACMS Remote Management page. All command input is then relayed to
Remote Manager server through the HMMO.
The setup procedure then completes by creating the following directories and
files on the web server system:
The ACMS WBEM setup has completed.
The following files were copied:
To SYS$SYSROOT:[WBEM]
ACMS$MGMT_HMMO.EXE
RUN_ACMS_HMMO.COM
STOP_ACMS_HMMO.COM
To SYS$SYSROOT:[WBEM.WEB.IM.ACMSHMMO.ENG]
ACMS.CSS
ACMSHMMO.JS
ACMSMENUTREE.JAR
ACMS_BANNER.HTML
ACMS_INDEX.HTML
ACMS_MENU.HTML
ACMS_OUTPUT.HTML
To SYS$SYSROOT:[WBEM.WEB.IM.ACMSHMMO.IMAGES]
ACMSHMMO.GIF
HPLOGO.GIF
WEBBUM.GIF
To SYS$COMMON:[SYSLIB]
ACMS$TRACE_SHR.EXE
You may wish to purge these directories.
Once the ACMS installation is complete, download and install the HP
Management Agent for OpenVMS software, as described in Section 3.2.2.
• ACMS$MGMT_SYSUPD
See Section 4.4.2 for more information on the use of rights identifiers.
Note
Even if the Remote Manager is running on the same node as the web
agent, it is still considered a remote host and the requirements above still
apply.
Banner
Command Selection
Output
• Output frame
Displays the results of the selected command. Brief instructions on how to
interact with the data in this frame are displayed along with the related
output and status messages (if any).
3.3.2 Conventions
The web agent uses color and font highlighting to indicate the different states
and types of data displayed in the output frame. The default conventions are
described in Table 3–1. Note, however, that you can change these conventions as
described in the following section.
Note
Each browser may interpret style sheet properties differently. Be aware
that slight variations in format may occur depending upon the browser
that you use.
Enter the name of the Remote Manager host, and click OK. Note that if you
enter a URL or IP address, only the short form of the name is displayed in the
command selection frame.
2. Click on the appropriate entity (such as, TSC) or object (such as, Process). If
you selected an entity, click on the appropriate type of information to display
(such as, Config), and choose the scope of display (such as, Brief/Stored).
The results of the command are displayed in the output frame, similar to
Figure 3–3. Note that all dynamic data is displayed in italics.
3. Move the cursor over the value you want to change until the link cursor
appears, and then click on the value. A popup window is displayed prompting
you for a new value.
4. Enter the new value in the popup window, and click OK.
Note that you can update the values displayed in the output frame at any time
by clicking the Refresh button.
4.1 Overview
The ACMS Remote Manager runs on the same node as the ACMS run-time
system but runs independently of it. The Remote Manager may be started and
stopped at any time without affecting the ACMS run-time system. Similarly,
the ACMS system can be started and stopped at any time without affecting the
Remote Manager process. Remote management can be performed only on nodes
where the Remote Manager has been started.
ACMS system managers configure the Remote Manager process (for example,
which interfaces are enabled, what alarms to send) using a combination of
the ACMSCFG utility (which provides initial configuration settings at process
startup) and the ACMSMGR utility (to change settings once the process has
started). Management consoles that support SNMP can also be used to configure
and manage the Remote Manager.
Before the Remote Manager process can communicate with external entities,
either SNMP or RPC must be configured and running on the appropriate nodes.
See the HP ACMS Version 5.0 for OpenVMS Installation Guide for information
about configuring and starting SNMP and RPC.
Note
Changes made to the ACMSCFG file are not automatically reflected in
the running system. The ACMSCFG file is read during Remote Manager
and ACMS system startup only. The Remote Manager process must
be restarted in order for configuration file changes to the Parameter,
Interface, and Trap tables to become active. The ACMS run-time system
must be restarted in order for configuration file changes to the Collection
table to become active. After the Remote Manager process has been
started, you can use the ACMSMGR utility to make dynamic changes to
the active system.
Parameter
Trap
Example:
$ ACMSCFG SET COLLECTION/ENTITY=*/NAME=*/CLASS=RUNTIME/COLL_STATE=ENABLED
Each object has unique qualifiers that determine which values are to change.
Qualifiers are either mandatory or optional. Mandatory qualifiers have no
default and must be specified by the user. Optional qualifiers have default
values and do not have to be specified. See Chapter 10 for a complete description
of the syntax for each command and the qualifiers they support.
4.4.1 Authentication
Authentication can be performed in one of two ways: either through an explicit
login (using a valid OpenVMS user name and password) or through a valid ACMS
proxy account.
The exception to this rule is SNMP access, which is controlled by the presence
of the ACMS$SNMP account in the local rights database. Authentication for
external entities that communicate with the Remote Manager through the
SNMP protocol is allowed only when a valid OpenVMS account exists for
the user ACMS$SNMP. If this account exists and has the appropriate rights
identifier, the user ACMS$SNMP is considered to be an authenticated SNMP
user. Authorization for SNMP users is treated the same as for any other user
— by OpenVMS rights identifier. See Section 4.4.2 for more information about
authorization.
All access for an interface can be disabled by disabling the interface itself, either
through the ACMSCFG utility prior to management startup, or through the
ACMSMGR utility after Remote Manager startup.
The total number of users that can be simultaneously logged in to the Remote
Manager (regardless of authentication mechanism) is controlled by the Remote
Manager parameter MAX_LOGINS, which can be modified by the Remote
Manager. (This parameter is not the same as the MAX_LOGINS ACMS system
parameter in ACMSGEN.) When the number of users currently logged in is
equal to the value of this parameter, new logins are rejected until some users
have logged out, or until their credentials have expired. You can set the initial
value of MAX_LOGINS with the ACMSCFG utility. You can change the value of
MAX_LOGINS dynamically (but nondurably) with the ACMSMGR utility.
Attempts to log in to the Remote Manager are recorded in the Remote Manager
log file if the SECURITY_AUDIT_LEVEL parameter is set for informational
level logging (any odd value, up to and including F). By default, informational
messages are not logged. See Section 4.7.1 for more information.
Use the SHOW USER command of the ACMSMGR utility to display a list of
users currently logged in to the Remote Manager:
$ ACMSMGR SHOW USER
Note
You must be authenticated in order to issue the SHOW USER command.
4.4.1.1 Logging In
Login is performed using the ACMSMGR LOGIN command, which has the
following syntax:
ACMSMGR LOGIN /USER=user-name /PASSWORD=password /NODE=node-name
The /USER qualifier can be omitted if the ACMS$MGMT_USER logical is defined.
If the qualifier is provided, it overrides the ACMS$MGMT_USER logical. If
neither the logical nor the qualifier is present, the ACMSMGR utility prompts the
user for the user name.
If the /PASSWORD qualifier is not present, the ACMSMGR utility prompts the
user for the password. There is no logical name for the password.
The /NODE qualifier can be omitted if the ACMS$MGMT_SERVER_NODE
logical is defined. If it is provided, it overrides the ACMS$MGMT_SERVER_
NODE logical. If neither the qualifier nor the logical name is provided, no login
is attempted.
For each node to which a user logs in, a credentials file is created, either
in the current directory or in the directory pointed to by the logical name
ACMS$MGMT_CREDS_DIR. The credentials file contains encrypted security
information (password is not stored in the file) and can be used by subsequent
executions of the ACMSMGR utility. Credentials are specific to the process that
created them and cannot be used by other processes. Prior to creating a new
credentials file, any old credential files for the process are deleted.
Once a user has logged in to the Remote Manager, the user’s credentials are valid
for the duration of the credentials lifetime period, as specified by the parameter
LOGIN_CREDS_LIFETIME. You can set the initial value of LOGIN_CREDS_
LIFETIME with the ACMSCFG utility. You can change the value of LOGIN_
CREDS_LIFETIME dynamically (but nondurably) with the ACMSMGR utility.
Once a user’s credentials have expired, the user must log in to the server again.
4.4.2 Authorization
Authorization consists of ensuring that the user attempting access holds the
appropriate rights identifier on the node they are attempting to access. There are
four levels of access, each with its own identifier, as described in the following
sections.
4.4.2.1 Read Access (ACMS$MGMT_READ)
Read access allows users to perform the following functions:
• Log in
• Log out
• Issue all SHOW commands
4.4.2.2 Operate Access (ACMS$MGMT_OPER)
Operate access allows users to issue the following commands:
• REPLACE SERVER
• SET ACC, CP, EXC, QTI, SERVER, TSC
• START EXC, QTI, SYSTEM, TERMINALS, TRACE_MONITOR
• STOP EXC, MANAGER, QTI, SYSTEM, TERMINALS, TRACE_MONITOR
Note
Either the RPC or SNMP interface should always be enabled. If both are
disabled, there is no way to communicate with the Remote Manager.
For a more complete discussion of the available interfaces and their attributes,
see Section 9.8.
The value of each parameter determines what level of information is stored in the
Remote Manager log. Table 4–2 shows the four levels of auditing and the integer
value for each.
Auditing values can be combined by logically ORing the integer values in order to
have multiple levels of auditing in effect for a given facility. Table 4–3 shows the
valid auditing values.
Parameter settings are stored in the ACMSCFG file and can also be modified
dynamically using the ACMSMGR utility. For example, in order to specify that
all messages and events generated by the security routines should be stored in
the log, use the following command:
$ ACMSCFG SET PARAMETER/SECURITY_AUDIT_LEVEL=F
Alternatively, to dynamically modify an auditing level, use the following
ACMSMGR utility command:
$ ACMSMGR SET PARAMETER/SECURITY_AUDIT_LEVEL=F
This chapter describes how to use the Remote Manager to monitor and manage
ACMS run-time processes.
Data collection for other entities and classes is not enabled by default. When the
ACMS system is started, the ACMS processes read either the configuration file (if
the Remote Manager is not already running) or the Collection table to determine
which classes of data to collect. Thereafter, external processes use the SNMP or
RPC management interfaces to enable or disable data collection for a given entity,
class, and name.
For each entity and class for which collection is enabled, a table of data values
is populated by the appropriate ACMS processes (determined by name) and can
be accessed by external entities using one of the data access interfaces (SNMP or
RPC).
ACMS entities that collect data do so continuously when collection has been
enabled for that entity/class/name combination. With the exception of event
notifications (generated as the result of ACMS process startup or shutdown) and
POOL, ERROR, and snapshot information (which is updated based on timer
intervals), collection data is modified when it changes.
• Pool (POOL)
This class is a set of values related to the current or historical MSS or
workspace pool processing for the process. MSS pool values are the same
for all entities except ACC. An example of a Pool class value for ACC is the
current free amount in the MSS shared pool. An example value for other
processes is the current free amount in the MSS process pool.
• Run-time (RUNTIME)
This class is a set of values that reflect either current or historical run-time
processing for the process. Run-time values are also entity specific. An
example of a Run-time class value for ACC is current number of applications.
An example value for an EXC is the current number of executing tasks.
• Error (ERROR)
This class is a set of values pertaining to a specific error reported by a
process. Error values are the same for all entities. An example of an Error
class value is the date and time when an error occurred.
• *
The asterisk is a wildcard value that specifies all classes.
A name specifies one or more specific processes of an entity type. The name
field is entity specific. An example name for EXCs is the application name. An
example name for CPs is process name. The asterisk (*) wildcard value is also
supported and matches all names.
Entity, class, and name are used in combination to determine which processes
will collect which values. Duplicate rows (that is, rows with the same entity,
class, and name) are not allowed, but it is possible to have overlapping entries in
the Collection table if the asterisk wildcard value is used. Consider the example
in Table 5–1.
In respect to typical data collections, the entries in this example overlap but are
not duplicates. This is allowed because the attributes of each collection may be
different.
In respect to data snapshots, the entries in this example would result in separate
snapshot threads if the storage state were enabled for both collections. Each
thread would write ACC run-time information, which may or may not be intended
result. Therefore, users should be cautious when using wildcards to avoid
redundant processing.
When more than one row applies to a data collection, the most specific row will
be used, based on the column precedence of name, then entity, and then class.
Within a particular column, wildcards are the least specific. In Table 5–1, both
rows are equivalent in name and entity, but the second row is more specific in
class. In this case, the values from the first row will be used for all classes except
the Runtime class. The values from the second row will be used for the Runtime
class.
In this example, the first row enables run-time data collection for all entities. The
second row disables it for all EXCs. The third row enables it for the VR_APPL.
As a result, among applications, only the VR_APPL will collect run-time data.
To help identify which row is the most specific and therefore will apply to a given
process, the ACMSMGR command SHOW COLLECTIONS includes a column that
represents the weight of a given row. A row with higher weight overrides a row
with lower weight when they apply to the same class and process. Consider the
following example, which is the same as the example in Table 5–2 but includes
the weights (in the column labelled "Wt") of each row.
Note
Weighting does not apply to data snapshot collections. Data is written for
each row in the Collection table that is eligible for snapshots (with both
storage_state and coll_state ENABLED).
In this example, the last row has the highest weight, and will override the other
two rows for the RUNTIME class for the VR_APPL.
When the data collection state is set to ENABLED, the Remote Manager sends
messages to the appropriate ACMS processes (based on the entity and name
fields in the Collection table row) to begin collection for the class. When the data
collection state is set to DISABLED, a similar message is sent to stop collection
for the class. Once collection has started, it continues until the data collection
state is set to DISABLED.
The requesting user must have ACMS$MGMT_WRITE privilege in order to start
or stop a collection.
5.1.2.1 Using ACMSCFG to Start or Stop Collections
Use the ACMSCFG utility to set the state for a collection when the Remote
Manager starts up. Some ACMSCFG commands are described here; for details on
all ACMSCFG commands, see Chapter 10.
Use the ACMSCFG ADD COLLECTION command to create a new collection
record. The command has the following syntax:
ACMSCFG ADD COLLECTION /ENTITY=entity /CLASS=class /NAME=name /COLL_STATE=state
Use the ACMSCFG SET COLLECTION command to modify the state of an
existing collection record in the configuration file. The command has the following
syntax:
ACMSCFG SET COLLECTION /ENTITY=entity /CLASS=class /NAME=name /COLL_STATE=state
Use the ACMSCFG DELETE COLLECTION command to delete a collection. The
command has the following syntax:
ACMSCFG DELETE COLLECTION /ENTITY=entity /CLASS=class /NAME=name
Deleting a collection can cause the Remote Manager to disable the class for a
process because collections are disabled by default. The collection state for a
process becomes disabled when no collections remain to specifically enable the
class.
Use the ACMSCFG SHOW COLLECTION command to determine which
collections already exist and their collection states. The command has the
following syntax:
ACMSCFG SHOW COLLECTION
Note
You cannot use the ACMSCFG utility to add, delete, or modify Collection
and Identification class records.
2. The collection state and storage state for the entity must be enabled.
To activate the data snapshot, both the coll_state and storage_state fields
in the Collection table must be ENABLED. The coll_state field enables the
data collection; the storage_state field directs the Remote Manager to write
the collection data to the snapshot file. Once both states are ENABLED, the
Remote Manager writes data to the snapshot file until it reaches the end of
specified time period or until the storage state is DISABLED.
3. The current time must fall between the specified start and end time.
Each collection record entity can have its own snapshot interval and can be
scheduled to begin and end at a specific time. By default, both the start and
end time for a snapshot are set to 17-NOV-1858 00:00:00.00, which equates to
begin immediately (NOW) and run indefinitely (NEVER).
Data is written to the file at set intervals determined by value of the storage_
interval field. Note that the storage_interval value should be a multiple of the
timer_interval value. The timer_interval value determines the minimum elapsed
time for many Remote Manager parameters, including the storage interval
setting. The relationship of the values in these two fields 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.
Multiple collection records can share the same data snapshot file or write data
to separate files.The location of the data snapshot file is specified by the storage_
location field in the Collection table. The file is typically stored in the location
specified by the logical name ACMS$MGMT_SNAPSHOT. If this logical is not
defined, the default location is in the default directory for the account under
which the Remote Manager process runs.
Similar to starting and stopping data collections, the requesting user must
have ACMS$MGMT_WRITE privilege in order to start or stop a data snapshot.
Also, both the ACMSCFG and ACMSMGR utilities can be used to configure
snapshots, as described in the following sections. Once configured and active, the
ACMSSNAP utility can be used to display and analyze the contents of the data
snapshot file (see Section 5.3.2).
Note
If the Remote Manager is unable to write to the data snapshot file,
it writes a message to the Remote Manager log (ACMS$MGMT_
SERVER.OUT). This can occur if a logical name is defined incorrectly,
if the output device is full, or if the Remote Manager does not have
sufficient privilege to write to the file. No further attempts are made to
write snapshot data until the storage state value for the related collection
is manually reset (DISABLED then ENABLED).
ID
Node Class PID Process Name Start Time UserName Version
------------ -------- -------- --------------- ----------------------- ------------ ------------
sparks enabled 2020C8BB ACMS01ACC001000 18-APR-2001 14:44:47.29 SYSTEM V5.0
If the ACMSMGR or RPC interface is used, any errors that occur during the
system update are returned to the user and are written to the Remote Manager
log file.1 Depending on the current setting of the dcl_audit_level parameter, some
messages may not be written to the log.
User accounts (including proxy accounts and the ACMS$SNMP account, if SNMP
is being used) must be granted the ACMS$MGMT_WRITE or ACMS$MGMT_
OPERATE rights identifier in order to modify Configuration class values. See
Section 4.4.2 for a list of functions and the rights identifier required for each.
1
Log file entries are filtered by trace level, which is configured using the audit level
parameters in the Remote Manager Parameter table (see Section 4.7).
• To delete rows from the Trap table, set the trap-delete field to 1. This is the
only value allowed for this field.
5.4.4.3 Replacing Application Procedure Servers Using SNMP
To replace an ACMS application procedure server, issue an SNMP SET command
on the ser-replace-flag field in the Server table, specifying a nonzero value.
Note
The Remote Manager process on the server node must have access to the
error filter file in order for the file to be loaded into the Remote Manager
tables.
Programmers who want to access and maintain the ACMS Remote Manager from
their own programs can use the following two interfaces:
• Simple Network Management Protocol (SNMP)
The SNMP interface is provided for integration with enterprise management
packages such as PATROL® from BMC® and Tivoli from IBM®. For more
information, see Chapter 7.
• Open Network Computing (ONC) Remote Procedure Call (RPC)
The ONC RPC interface is for system managers and system programmers
who want to write custom tools and applications that access the ACMS
Remote Manager.
This chapter describes the ONC RPC interface. Programmers who are familiar
with the C programming language and RPC mechanisms can use this information
when coding and building their own client programs. For a more complete
discussion of ONC RPC programming, see Power Programming with RPC by
John Bloomer, published by O’Reilly & Associates, Inc., Sebastopol, CA.
VM-0425A-AI
Client stub
ACMSMGMT_RPC_CLNT.C
Data
conversion
routines
Function and ACMSMGMT_RPC_XDR.C
argument IDL compiler
definitions (IDL)
ACMSMGMT_RPC.X $RPCGEN
ACMSMGMT_RPC.X Header file
ACMSMGMT_RPC.H
Server stub
ACMSMGMT_RPC_SVC.C
VM-0328A-AI
The IDL that describes the procedures supported by the ACMS Remote Manager
is provided with the ACMS Remote Manager installation and provides the
basis for ACMS management programming. Users write their own client
programs, calling the functions described in the ACMS Remote Manager IDL
file (ACMSMGMT_RPC.X). They precompile the IDL file with the precompiler
provided by their TCP/IP package, and then compile and link their client
The procedure names and arguments for each procedure type are similar — all
get calls have similar names and arguments; set calls have similar names and
arguments, and so on.
The sections that follow describe in more detail how to write programs that access
these functions.
Note
In order for credentials information to be created, the client process must
first execute the login command of the ACMSMGR utility. The only way
to create credentials files is by using the ACMSMGR utility.
For all list procedures, only entire rows (that is, all columns in the row) are
returned. Data is returned in a linked list. The number of nodes in the list is
determined by the systemwide parameter table field max_rpc_return_recs. When
the number of rows to be returned exceeds the value of max_rpc_return_recs, the
caller must reissue the call, providing the appropriate key values to fetch the
next set of rows. The call returns status MGMT_NO_MORE_ROWS if there are
no more rows available. Procedures with no keys return all rows in the table on
the first call, regardless of the value of the max_rpc_return_recs field.
cl->cl_auth = authunix_create_default();
/* So far so good. Initialize log selection data */
log_rec.client_id = 0;
log_rec.before_time = null_time_str;
log_rec.since_time = first_of_jan;
log_rec.file_name = file_spec;
log_rec.dup_count = -1;
log_rec.facility = -1; /* don’t match on facility */
log_rec.severity = -1; /* don’t match on severity */
top:
/* Now make RPC */
log = acmsmgmt_list_log_1(&log_rec,cl);
The return value from the calls to all list procedures (including acmsmgmt_list_
log_1) is a pointer to a union. If the pointer returned is NULL, the call has failed.
RPC error checking must be used to determine the cause of the error. If a valid
pointer has been returned, it will point to a structure containing a union with the
following structure:
struct log_data_list {
int status;
union {
log_list list;
int rc;
} log_data_list_u;
};
The status field determines which structure is being returned. If the status is
equal to MGMT_FAIL, the rc field is returned. The rc field contains a status code
indicating the reason for failure.
If the status field is not equal to MGMT_FAIL, a pointer to a linked list has been
returned.
The log_list field is defined as a pointer to linked list node, as follows:
typedef struct log_link *log_list;
The linked list node has the following structure:
struct log_link {
logging_rec log_data;
log_list pNext;
};
In this structure, log_data is of type logging_rec, which is a record structure
containing the log data. The pNext field is a pointer to the next node in the
linked list (which is of type log_link).
Figure 6–3 illustrates the return structure and how the linked list is constructed.
myptr = acmsmgmt_list_log(myrec);
struct log_link {
logging_rec log_data;
log_list pNext;
};
struct log_link {
logging_rec log_data;
log_list pNext;
};
VM-0329A-AI
The following example code shows how to check whether the call completed
successfully, and how to traverse the linked list to display the data:
/* if a NULL pointer was returned, the RPC failed */
if (!log)
return(MGMT_FAIL);
/* if bad status was returned, something failed in our call.
log->log_data_list_u.rc contains the status */
if (log->status == MGMT_FAIL)
return(log->log_data_list_u.rc);
/* while more data in the list, display the data */
for (nl = log->log_data_list_u.list; nl != NULL; nl = nl->pNext) {
if (skip_rec)
skip_rec = 0;
else
printf("\n %-12s\t%-s",sname,nl->log_data.log_msg);
/* save last time received to use as next time to read forward from */
memcpy(&time_cache[0],nl->log_data.log_msg,23);
log_rec.dup_count = nl->log_data.dup_count;
log_rec.since_time = time_cache;
}
if (log->status == MGMT_NOMORE_DATA)
printf("\n *** End of data **");
else {
skip_rec = 1;
goto top;
}
return(1);
}
In this example, the returned pointer is checked for whether data has been
returned (log is not NULL). Then the status code is checked for whether the call
completed successfully.
If the call completed successfully, the code drops into a FOR loop and starts
printing the data. For this particular call, the client prints all the records
the very first time the RPC is called; on subsequent calls, the first record is a
duplicate of the last one from the previous call and is not printed.
After printing a record, the key data is saved to be used again on a subsequent
call. Remember that only max_rpc_return_recs is returned in each call to the
acmsmgmt_list_log_data_1 procedure. There may be more log records than can
be sent at once. It is the responsibility of the client to initialize the call properly
to get the next set of records.
Once all the returned records have been returned, the code will call the
acmsmgmt_list_log_data_1 procedure again if the status code from the call
was not MGMT_NOMORE_DATA. In this way, all the records are retrieved.
For Entity tables, set procedures allow fields to be modified for a particular entry.
A unique key value must be provided to identify the particular table row to be
updated for tables with more than one row. Only configuration class fields can be
modified in entity tables.
For the Trap and Collection tables, add and delete procedures (described in
Section 6.8 and Section 6.9) are available along with set procedures. Each
procedure requires a unique key value.
For all tables, some or all fields in a row can be modified in a single call. The
Remote Manager scans the input record for uninitialized fields (that is, fields
that are not set to the default value of -1); if a field contains an initialized value,
the Remote Manager attempts to apply the update. The corresponding field in
the return record is updated with the completion status of the update. Updates
are applied serially, but the Remote Manager attempts to update all initialized
fields regardless of the outcome of any individual update. The exception to this
processing is if an internal error occurs, in which case processing is aborted.
Following the call to the update routine, the return record pointer is tested to
ensure that it is not NULL (that is, that the call completed). Then individual
return codes are tested to determine the status of the updates. The first status
check (ret_rec->status) determines the overall call status. For instance, security
violations will be recorded in this field. If that status field contains a failure
code, no updates were attempted. If that status field contains MGMT_SUCCESS,
updates were attempted for the two fields. The subsequent status checks in the
return record determine the outcome of those updates.
if (*status != MGMT_SUCCESS) {
printf("\nCall to delete collection failed with status %d",*status);
return(MGMT_FAIL);
}
else
printf("\nCall to delete collection was executed");
free(status)
return(0);
}
In this example, the input record is prepared with key information, and then
the call to delete the row is performed. Following the call to the delete routine,
the value pointed by status is checked for success or failure. In either event, a
message is printed out indicating the completion status of the call.
if (!status_rec) {
printf("\n Call to add collection record failed");
return(MGMT_FAIL);
}
if (status_rec->status == MGMT_WARN) {
printf("\nThe following fields are invalid: ");
if (status_rec->coll_status_rec_2_u.data_warn.entity_type == MGMT_FAIL)
printf("\n entity_type");
if (status_rec->coll_status_rec_2_u.data_warn.collection_class
== MGMT_FAIL)
printf("\n collection_class");
if (status_rec->coll_status_rec_2_u.data_warn.collection_state
== MGMT_FAIL)
printf("\n coll_state");
return(0);
}
else if (status_rec->status != MGMT_SUCCESS) {
printf("\nCall to add collection failed with status",
status_rec->coll_status_rec_2_u.rc);
xdr_free(xdr_coll_status_rec_2,status_rec);
free(status_rec);
return(0);
}
else
printf("\nCall to add collection was executed");
xdr_free(xdr_coll_status_rec_2,status_rec);
free(status_rec);
return(1);
}
In this example, the input record is prepared with key and data values, and then
the call to add the row is performed.
Following the call to the add routine, the return record pointer is tested to ensure
that it is not NULL (that is, that the call completed). Then the overall status
code (status_rec->status) is checked to determine whether the add was performed.
A status value of MGMT_WARN indicates that some fields were in error, so
individual return codes are tested to determine which fields were invalid.
A status value other than MGMT_WARN or MGMT_SUCCESS means a general
error occurred. A value of MGMT_SUCCESS means the record was added.
Programmers who want to access and maintain the ACMS Remote Manager from
their own programs can use the following two interfaces:
• Open Network Computing (ONC) Remote Procedure Call (RPC)
The ONC RPC interface is for system managers and system programmers
who want to write custom tools and applications that access the ACMS
Remote Manager. For more information, see Chapter 6.
• Simple Network Management Protocol (SNMP)
The SNMP interface is provided for integration with enterprise management
packages such as PATROL® from BMC® and Tivoli from IBM®.
This chapter discusses the SNMP interface. Programmers who are familiar with
SNMP console programming can use this information when writing routines
that interact with the ACMS Remote Manager using the SNMP protocol. The
information in this chapter is also useful for programmers who are integrating
the ACMS Remote Manager with other enterprise management packages through
the SNMP protocol.
The ACMS Remote Manager implements the management information base
(MIB) for SNMP. To access ACMS MIB information through SNMP, you must
have an SNMP-enabled console (such as PATROL® from BMC®) or you can use
an SNMP MIB browser such as the one provided by HP TCP/IP Services for
OpenVMS, which includes the TCPIP$SNMP_REQUEST.EXE utility.
Alternatively, you can write your own SNMP interface. For more information
about programming SNMP, refer to Windows NT SNMP by James D. Murray,
published by O’Reilly & Associates, Inc., Sebastopol, CA.
ACMS Remote
SNMP master ACMS
SNMP eSNMP Manager
agent run-time system
(SNMP subagent)
SNMP management
consoles
VM-0330A-AI
Note
The MIB list is subject to change with each release of ACMS. To obtain
the most current information, consult the source document (ACMS$RM_
EXAMPLES:MGMTMIB.MY), or regenerate the file, as follows:
$ MIBCOMP MGMTMIB.MY,RFC1155.MY "ACMS" /PRINT
Nodes that are part of the SNMP community to which the subagent belongs can
connect to the master agent; any node that can connect to the master agent can
connect and interact with the subagent. All SNMP communities are allowed
any combination of read, write, and trap access. Nodes that are not part of the
community do not have access to the master agent.
Note that communities work at the node level only. It is not possible to restrict
the access of individual user accounts on the node, although it may be possible to
restrict access to the SNMP console software on a per-user basis. Note also that
node authentication itself is relatively weak and provides no safeguards against
masquerades or other forms of network deception.
As a second level of security, the ACMS Remote Manager requires that a special
OpenVMS account (ACMS$SNMP) be created for the SNMP interface on nodes
on which the Remote Manager runs. The account must be granted OpenVMS
rights for read, write, operate access, or update (or some combination of these)
to Remote Manager data and functions. This allows ACMS system managers to
grant read access, for instance, through the SNMP interface, but to prevent write,
operate, or update access. See Section 4.4 for a discussion of how to configure
Remote Manager authentication and authorization for the SNMP interface.
running by sending an ‘‘are you there’’ message to the master agent. If the
master agent responds, the Remote Manager continues to wait for incoming
messages. If the master agent does not respond, the SNMP interface thread
attempts to restart the connection. If the restart fails, the SNMP thread exits.
In static tables, table data is not always contiguous and table rows can be reused.
The PID field should be used to establish process identity.
For example, consider the following CP table. Assume that the first CP is
permanent, and the second two are not.
Table Row CP process name CP PID
1 ACMS01CP001000 2040013D
2 ACMS01CP002000 2040013E
3 ACMS01CP003000 2040013F
An SNMP console searching this table sequentially would find all three CP
instances; access to table row 4 would return an error. However, if the users
attached to the CP in table row 2 log out, the CP terminates and the table now
looks like this:
Table Row CP process name CP PID
1 ACMS01CP001000 2040013D
2
3 ACMS01CP003000 2040013F
An SNMP console searching this table sequentially and stopping when the
first error is returned would find only the first CP. Access to the second row
would return an error. Therefore, when scanning static tables, it is important to
examine all rows of the table before terminating the scan; that is, perform a loop
based on the tsc-cp-slots-active field in the TSC table.
Finally, consider what happens if a new CP now starts. The table would look as
follows:
Table Row CP process name CP PID
1 ACMS01CP001000 2040013D
2 ACMS01CP002000 20400140
3 ACMS01CP003000 2040013F
Table row 2 is now valid again, but a different process occupies it. Therefore, any
cached information for table row 2 is invalid and must be refreshed with the data
from the new process.
• Log table
• Trap table
To see how a dynamic table changes when a table row is removed, assume that a
user table has the following contents:
Table row User Name Client Id
1 User1 1
2 User2 2
3 User3 3
4 User4 4
If User2 logs out, the contents of the table would change as follows:
Table row User Name Client Id
1 User1 1
2 User3 3
3 User4 4
As with static tables, you must ensure that the table row being accessed has not
been reused or renumbered. Among dynamic tables, only the Trap and Error
Filter tables allow updates. Note that entries are never deleted or modified in the
Log table; new entries are always appended to the end.
In order to access the ser-server-name field for ServerA in application Appl1, the
OID would be 1.3.6.1.4.1.36.2.18.48.14.1.3.1.1 To access the same field for ServerD
in Appl2, the OID would be 1.3.6.1.4.1.36.2.18.48.14.1.3.3.2.
You can always determine from the OID which application a server or task group
belongs to because ACMS requires that each server be given a unique name
within the application.
OIDs for ACMS Management tables are documented in the file MIB_OID.LIS
available from the directory ACMS$RM_EXAMPLES. The MIB definition for
the ACMS subtree is also provided in ACMS$RM_EXAMPLES, in the file
MGMTMIB.MY.
In order for SNMP set requests to complete successfully, the following conditions
must be met:
• Depending on the operation being performed, the ACMS$SNMP account
on the Remote Manager node must be granted one or more of the following
identifiers: ACMS$MGMT_WRITE, ACMS$MGMT_OPER, ACMS$MGMT_
OPER, or ACMS$MGMT_SYSUPD (see Appendix B).
• The SNMP interface must already be started.
• The ACMS run-time system must already be started (to update ACMS entity
information).
General eSNMP return codes for SNMP get requests are returned from the
Remote Manager (see Section 7.10). For details about a specific error, refer to the
Remote Manager log.
ACMS system managers configure traps by modifying the Trap table, either by
using the ACMSCFG utility prior to Remote Manager startup or by using the
ACMSMGR utility after the Remote Manager has been started. Changes made
using ACMSCFG do not affect the running system until the Remote Manager
is restarted; changes made using ACMSMGR are not saved when the Remote
Manager stops.
The configuration process is the same with either utility. You use the ADD TRAP
command to add new traps, use the DELETE TRAP command to remove traps,
and use the SET TRAP command to modify traps.
Keep in mind that although you can add, delete, or modify entries in the trap
table at almost any time, traps will not be generated unless the SNMP interface
is started. In addition, traps are not queued if the SNMP interface is disabled.
The combination of entity, name, and parameter uniquely identify a trap in the
Trap table. For each trap, a minimum and a maximum value can be specified,
along with a severity. Minimum and maximum trap values specify thresholds
that trigger traps when the associated parameter is either greater than or less
than the threshold. Minimum and maximum trap values are parameter specific.
A special value of -1 is used as a placeholder when creating a trap for which a
minimum or maximum does not apply. In many situations, only the minimum
or maximum value setting is meaningful. In this instance, set the desired field
(minimum or maximum) to the threshold value, and set the other to -1.
Two trap parameters are supported:
• EXISTS (see Section 7.8.1)
• EVENT_SEVERITY (see Section 7.8.2)
The Management APIs are intended to be called from Open Network Computing
(ONC) Remote Procedure Call (RPC) clients. ONC RPC Interface Definition
Language (IDL) for all procedures is contained in the file ACMS$RM_
EXAMPLES:ACMSMGMT_RPC.X.
Programmers who write client programs are strongly urged to become familiar
with the contents of this file. Many programming questions can be answered by
looking at the actual RPC definitions. All structure definitions, for example, are
contained within this file.
The procedures documented in this chapter are based on the most current record
and field data available with Version 4.4 of the Remote Manager. Procedures
names with _2 indicate new or modified API functions that take advantage of
this new data. These procedures should only be called from a Remote Manager
Version 4.4 server system.
To ensure backwards compatibility, the _1 version of all calls is still available and
provided with the Remote Manager Version 4.4 software.
Note
The acms$mgmt_get_creds procedure is not included in the ACMSMGMT_
RPC.X IDL because it is not a remote procedure call. It is a statically
linked, locally executed function for those clients performing explicit
authentication. The ACMS$MGMT_GET_CREDENTIALS.OBJ object
module is located in the ACMS$RM_EXAMPLES directory.
The acms$mgmt_get_creds procedure is for use by ONC RPC clients only.
8.3 ACMSMGMT_ADD_COLLECTION_2
This procedure adds entries to the Remote Manager Collection table. Collection
table entries can also be modified (see Section 8.35) and deleted (see Section 8.6).
Format
coll_status_rec_2 *acmsmgmt_add_collection_2(coll_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Coll_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Collection table fields.
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.
coll
Type: Coll_update_rec_r_2
Access: Read
Mechanism: By value
Usage: Structure containing a Collection table record.
Collection table fields are described in Section 9.4.
See the Description section for information on
how to initialize this record.
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: Coll_status_rec_2
Access: write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type coll_update_rec_r_2, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
status
Type: Integer
Access: write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Coll_output_rec_r_2
Access: write
Mechanism: By value
Usage: Structure containing a Collection table record.
The entries in this field contain status codes
corresponding to the fields in the coll structure.
See the Description section for a discussion of
how to determine the update status for any field.
Description
This procedure adds a row to the Collection table (see Section 9.4).
Additions to this table are not durable; that is, they do not survive a restart of
the Remote Manager. To make nondynamic, permanent updates to the Collection
table, use the ACMSCFG utility.
Calls to this procedure must specify entity_type, entity_name, and collection_
class. The combination of these fields must be unique within the collection table
for the row to be added. Table 8–4 and Table 8–1 contain symbolic values used to
populate the entity_type and collection_class fields; entity_name is specified as a
null-terminated string.
ID and Config class rows cannot be added. By default, these classes are always
enabled for all ACMS processes.
The Collection table contains a fixed number of rows, which is determined by the
Remote Manager parameter total_entity_slots. This is a nondynamic parameter
and requires a restart of the ACMS system in order to be changed. The default is
20 rows.
Additions to the Collection table are processed immediately, and may affect more
than one ACMS process. See Section 5.1 for a discussion of how the Collection
table affects ACMS data collection.
Example
8.4 ACMSMGMT_ADD_ERR_FILTER_2
This procedure adds entries to the ACMS Error Filter table. Error Filter table
entries can also be deleted (see Section 8.7.
Format
error_filter_config_rec_r_2 *acmsmgmt_add_err_filter_2(err_filter_config_rec_r_2 *err_filter_cfg_rec,CLIENT *cl2)
Parameters
err_filter_cfg_rec
Type: Err_filter_config_rec_r_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Error Filter table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
error_code
Type: Integer
Access: Read
Mechanism: By value
Usage: Structure containing an Error Filter table
record. Error Filter table fields are described
in Section 9.6. See the Description section for
information on how to initialize this record.
cl2
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: Err_filter_status_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type err_filter_update_rec_r, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
status
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Err_filter_update_rec_r
Access: Write
Mechanism: By value
Usage: Structure containing an Error Filter table record.
The entries in this field contain status codes
corresponding to the fields in the err_filter_entry
structure. See the Description section for a
discussion of how to determine the update status
for any field.
Description
This procedure adds a row to the Error Filter table (see Section 9.6).
Additions to this table are durable; that is, they do survive a restart of the
Remote Manager.
Calls to this procedure must specify a valid message_code for the row to be added.
The Error Filter table is dynamic and does not have a fixed upper boundary. The
size of the table fluctuates as entries are added and deleted. When a row becomes
empty or unoccupied, it is removed and the remaining rows are renumbered.
Additions to the Error Filter table are processed immediately, and may affect
more than one ACMS process. See Section 5.1 for a discussion of how the Error
Filter table affects ACMS error logging.
Example
8.5 ACMSMGMT_ADD_TRAP_1
This procedure adds entries to the Remote Manager Trap table. Trap table
entries can also be modified (see Section 8.42) and deleted (see Section 8.8).
Format
trap_status_rec *acmsmgmt_add_trap_1(trap_config_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Trap_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Trap table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
trap_entry
Type: Trap_update_rec_r
Access: Read
Mechanism: By value
Usage: Structure containing a Trap table record. Trap
table fields are described in Section 9.14. See
the Description section for information on how to
initialize this record.
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: Trap_status_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either
a failure code or a structure of type trap_update_rec_r, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
status
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Trap_update_rec_r
Access: Write
Mechanism: By value
Usage: Structure containing a Trap table record.
The entries in this field contain status codes
corresponding to the fields in the trap_entry
structure. See the Description section for a
discussion of how to determine the update status
for any field.
Description
This procedure adds a row to the Trap table (see Section 9.14).
Additions to this table are not durable; that is, they do not survive a restart
of the Remote Manager. To make nondynamic, permanent updates to the Trap
table, use the ACMSCFG utility.
Calls to this procedure must specify entity_type, entity_name, and param_to_
trap. The combination of these fields must be unique within the Trap table for
the row to be added. Table 8–1 and Table 8–4 contain symbolic values used
to populate the collection_class and entity_type fields; symbolic values to the
param_to_trap field are described in Table 8–8.
Setting fields trap_min, trap_max and/or severity to -1 causes them to be
ignored when trap conditions are evaluated at run time; see Section 7.8 for more
discussion. Otherwise, they must contain valid values for the row to be added
(trap_min and trap_max must be position numbers; severity must be one of the
valid severities listed in Table 8–7).
Additions to the Trap table are processed immediately, and may affect more than
one ACMS process. See Section 7.8 for a discussion of how to set SNMP traps.
The size of the Trap table is unbounded.
Example
8.6 ACMSMGMT_DELETE_COLLECTION_1
This procedure deletes entries from the Remote Manager Collection table.
Collection table entries can also be added (see Section 8.3) and updated (see
Section 8.35).
Format
int *acmsmgmt_delete_collection_1(coll_del_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Coll_del_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Collection table fields.
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.
entity_type
Type: Integer
Access: Read
Mechanism: By value
Usage: The type of ACMS entity the process is. Entity
types are listed in Table 8–4.
entity_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Pointer to a character string containing a full
or partial entity name. May contain wildcard
characters (*, !).
collection_class
Type: Integer
Access: Read
Mechanism: By value
Usage: The type of collection class to delete. Collection
classes are listed in Table 8–1.
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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure deletes a row from the Collection table (see Section 9.4).
Calls to this procedure must specify entity_type, entity_name, and collection_
class. The combination of these fields must exactly match an existing row in
the table for the row to be deleted. Table 8–1 and Table 8–4 contain symbolic
values used to populate the collection_class and entity_type fields; entity_name is
specified as a null-terminated string.
ID and CONFIG class rows cannot be deleted.
The Collection table contains a fixed number of rows, which is determined by the
Remote Manager Parameter table field total_entity_slots. This is a nondynamic
parameter and requires a restart of the ACMS system in order to be changed.
The default is 20 rows. When a row is deleted, it becomes immediately available
for reuse.
Deletions from the collection table are processed immediately, and may affect
more than one ACMS process. See Section 5.1 for a discussion of how the
Collection table affects ACMS data collection.
Example
8.7 ACMSMGMT_DELETE_ERR_FILTER_2
This procedure deletes entries from the Remote Manager Error Filter table. Error
Filter table entries can also be added (see Section 8.4).
Format
int *acmsmgmt_delete_err_filter_2(err_del_rec *set_struct,CLIENT *cl2)
Parameters
set_struct
Type: Err_del_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Error Filter table fields.
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.
error_code
Type: Integer
Access: Read
Mechanism: By value
Usage: The type of ACMS entity the process is. Entity
types are listed in Table 8–4.
cl2
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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure deletes rows from the Error Filter table (see Section 9.6).
The Error Filter table is dynamic and does not have a fixed upper boundary. The
size of the table fluctuates as entries are added and deleted. When a row becomes
empty or unoccupied, it is removed and the remaining rows are renumbered.
Changes to the Error Filter table are processed immediately, and may affect more
than one ACMS process. See Section 5.1 for a discussion of how the Error Filter
table affects ACMS error logging.
Example
8.8 ACMSMGMT_DELETE_TRAP_1
This procedure deletes entries from the Remote Manager Trap table. Trap table
entries can also be added (see Section 8.5) and updated (see Section 8.42).
Format
int *acmsmgmt_delete_trap_1(trap_del_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Trap_del_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Trap table fields.
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.
entity_type
Type: Integer
Access: Read
Mechanism: By value
Usage: The type of ACMS entity the process is. Entity
types are listed in Table 8–4.
entity_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Pointer to a character string containing a full
or partial entity name. May contain wildcard
characters (*, !).
param_to_trap
Type: Integer
Access: Read
Mechanism: By value
Usage: The type of parameter to be monitored for
trap conditions. Parameter types are listed in
Table 8–8.
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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure deletes rows from the Trap table (see Section 9.14).
Calls to this procedure must specify entity_type, entity_name, and param_to_
trap. These fields must exactly match an existing record in the Trap table for
the delete to be performed. Table 8–1 and Table 8–4 contain symbolic values
used to populate the collection_class and entity_type fields; symbolic values to the
param_to_trap field are described in Table 8–8.
Deletions from the Trap table are processed immediately and may affect more
than one ACMS process. See Section 7.8 for a discussion of how to set SNMP
traps.
Example
8.9 ACMSMGMT_GET_ACC_2
ACMS Remote Manager clients call this procedure to obtain class information
about an ACMS Central Controller (ACC) on a local or remote node.
Format
acc_rec_out_2 *acmsmgmt_get_acc_2 (sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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: Acc_rec_out_2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason) or the
data requested.
Description
This procedure obtains class information about an ACC. The return pointer
points to a record of type acc_rec_out_2, which contains a union consisting of
either a failure return code or a pointer to an ACC record. See Section 9.2 for a
description of the fields in the ACC record.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.10 ACMS$MGMT_GET_CREDS
Clients that support explicit authentication call this procedure to obtain a client
ID. A client ID is issued for the client process when the client process logs in
to the ACMS Remote Manager using the ACMSMGR LOGIN command. Once
obtained by this procedure, the client ID is used on subsequent RPC calls.
Format
int acms$mgmt_get_creds(char *server_node,char *user_name, int *client)
Parameters
server_node
Type: String
Access: Read
Mechanism: By reference
Usage: Name of the node the server that issued the client ID was
running on; the node that will be accessed. Client_id is valid
only for the server that issued it.
user_name
Type: String
Access: Read
Mechanism: By reference
Usage: Name of the user the client ID was issued to, and on whose
behalf the client ID is used. The name may the same as or
different than the account name of the client process.
client
Type: Integer
Access: Write
Mechanism: By reference
Usage: The client ID to be used for the target user on the target server
node. The client ID is valid only for the client process that
created it.
Return Value
Type: Integer
Access: Write
Mechanism: By value
Usage: The completion status of the call. The following are possible
return values:
Value Description
MGMT_SUCCESS Client ID was fetched; credentials
verified.
MGMT_NO_ Can’t translate UCX$INET_HOST
NODELOGICAL logical name to get local node
name.
MGMT_NO_CREDS_FILE Credentials file was not found.
MGMT_CREDS_DATA_ Credentials file is corrupt.
ERR
MGMT_WRONG_PID PID in credentials file doesn’t
match client process’s PID.
MGMT_WRONG_NODE Node name in credentials file
doesn’t match server_node
argument.
Description
Clients call this procedure to fetch a previously created client ID from an
encrypted credentials file. Credentials files can be created only by the ACMSMGR
LOGIN command. They are stored in the directory pointed to by the logical name
ACMS$MGMT_CREDS_DIR (or SYS$LOGIN if ACMS$MGMT_CREDS_DIR is
not defined). Credentials files are named using the following format:
user-name_pid_target-node_current-node.dat
In this format:
user-name must match the user_name argument string.
pid must match the PID of the client process.
target-node must match the server_node argument string.
current-node must be the local node name (as determined by the logical name
UCX$INET_HOST).
Note
For credentials information to be created, the client process must first
execute the login command of the ACMSMGR utility. The only way to
create credentials files is by using the ACMSMGR utility.
If the credentials file cannot be located, opened, and read, an error is returned.
Once opened and read, the credentials in the file are verified. If the credentials
are acceptable, the client_id field is populated and the procedure returns a status
that indicates success.
This procedure is statically linked and locally executed.
Example
#include <rpc/rpc.h>
#include string
#include "acmsmgmt_rpc.h"
CLIENT *cl;
char sname[] = "sparks";
char *username_p, username[13] = "";
int client_id;
int status;
int acms$mgmt_get_creds();
int main ()
{
/* if the logical is defined, credential information will be used */
username_p = getenv("ACMS$MGMT_USER");
if (username_p)
strcpy(username,username_p);
/* establish an rpc connection to the server */
cl = clnt_create(sname, ACMSMGMT_RPC, ACMSMGMT_VERSION, "tcp");
/* if the connection was established */
if (cl != NULL) {
/* create a security context */
cl->cl_auth = authunix_create_default();
client_id = 0;
/* optionally, get credentials for this user & server */
if (strlen(username))
status = acms$mgmt_get_creds(sname,username,&client_id);
}
return(1);
}
The preceding example is a program that performs initialization for an ACMS
Remote Manager client. The program calls the acms$mgmt_get_creds procedure
to obtain the client ID for the user whose name is defined by the logical name
ACMS$MGMT_USER on the node SPARKS.
8.11 ACMSMGMT_GET_ERR_FILTER_2
ACMS Remote Manager clients call this procedure to obtain a listing of system
messages currently being filtered from the Remote Manager, and subsequently,
the error log.
Format
int *acmsmgmt_get_err_filter_2 (sub_id_struct *sub_id_rec,CLIENT *cl2)
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.
cl2
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: Err_filter_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason) or the
data requested.
Description
This procedure obtains class information about an Error Filter. The return
pointer points to a record of type err_filter_data_list_2, which is a union
containing either an error code or a pointer to an Error Filter record. See
Section 9.6 for a description of the fields in the Error Filter record.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
}
In the preceding example, the acmsmgmt_get_err_filter_2 procedure is called to
fetch error filter information. If the call succeeds, the message code and symbolic
name are fetched. Otherwise, an error message is displayed. The example in
Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.12 ACMSMGMT_GET_MGR_STATUS_1
ACMS Remote Manager clients call this procedure to obtain run-time status
information about a Remote Manager on a particular node.
Format
mgr_status_rec_out *acmsmgmt_get_mgr_status_1(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Mgr_status_rec_out
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting either of a
failure code or a pointer to a structure of type mgr_status_rec,
which contains the status data. The following are the contents of
this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data
Type: Mgr_status_rec
Access: Write
Mechanism: By reference
Usage: Remote Manager status data record. Contains
the fields from the Manager Status table (see
Section 9.9).
Description
This procedure gets run-time information about a Remote Manager on a
particular node. The return pointer points to a record of type mgr_status_
rec_out, which contains a union consisting of a failure returns code or a pointer
to a manager status record. See Section 9.9 for a description of the fields in the
manager status record.
This procedure does not require the ACMS run-time system in order to execute.
Example
if (mgr_data->status != MGMT_SUCCESS) {
printf("\n Call to get RM data failed, returning status code %d",
mgr_data->status);
status = mgr_data->status;
xdr_free(xdr_mgr_status_rec_out, mgr_data);
free(mgr_data);
return(status);
}
mgrs = &mgr_data->mgr_status_rec_out_u.data;
printf("\n RPC UDP state is %d",mgrs->rpc_udp_state);
xdr_free(xdr_mgr_status_rec_out, mgr_data);
free(mgr_data);
return(0);
}
In the preceding example, the ACMSMGMT_GET_MGR_STATUS_1 procedure
is called to fetch the contents of the Manager Status table. If the call succeeds,
the current state of the TCP/UDP protocol in the RPC interface is printed from
the retrieved record. Otherwise, an error message is displayed. The example
in Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.13 ACMSMGMT_GET_PARAM_2
Format
param_rec_out2 *acmsmgmt_get_param_2(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Param_rec_out2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason), or the
data requested.
Description
This procedure gets configuration information about a Remote Manager on a
particular node. The return pointer points to a record of type param_rec_out2,
which contains a union consisting of either a failure return code or a pointer
to a Parameter record. See Section 9.10 for a description of the fields in the
Parameter record.
This procedure does not require the ACMS run-time system in order to execute.
Example
8.14 ACMSMGMT_GET_QTI_2
ACMS Remote Manager clients call this procedure to obtain class information
about a Queued Task Initiator (QTI) on a local or remote node.
Format
qti_rec_out_2 *acmsmgmt_get_qti_2(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Qti_rec_out2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason) or the
data requested.
Description
This procedure obtains class information about a QTI on a local or remote node.
The return pointer points to a record of type qti_rec_out_2, which contains a
union consisting of either a failure return code or a pointer to a QTI record. See
Section 9.11 for a description of the fields in the QTI record.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.15 ACMSMGMT_GET_TSC_2
ACMS Remote Manager clients call this procedure to obtain class information
about a Terminal Subsystem Controller (TSC) on a local or remote node.
Format
tsc_rec_out_2 *acmsmgmt_get_tsc_2(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Tsc_rec_out_2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason) or the
data requested.
Description
The return pointer points to a record of type tsc_rec_out_2, which contains a
union consisting of either a failure return code or a pointer to a TSC record. See
Section 9.15 for a description of the fields in the record.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.16 ACMSMGMT_GET_VERSION_2
ACMS Remote Manager clients call this procedure to obtain version information
for ACMS.
Format
version_data_list_2 *acmsmgmt_get_version_2(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: version_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to record returned. If NULL, the RPC has failed. If not
null, the record contains either an error code in the status field
(the RPC succeeded, but the call failed for another reason) or the
data requested.
Description
The return pointer points to a record of type version_data_list_2, which constains
a union consisting of either a failure return code or a pointer to a version record.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.17 ACMSMGMT_LIST_AGENT_2
ACMS Remote Manager clients call this procedure to obtain a list of Agent
Process table entries.
Format
agent_data_list *acmsmgmt_list_agent_2(agent_sel_struct *sub_rec, CLIENT *cl)
Parameters
sub_rec
Type: agent_sel_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.
proc_name
Type: String
Access: Read
Mechanism: By value
Usage: String that lists the OpenVMS process name for
each Agent.
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: agent_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a union. The union contains either a failure code or a
pointer to a structure of type agent_data_list, which contains the
start of a linked list of records. The following are the contents of
this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: agent_list
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of
Agent table record, and a forward pointer to the
next node in the linked list. The following are the
contents of this structure:.
pNext
Type: agent_write
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
agent_data
Type: agent_rec_r
Access: Write
Mechanism: By reference
Usage: Agent table row. Agent table
fields.
Description
The ACMSMGMT_LIST_AGENT_2 procedure returns a linked list of Agent
table rows. All Agent table rows are returned in each call. Records are returned
sequentially from the table, beginning at the start of the table. Entire table rows
are returned.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Rows in the Agent table are subject to reuse. Rows are assigned round-robin, and
are not cleared until they have been reassigned. So some rows may contain data
for inactive Agents. It is the callers responsibility to examine the record_state
field to determine whether this row belongs to an active (record_state field is
MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE) Agent, and
to process the row accordingly.
Example
8.18 ACMSMGMT_LIST_COLLECTIONS_2
ACMS Remote Manager clients call this procedure to obtain a list of Collection
table entries.
Format
coll_data_list_2 *acmsmgmt_list_collections_2(coll_sel_struct *coll_rec, CLIENT *cl)
Parameters
coll_rec
Type: Coll_sel_struct
Access: Read
Mechanism: By reference
Usage: Defines starting point for list of records to be returned. Also
identifies the user. The coll_rec structure contains the following
fields:
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.
starting_rec
Type: Integer
Access: Read
Mechanism: By value
Usage: Sequential record number (starting at 0) of
record to begin list from. Records are returned
sequentially from the table. Up to max_rpc_
return_recs (Parameter table configuration value)
are returned in each call.
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: Coll_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to a union. The union contains either a failure code or a
pointer to a structure of type coll_list, which contains the start
of a linked list of records. The following are the contents of this
union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Coll_list_2
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of
collection table record, and a forward pointer to
the next node in the linked list. The following are
the contents of this structure:
pNext
Type: Coll_list_2
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
coll_data
Type: Coll_rec_2
Access: Write
Mechanism: By reference
Usage: Collection table row. Collection
table fields are described in
Section 9.4.
Description
The ACMSMGMT_LIST_COLLECTIONS_2 procedure returns a linked list of
collection table rows. The number of rows returned in a single call is bounded
by the value of the Parameter table field max_rpc_return_recs. More than one
call may be required to fetch all the rows. The selection record field starting_rec
determines the table row to begin with. Records are returned sequentially from
the table, beginning with the starting_rec row. Row numbering begins at 0.
Entire table rows are returned. See Section 9.4 for a description of the fields in
the coll_rec structure.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
If the end of the table is reached during execution of this procedure, MGMT_
NOMORE_DATA is returned in the status field.
Example
8.19 ACMSMGMT_LIST_CP_2
ACMS Remote Manager clients call this procedure to obtain a list of Command
Process (CP) table entries.
Format
cp_data_list_2 *acmsmgmt_list_cp_2(cp_sel_struct *sub_rec, CLIENT *cl)
Parameters
sub_rec
Type: Cp_sel_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.
proc_name
Type: String
Access: Read
Mechanism: By value
Usage: String that lists the OpenVMS process name for
each CP.
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: Cp_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either
a failure code or a pointer to a structure of type cp_data_list2,
which contains the start of a linked list of records. The following
are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Cp_list_2
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of CP
table record, and a forward pointer to the next
node in the linked list. The following are the
contents of this structure:
pNext
Type: Cp_list_2
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
cp_data
Type: Cp_rec_r_2
Access: Write
Mechanism: By reference
Usage: CP table row. CP table fields are
described in Section 9.5.
Description
The ACMSMGMT_LIST_CP_2 procedure returns a linked list of CP table rows.
All CP table rows are returned in each call. Records are returned sequentially
from the table, beginning at the start of the table.
Entire table rows are returned. See Section 9.5 for a description of the fields in
the cp_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Rows in the CP table are subject to reuse. Rows are assigned round-robin, and
are not cleared until they have been reassigned. So some rows may contain data
for inactive CPs. It is the caller’s responsibility to examine the record_state
field to determine whether this row belongs to an active (record_state field is
MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE) CP, and to
process the row accordingly.
Example
8.20 ACMSMGMT_LIST_ERR_2
ACMS Remote Manager clients call this procedure to obtain a list of the error log
entries.
Format
err_data_list *acmsmgmt_list_err_2(err_sel_struct *err_sel, CLIENT *cl)
Parameters
log_rec
Type: Log_sel_struct
Access: Read
Mechanism: By reference
Usage: Defines which log records to return. The log_sel_struct contains
the following fields:
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.
before_time
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing a valid OpenVMS ASCII time string.
This field determines the chronological starting
point for the list of records to be returned. If
omitted, records are returned beginning at the
start of the file. Format is OpenVMS ASCII time
(DD-MMM-YY HH:MM:SS.hh).
since_time
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing a valid OpenVMS ASCII time string.
This field determines the chronological ending
point for the list of records to be returned. If
omitted, records are returned until end of file
is reached. Format is OpenVMS ASCII time
(DD-MMM-YY HH:MM:SS.hh).
file_name
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing either a valid OpenVMS file
specification or a logical name pointing to a valid
OpenVMS file specification. This field determines
the log file to be processed. An empty string
requests the default (currently open) log file.
dup_count
Type: Integer
Access: Read
Mechanism: By value
Usage: A sequential counter of records with the same
time. This allows records to be unique even if
they were generated at the same time. Set this
value to -1 for the initial call.
facility
Type: Integer
Access: Read, optional
Mechanism: By value
Usage: Value of a valid Remote Manager facility. If
specified, only records with matching facility
codes are returned. Facility codes are listed in
Section 8.1.5.
severity
Type: Integer
Access: Read, optional
Mechanism: By value
Usage: Value of a valid Remote Manager severity. If
specified, only records with matching severity are
returned. Severities are listed in Section 8.1.7.
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: Log_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a union. The union contains either a failure code
or a pointer to the start of a linked list of records. See the
Description section for a discussion of the structure of the union.
The following are the contents of this record:
log_data_list
Type: Logging_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a structure of type logging_rec.
dup_count
Type: Integer
Access: Write
Mechanism: By value
Usage: Integer value with uniquely identifies records
generated at the same time.
log_msg
Type: Null-terminated character string
Access: Write
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing the error information.
pNext
Type: Log_list
Access: Write
Mechanism: By value
Usage: Pointer to the next record in the linked list.
Description
The ACMSMGMT_LIST_ERR_2 procedure returns a linked list of error log
entries, ordered by time. The records to be returned are determined by the fields
specified in the log_sel_struct input argument. Records can be selected by
date and time, facility, and severity. Note that only max_rpc_return_rec data
(Parameter table field) is returned in each call. The end of data is signaled by
the status field (see the following example). If the end of data is not signaled,
repeated calls are needed to fetch all matching records.
The return record is a union containing either a failure code or the first record in
the list:
struct log_data_list {
int status;
union {
int rc;
log_list list;
} log_data_list_u;
};
To determine the status of the call and the contents of the return record, first
check the status field. The following are possible values in the status field:
• MGMT_FAIL
The call has failed and the rc field contains a specific error code describing
the failure.
• MGMT_NOMORE_DATA
There are no more records in the file. The linked list may or may not contain
the final records, depending on whether any more records matched the
selection criteria.
• MGMT_SUCCESS
The call completed successfully. More records exist than were returned in the
call.
Example
if (log->status == MGMT_NOMORE_DATA)
printf("\n *** End of data**");
else {
skip_rec = 1;
goto top;
}
xdr_free(xdr_log_data_list, log);
free(log);
return(0);
}
In the preceding example, the ACMSMGMT_LIST_ERR_2 procedure is called
to fetch the contents of the error log. If the call succeeds, the node, symbolic
name, and code equivalent are displayed for each ACMS run-time error relayed
to the Remote Manager. Otherwise, an error message is displayed. The example
in Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.21 ACMSMGMT_LIST_EXC_2
ACMS Remote Manager clients call this procedure to obtain a list of Application
Execution Controller (EXC) (ACMS application) table entries.
Format
exc_data_list_2 *acmsmgmt_list_exc_2(exc_sel_struct *sub_rec, CLIENT *cl)
Parameters
sub_rec
Type: Exc_sel_struct
Access: Read
Mechanism: By reference
Usage: Structure that contains client information and application
selection critera. The structure contains the following fields.
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.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to an application name. The name may
contain wildcard characters (*, !). Specify in all
uppercase characters.
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: Exc_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type exc_data_list_2,
which contains the start of a linked list of records. The following
are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Exc_list_2
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure
containing an EXC table record, and a forward
pointer to the next node in the linked list. The
following are the contents of this structure:
pNext
Type: Exc_list_2
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
exc_data
Type: Exc_rec_r_2
Access: Write
Mechanism: By reference
Usage: EXC table row. EXC table fields
are described in Section 9.7.
Description
The ACMSMGMT_LIST_EXC_2 procedure returns a linked list of EXC table
rows. All EXC table rows whose application_name field matches the appl_name
field in the selection record are returned in each call.
Entire table rows are returned. See Section 9.7 for a description of the fields in
the exc_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Rows in the EXC table are subject to reuse. Rows are assigned round-robin,
and are not cleared until they have been reassigned. Therefore, some rows may
contain data for inactive EXCs. It is the caller’s responsibility to examine the
record_state field to determine whether this row belongs to an active (record_state
field is MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE) EXC,
and to process the row accordingly.
Example
8.22 ACMSMGMT_LIST_INTERFACES_1
ACMS Remote Manager clients call this procedure to obtain information about all
configured interfaces for a Remote Manager server on a local or remote node.
Format
interfaces_rec_out *acmsmgmt_list_interfaces_1 (sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Interfaces_rec_out
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to the start of a linked list of records.
See the Description section for a discussion of the structure of the
union. The records contain all the fields of the Interfaces table
(see Section 9.8).
Description
The ACMSMGMT_LIST_INTERFACES_1 procedure returns an array of Remote
Manager Interfaces table rows. All records in the table are returned. Each record
represents a separate interface, as determined by the interface_type field.
The return record is a union containing either a failure code or the first record in
the list, as follows:
struct interfaces_rec_out {
int status;
union {
interfaces_rec_out_r interfaces;
int rc;
} interfaces_rec_out_u;
};
To determine the status of the call and the contents of the return record, first
check the status field. The following are possible values in the status field:
• MGMT_FAIL
The call has failed and the rc field contains a specific error code describing
the failure.
• MGMT_SUCCESS
The call completed successfully. All rows in the table were returned.
The array is contained in a structure of type interfaces_rec_out_r with an
integer field (num_elements) containing the size of the array, as follows:
struct interfaces_rec_out_r {
int num_elements;
interfaces_rec values[MGMT_K_MAX_IF];
};
Example
if_ptr = acmsmgmt_list_interfaces_1(&sub_rec,cl);
if (!if_ptr) {
printf("\n RPC Call to get Interfaces data failed");
return(MGMT_FAIL);
}
inter = &if_ptr->interfaces_rec_out_u.interfaces;
if (if_ptr->status == MGMT_FAIL) {
printf("\n Call to get Interfaces data failed, returning status code
%d",if_ptr->interfaces_rec_out_u.rc);
status = if_ptr->interfaces_rec_out_u.rc;
xdr_free(xdr_interfaces_rec_out, if_ptr);
free(if_ptr);
return(status);
}
printf("\n RPC interface has processed %d read requests",
inter->values[0].get_request_count);
printf("\n SNMP interface has processed %d read requests",
inter->values[1].get_request_count);
xdr_free(xdr_interfaces_rec_out, if_ptr);
free(if_ptr);
return(0);
}
In the preceding example, the ACMSMGMT_LIST_INTERFACES_1 procedure
is called to fetch the contents of the Interfaces table. If the call succeeds, the
number of read requests by each interface is printed from the retrieved record.
Otherwise, an error message is displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.23 ACMSMGMT_LIST_LOG_1
ACMS Remote Manager clients call this procedure to obtain information from a
Remote Manager log on a local or remote node.
Format
log_data_list *acmsmgmt_list_log_1 (log_sel_struct *log_rec, CLIENT *cl)
Parameters
log_rec
Type: Log_sel_struct
Access: Read
Mechanism: By reference
Usage: Defines which log records to return. The log_sel_struct contains
the following fields:
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.
before_time
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing a valid OpenVMS ASCII time string.
This field determines the chronological starting
point for the list of records to be returned. If
omitted, records are returned beginning at the
start of the file. Format is OpenVMS ASCII time
(DD-MMM-YY HH:MM:SS.hh).
since_time
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing a valid OpenVMS ASCII time string.
This field determines the chronological ending
point for the list of records to be returned. If
omitted, records are returned until end of file
is reached. Format is OpenVMS ASCII time
(DD-MMM-YY HH:MM:SS.hh).
file_name
Type: Null-terminated character string
Access: Read, optional
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing either a valid OpenVMS file
specification or a logical name pointing to a valid
OpenVMS file specification. This field determines
the log file to be processed. An empty string
requests the default (currently open) log file.
dup_count
Type: Integer
Access: Read
Mechanism: By value
Usage: A sequential counter of records with the same
time. This allows records to be unique even if
they were generated at the same time. Set this
value to -1 for the initial call.
facility
Type: Integer
Access: Read, optional
Mechanism: By value
Usage: Value of a valid Remote Manager facility. If
specified, only audit records with matching
facility codes are returned. Facility codes are
listed in Section 8.1.5.
severity
Type: Integer
Access: Read, optional
Mechanism: By value
Usage: Value of a valid Remote Manager severity. If
specified, only audit records with matching
severity are returned. Severities are listed in
Section 8.1.7.
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: Log_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a union. The union contains either a failure code
or a pointer to the start of a linked list of records. See the
Description section for a discussion of the structure of the union.
The following are the contents of this record:
log_data_list
Type: Logging_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a structure of type logging_rec.
dup_count
Type: Integer
Access: Write
Mechanism: By value
Usage: Integer value with uniquely identifies records
generated at the same time.
log_msg
Type: Null-terminated character string
Access: Write
Mechanism: By reference
Usage: Pointer to a null-terminated character string
containing the audit information.
pNext
Type: Log_list
Access: Write
Mechanism: By value
Usage: Pointer to the next record in the linked list.
Description
Note
The ACMSMGMT_LIST_LOG_1 procedure is also described in detail in
Section 6.6.1.
• MGMT_SUCCESS
The call completed successfully. More records exist than were returned in the
call.
The ACMSMGMT_LIST_LOG_1 procedure returns n records per call, where n
is determined by the Remote Manager parameter field max_rpc_return_recs.
Therefore, repeated calls may be necessary to retrieve all records that match
the selection criteria. Context is not maintained by the server between calls; the
selection criteria are evaluated on each call by the Remote Manager. Following
the initial call, callers should place the correct time value in the since_time field
of the log_sel_struct input argument, as well as the correct dup_count value in
order to have the chronologically next n records returned.
This procedure does not require the ACMS run-time system to execute.
Example
if (log->status == MGMT_NOMORE_DATA)
printf("\n *** End of data **");
else {
skip_rec = 1;
goto top;
}
xdr_free(xdr_log_data_list, log);
free(log);
return(0);
}
In the preceding example, the ACMSMGMT_LIST_LOG_1 procedure is called
to fetch the contents of the RM log file. All entries since January 1, 1998 are
requested. If the call succeeds, each entry is printed out. Otherwise, an error
message is displayed. This example is very similar to the one described in detail
in Chapter 6. The example in Section 6.4.1 shows how to declare and initialize
the input arguments to this procedure.
8.24 ACMSMGMT_LIST_PROC_1
ACMS Remote Manager clients call this procedure to obtain a list of ACMS
processes running on a particular node, along with some collection state
information for each process.
Format
proc_data_list *acmsmgmt_list_proc_1 (sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Proc_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type proc_link, which
contains the start of a linked list of records. The following are the
contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Proc_list
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of
process data, and a forward pointer to the next
node in the linked list. The following are the
contents of this structure:
pNext
Type: Proc_list
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type user_list.
proc_data
Type: Proc_rec
Access: Write
Mechanism: By reference
Usage: The data describing the process.
This record contains the following
fields:
record_state
Type: Integer
Access: Write
Mechanism: By value
Usage: The current state
of the record.
Will be either
MGMT_VALID
or MGMT_
INACTIVE.
entity_type
Type: Integer
Access: Write
Mechanism: By value
Usage: The type of
ACMS entity the
process is. Entity
types are listed
in Section 8.1.4.
pid
Type: Integer
Access: Write
Mechanism: By value
Usage: OpenVMS
Process ID.
process_name
Type: Null-terminated
string
Access: Write
Mechanism: By reference
Usage: The OpenVMS
process name.
class_states
Type: Array of integers
Size: 5
Access: Write
Mechanism: By value
Usage: An array of
integers. Each
array element
represents
the collection
state for a class.
Positions are:
• 0: ID
• 1: CONFIG
• 2: RUNTIME
• 3: POOL
• 4: ERROR
Description
The ACMSMGMT_LIST_PROC_1 procedure returns a linked list of processes that
a particular Remote Manager is aware of. The Remote Manager builds this list
from the various ACMS Entity tables (Chapter 9). For each process, the Remote
Manager populates a proc_data record.
Note that some entity tables may contain rows with inactive data, that is, data
for processes that are no longer active. The data in these rows may or may not be
interesting to the caller. To distinguish active and inactive processes, the Remote
Manager sets the record_state field to MGMT_VALID for active processes and to
MGMT_INACTIVE for inactive processes. The caller is responsible for checking
this field and taking appropriate action.
The collection_states field is a simple array of five integers. Each array element
contains either a 1 (if the collection class is enabled) or a 0 (if the collection class
is disabled). Array elements are positional, as described in the Return Value
section.
Like other procedures that return linked lists (see Section 6.6.1 for a detailed
example of linked-list processing), the return parameter is a union containing
either a failure status code or a linked list of records.
To determine the status of the call and the contents of the return record, first
check the status field. The following are possible values in the status field:
• MGMT_FAIL
The call has failed and the rc field contains a specific error code describing
the failure.
• MGMT_SUCCESS
The call completed successfully. All user records have been returned.
If the status field value is MGMT_SUCCESS, a linked list has been returned.
The linked list contains a structure containing the process data, and a forward
pointer. By following the forward pointer, all the records in the list can be
retrieved.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.25 ACMSMGMT_LIST_SERVER_1
ACMS Remote Manager clients call this procedure to obtain a list of procedure
server table (Server table) entries.
Format
ser_data_list *acmsmgmt_list_server_1(ser_sel_struct *sub_rec, CLIENT *cl)
Parameters
sub_rec
Type: Ser_sel_struct
Access: Read
Mechanism: By reference
Usage: Structure that contains client information and procedure server
selection criteria. The structure contains the following fields.
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.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to an application name. The name may
contain wildcard characters (*, !). Specify in all
uppercase characters.
server_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to a procedure server name. The name
may contain wildcard characters (*, !). Specify in
all uppercase characters.
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: Ser_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type ser_link, which
contains the start of a linked list of records. The following are the
contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Ser_list
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure
containing an EXC table record, and a forward
pointer to the next node in the linked list. The
following are the contents of this structure:
pNext
Type: Ser_list
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
ser_data
Type: Ser_rec_r
Access: Write
Mechanism: By reference
Usage: Server table row. Server
table fields are described in
Section 9.12.
Description
The ACMSMGMT_LIST_SER_1 procedure returns a linked list of Server table
rows. All matching Server table rows are returned in each call. Matching is
performed first on application name, and then on server name. Therefore, all
matching servers for all matching applications are returned.
Entire table rows are returned. See Section 9.12 for a description of the fields in
the ser_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Rows in the EXC table are subject to reuse. Rows are assigned round-robin,
and are not cleared until they have been reassigned. Therefore, some rows may
contain data for inactive EXCs. The Remote Manager attempts to retrieve server
information for inactive EXCs. It is the caller’s responsibility to examine the
record_state field to determine whether this row belongs to an active (record_
state field is MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE)
EXC, and to process the row accordingly.
Example
if (ser_data->status == MGMT_FAIL) {
if (ser_data->ser_data_list_u.rc == MGMT_NOMORE_DATA) {
printf("\n No SERVER data found");
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(MGMT_FAIL);
}
printf("\n Call to get Server data failed, returning status code %d",
ser_data->ser_data_list_u.rc);
status = ser_data->ser_data_list_u.rc;
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(status);
}
if (ser_data->status == MGMT_WARN)
printf("\n ** Warning, some data may be from inactive processes **");
for (nl = ser_data->ser_data_list_u.list; nl != NULL; nl = nl->pNext) {
if (nl->ser_data.record_state == MGMT_INACTIVE)
printf("\n INACTIVE ");
else
printf("\n ");
printf(" Application : %-32s Server: %-s",
nl->ser_data.appl_name,
nl->ser_data.server_name);
}
printf("\n End of data");
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(0);
}
In the preceding example, the ACMSMGMT_LIST_SERVER_1 procedure is
called to fetch the contents of the Server tables for all applications on the target
node. If the call succeeds, the state of the server (if inactive), the name of the
application it belongs to, and the name of the server are displayed for each
table row returned. Otherwise, an error message is displayed. The example in
Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.26 ACMSMGMT_LIST_TG_2
ACMS Remote Manager clients call this procedure to obtain a list of Task Group
table entries.
Format
tg_data_list_2 *acmsmgmt_list_tg_2(tg_sel_struct *sub_rec, CLIENT *cl)
Parameters
sub_rec
Type: Tg_sel_struct
Access: Read
Mechanism: By reference
Usage: Structure that contains client information and task group
selection critera. The structure contains the following fields.
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.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to an application name. The name may
contain wildcard characters (*, !). Specify in all
uppercase characters.
tg_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to a task group name. The name may
contain wildcard characters (*, !). Specify in all
uppercase characters.
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: Tg_data_list_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type tg_link_2, which
contains the start of a linked list of records. The following are the
contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Tg_list_2
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure
containing a Task Group table record, and a
forward pointer to the next node in the linked list.
The following are the contents of this structure:
pNext
Type: Tg_list_2
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type coll_list.
tg_data
Type: Tg_rec_r_2
Access: Write
Mechanism: By reference
Usage: Task Group table row. Task
Group table fields are described
in Section 9.13.
Description
The ACMSMGMT_LIST_TG_2 procedure returns a linked list of Task Group table
rows. All matching Task Group table rows are returned in each call. Matching
is performed first on the application name, and then on the task group name.
Therefore, all matching task groups for all matching applications are returned.
Entire table rows are returned. See Section 9.13 for a description of the fields in
the tg_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Rows in the EXC table are subject to reuse. Rows are assigned round-robin,
and are not cleared until they have been reassigned. Therefore, some rows may
contain data for inactive EXCs. The Remote Manager will attempt to retrieve
task group information for inactive EXCs. It is the caller’s responsibility to
examine the record_state field to determine whether this row belongs to an active
(record_state field is MGMT_VALID) or inactive (record_state field is MGMT_
INACTIVE) EXC, and to process the row accordingly.
Example
if (tg_data->status == MGMT_FAIL) {
if (tg_data->tg_data_list_2_u.rc == MGMT_NOMORE_DATA) {
printf("\n No GROUP data found");
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(MGMT_FAIL);
}
printf("\n Call to get Task Group data failed, returning status code
%d",tg_data->tg_data_list_2_u.rc);
status = tg_data->tg_data_list_2_u.rc;
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(status);
}
if (tg_data->status == MGMT_WARN)
printf("\n ** Warning, some data may be from inactive processes **");
for (nl = tg_data->tg_data_list_2_u.list; nl != NULL; nl = nl->pNext) {
if (nl->tg_data.record_state == MGMT_INACTIVE)
printf("\n INACTIVE ");
else
printf("\n ");
printf(" Application: %-32s Task Group: %-s",
nl->tg_data.appl_name,
nl->tg_data.tg_name);
}
printf("\n End of data");
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(0);
}
In the preceding example, the ACMSMGMT_LIST_TG_1 procedure is called to
fetch the contents of the Task Group tables for all applications on the target
node. If the call succeeds, the state of the task group (if inactive), the name of
the application it belongs to, and the name of the task group are displayed for
each table row returned. Otherwise, an error message is displayed. The example
in Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.27 ACMSMGMT_LIST_TRAP_1
ACMS Remote Manager clients call this procedure to obtain a list of Trap table
entries.
Format
trap_data_list *acmsmgmt_list_trap_1(sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: Trap_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type trap_link, which
contains the start of a linked list of records. The following are the
contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: Trap_list
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of trap
table rows, and a forward pointer to the next
node in the linked list. The following are the
contents of this structure:
pNext
Type: Trap_list
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type trap_list.
trap_data
Type: Trap_rec
Access: Write
Mechanism: By reference
Usage: Trap table row. Trap table fields
are described in Section 9.14.
Description
The ACMSMGMT_LIST_TRAP_1 procedure returns a linked list of Trap table
rows. All Trap table rows are returned in each call. Records are returned
sequentially from the table, beginning at the start of the table.
Entire table rows are returned. See Section 9.14 for a description of the fields in
the trap_rec structure.
This procedure does not require the ACMS run-time system in order to execute.
Example
8.28 ACMSMGMT_LIST_USERS_1
ACMS Remote Manager clients call this procedure to obtain information about
users attached to a Remote Manager server on a local or remote node.
Format
user_data_list *acmsmgmt_list_users_1 (sub_id_struct *sub_rec, CLIENT *cl)
Parameters
sub_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: User_data_list
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a pointer to a structure of type user_link, which
contains the start of a linked list of records. The following are the
contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
list
Type: User_list
Access: Write
Mechanism: By reference
Usage: Start of linked list. Pointer to a structure of user
data, and a forward pointer to the next node in
the linked list. The following are the contents of
this structure:
pNext
Type: User_list
Access: Write
Mechanism: By value
Usage: Start of linked list. Pointer to a
structure of type user_list.
user_data
Type: User_rec
Access: Write
Mechanism: By reference
Usage: The data describing the user.
This record contains the following
fields:
client_id
Type: Integer
Access: Write
Mechanism: By value
Usage: Integer value
containing the
client ID for the
user.
reserved
Type: Integer
Access: Write
Mechanism: By value
Usage: Reserved for HP
use.
gid
Type: Word
Access: Write
Mechanism: By value
Usage: UIC group
identifier.
uid
Type: Word
Access: Write
Mechanism: By value
Usage: UIC user
identifier.
proxy_gid
Type: Word
Access: Write
Mechanism: By value
Usage: UIC group
identifier of
the proxy user,
if proxy is being
used.
proxy_uid
Type: Word
Access: Write
Mechanism: By value
Usage: UIC user
identifier of
the proxy user,
if proxy is being
used.
node-name
Type: Null-terminated
string
Access: Write
Mechanism: By reference
Usage: Pointer to a null-
terminated string
containing the
name of the node
from which the
user logged in.
expires
Type: Null-terminated
string
Access: Write
Mechanism: By reference
Usage: Time the user’s
credentials
expire. Time
is expressed in
OpenVMS ASCII
time format (DD-
MMM-YYYY
HH:MM:SS.hh).
user-name
Type: Null-terminated
string
Access: Write
Mechanism: By reference
Usage: Pointer to a null-
terminated string
containing the
user name.
rights
Type: Array of integers
Access: Write
Mechanism: By value
Usage: ACMS
management
rights identifiers
held by the user.
proxy_flag
Type: Integer
Access: Write
Mechanism: By value
Usage: Indicates whether
the record is for
a proxy user
(proxy_flag =
1) or is not for
a proxy user
(proxy_flag = 0).
Description
The ACMSMGMT_LIST_USERS_1 procedure returns a linked list of users who
are logged in to a particular Remote Manager. All user records are returned on
each call to this procedure.
Like other procedures that return linked lists, the return parameter is a
union containing either a failure status code or a linked list of records. (See
Section 6.6.1 for a detailed example of linked list processing.)
To determine the status of the call and the contents of the return record, first
check the status field. The following are possible values for the status field:
• MGMT_FAIL
The call has failed, and the rc field contains a specific error code describing
the failure.
• MGMT_SUCCESS
The call completed successfully. All user records have been returned.
If the status field is equal to MGMT_SUCCESS, a linked list has been returned.
The linked list contains a structure containing the user data and a forward
pointer. By following the forward pointer, all the records in the list can be
retrieved.
This procedure does not require the ACMS run-time system to execute.
Example
8.29 ACMSMGMT_REPLACE_SERVER_1
Format
cmd_output_rec *acmsmgmt_replace_server_1(ser_sel_struct *sub_rec,CLIENT *cl)
Parameters
sub_rec
Type: Ser_sel_struct
Access: Read
Mechanism: By reference
Usage: Structure that contains client information and procedure server
selection criteria. The structure contains the following fields.
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.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to an application name. The name may
contain wildcard characters (*, !). Specify in all
uppercase characters.
server_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: A pointer to a procedure server name. The name
may contain wildcard characters (*, !). Specify in
all uppercase characters.
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, 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 have an ACMS procedure server replaced (stopped
and started) in an application that is running on the same node on which the
Remote Manager is running. The combination of appl_name and server_name in
the input record determines which server will be replaced.
This call executes synchronously. It does not return to the caller until the attempt
to replace the server is complete. Any messages associated with an unsuccessful
replacing of the server 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 structures 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. There are no status messages associated with a successful call.
If the status field contains MGMT_FAIL, the call failed. There are no status
messages returned; instead, the reason for the failure is contained in the rc field.
Example
8.30 ACMSMGMT_RESET_LOG_1
This procedure requests the Remote Manager to close the current version of its
log file and open a new one.
Format
int *acmsmgmt_reset_log_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure requests the Remote Manager to close the currently open version
of its log and to open a new one. All subsequent log entries are posted to the new
version, and the old version can be safely removed.
Example
8.31 ACMSMGMT_RESET_ERR_2
This procedure requests the Remote Manager to close the current version of the
error log file and open a new one.
Format
int *acmsmgmt_reset_err_2(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure requests the Remote Manager to close the currently open version
of the error log and to open a new one. All subsequent erro log entries are posted
to the new version, and the old version can be safely removed.
Example
8.32 ACMSMGMT_SAVE_ERR_FILTER_2
This procedure saves the current error filter records to an error filter file.
Format
int *acmsmgmt_save_err_filter_2(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
set_struct
Type: Err_filter_config_rec_r_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client authorization and
error filter record 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.
err_filter_file_name
Type: file_spec
Access: Read
Mechanism: By value
Usage: Specifies the OpenVMS file specification for the
error filter file.
err_msg_name
Type: String
Access: Read
Mechanism: By value
Usage: Symbolic name of the error message.
err_code
Type: String
Access: Read
Mechanism: By value
Usage: Decimal or hexadecimal code for the error
message.
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 a status code containing a success or failure status
code. MGMT_SUCCESS indicates success. Other values indicate
failure.
Description
This procedure saves all records in the Error Filter table to the specified ASCII
text file.
Example
procedure is called to save all the records in the Error Filter table to the
file SYS$LOGIN:ERR_FILTER.DAT. If the call succeeds, a success message
is displayed. Otherwise, an error message is displayed. The example in
Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.33 ACMSMGMT_SET_ACC_2
This procedure modifies ACMS Central Controller (ACC) Config class fields.
Format
acc_status_rec_2 *acmsmgmt_set_acc_2(acc_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Acc_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
ACC table fields.
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.
active_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether active variables should be
updated (active_sw = 1). Active variables are
currently in use by the ACMS system; updates to
active variables take effect immediately but are
not durable (that is, they do not survive a restart
of the ACMS system). Not all variables are
dynamic, however. Refer to Section 9.2, and to
the field descriptions in this section, to determine
whether a particular variable can be updated
dynamically.
current_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether current variables should be
updated (current_sw = 1). Current variables are
those stored in the ACMSGEN file currently in
use by the ACMS system and are durable (that is,
they can survive a restart of the ACMS system).
Updates to current variables take effect when the
ACMS system is restarted.
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: Acc_status_rec_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type acc_config_rec_out_2, which
contains status codes for each field, as well as a linked list of
status messages associated with the update. See the Description
section for a discussion of how to determine the update status for
any field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Acc_config_rec_out
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
fields in the acc_config_rec_2 structure, as well
as a linked list of status messages associated
with the update. See the Description section for a
discussion of how to determine the update status
for any field. 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 updates to ACMS ACC Config class fields contained in
the ACC table (see Section 9.2). Note that the ACC table contains both active and
stored values. The active_sw field and current_sw field control which fields are to
be updated.
Attempting to update an active field that is nondynamic is essentially useless,
since the value of the active field value will not change. For instance, calling this
procedure with the active_sw field set to 1 and the acc_username field populated
produces no change to the system.
Setting the current_sw field to 1 causes updates to be written to the current
ACMSGEN file. These updates are durable (that is, they can survive a restart
of the ACMS sytem), but they do not affect the active system until the system is
restarted.
For any nonnegative integer fields, the completion status of the update is
returned in the corresponding field in the return structure. For string fields, the
string field value is returned regardless of the status of the call.
In order to have one of the string fields set to a null string (that is, ""), populate
the field with the value NULL. To have one of the string fields ignored, pass in a
null string.
Example
memset(&set_struct,-1,sizeof(set_struct));
set_struct.client_id = client_id;
set_struct.active_sw = 1;
set_struct.current_sw = 0;
set_struct.audit_state = MGMT_STATE_DISABLED;
/* Have to provide a pointer for string conversions by XDR
or it will access vio. RM will ignore any fields with
strlen of 0 */
set_struct.acc_username = c_null_str;
set_struct.username_default = c_null_str;
set_struct.node_name = c_null_str;
ret_struct = acmsmgmt_set_acc_2(&set_struct,cl);
if (!ret_struct) {
printf("\n Call to modify ACC failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS)
printf("\n Call to modify ACC returned the following warnings or
errors\n");
else
printf("\n Call to modify ACC completed\n");
for (nl = ret_struct->acc_status_rec_2_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
xdr_free(xdr_acc_status_rec_2, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the acmsmgmt_set_acc_2 procedure is called to disable
system auditing on the target node. If the call succeeds, system auditing is
disabled on the target node, and a success message is displayed. Otherwise, an
error message is displayed. The example in Section 6.4.1 shows how to declare
and initialize the input arguments to this procedure.
8.34 ACMSMGMT_SET_AGENT_2
Format
agent_status_rec *acmsmgmt_set_agent_2(agent_config_rec *agent_cfg_rec,CLIENT *cl)
Parameters
set_struct
Type: agent_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Agent table fields.
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.
current_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Update current values flag, required to be set to
1.
pid
Type: Integer
Access: Read
Mechanism: By reference
Usage: PID of the Agent process to be updated, required.
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: agent_status_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type agent_config_rec_out, which
contains status codes for each quota field, as well as a linked list
of status messages associated with the update. The following are
the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: agent_config_rec_out
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
quota fields in the agent_config_rec structure, as
well as a linked list of status messages associated
with the update. 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.
Note
This procedure requests updates to ACMS Agent Config class fields
contained in the Agent table at the end of this section. Note that the
Agent table contains both active and stored quota values; however, only
the stored fields can be changed.
Description
The ACMSMGMT_SET_AGENT_2 procedure sets the three user time fields and
six user data fields, these fields are provided for agent developers to use as they
see fit for individual agents.
If the ACMS run-time system is not running when this call is issued, the Remote
Manager returns the MGMT_NOT_MAPPED error code.
Example
8.35 ACMSMGMT_SET_COLLECTION_2
Format
coll_status_rec_2 *acmsmgmt_set_collection_2(coll_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Coll_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
collection table fields.
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.
coll
Type: Coll_update_rec_r_2
Access: Read
Mechanism: By value
Usage: Structure containing a Collection table record.
Collection table fields are described in Section 9.4.
See the Description section for information on
how to initialize this record.
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: Coll_status_rec_2
Access: write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type coll_update_rec_r_2, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
rc
Type: Integer
Access: write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Coll_output_rec_r_2
Access: write
Mechanism: By value
Usage: Structure containing a Collection table record.
The entries in this field contain status codes that
correspond to the fields in the coll structure. See
the Description section for a discussion of how to
determine the update status for any field.
Description
This procedure requests updates to fields in the Collection table (see Section 9.4).
Updates to this table are not durable; that is, they do not survive a restart of
the Remote Manager. To make nondynamic, permanent updates to the collection
table, use the ACMSCFG utility.
Calls to this procedure must specify entity_type, entity_name, and collection_
class. These fields must exactly match an existing record in the Collection table
for the update to be applied. Table 8–1 and Table 8–4 contain symbolic values
used to populate the collection_class and entity_type fields; entity_name is
specified as a null-terminated string.
For any nonnegative fields, the completion status of the update is returned in
the corresponding field in the return structure. This includes the key fields of
entity_type, entity_name, and collection_class. If no matching record is found in
the table, entity_type and collection_class contain values of MGMT_FAIL.
Updates to the collection table are processed immediately and may affect more
than one ACMS process. See Section 5.1 for discussion of how the collection table
affects ACMS data collection.
Example
8.36 ACMSMGMT_SET_CP_2
This procedure modifies the ACMS Central Process (CP) class attributes.
Format
cp_status_rec_2 *acmsmgmt_set_cp_2(cp_config_rec_2 *cp_cfg_rec,CLIENT *cl)
Parameters
cp_cfg_rec_2
Type: Cp_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
collection table fields.
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: Cp_status_rec_2
Access: write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either
a failure code or a structure of type config_rec_out_2, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
rc
Type: Integer
Access: write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Config_rec_out_2
Access: write
Mechanism: By value
Usage: Structure containing a CP table record. The
entries in this field contain status codes that
correspond to the fields in the cp structure. See
the Description section for a discussion of how to
determine the update status for any field.
Description
This procedure requests updates to fields in the CP table (see Section 9.5).
Updates to this table are not durable; that is, they do not survive a restart of
the Remote Manager. To make nondynamic, permanent updates to the collection
table, use the ACMSCFG utility.
Updates to the CP table are processed immediately and may affect more than one
ACMS process.
Example
if (!ret_struct) {
printf("\n Call to modify CP failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS)
printf("\n Call to modify CP returned the following warnings or
errors\n");
else
printf("\n Call to modify CP completed\n");
for (nl = ret_struct->cp_status_rec_2_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
xdr_free(xdr_cp_status_rec_2, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_SET_CP_2 procedure is called.
Otherwise, an error message is displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.37 ACMSMGMT_SET_EXC_2
This procedure modifies the ACMS Application Execution Controller (EXC) Config
class attributes.
Format
exc_status_rec_2 *acmsmgmt_set_exc_2(exc_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Exc_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
EXC table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Name of the application to update.
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: Exc_status_rec_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type exc_config_rec_out_2, which
contains status codes for each field, as well as a linked list of
status messages associated with the update. See the Description
section for a discussion of how to determine the update status for
any field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Exc_config_rec_out_2
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
fields in the exc_config_rec_2 structure, as well
as a linked list of status messages associated
with the update. See the Description section for a
discussion of how to determine the update status
for any field. 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 updates to ACMS EXC Config class fields contained in
the EXC table (see Section 9.7). Note that the EXC table contains both active and
stored values; however, only the active fields can be changed. In order to change
the stored values, the application must be rebuilt.
For any nonnegative integer fields, the completion status of the update is
returned in the corresponding field in the return structure.
Example
if (!ret_struct) {
printf("\n Call to modify EXC failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS)
printf("\n Call to modify EXC returned the following warnings or
errors\n");
else
printf("\n Call to modify EXC completed\n");
for (nl = ret_struct->exc_status_rec_2_u.data.cmd_output; nl != NULL; nl =
nl->pNext)
printf("\n %s",nl->dcl_msg);
xdr_free(xdr_exc_status_rec_2, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_SET_EXC_2 procedure is called to
disable application auditing for the application VR_APPL on the target node. If
the call succeeds, the VR_APPL no longer writes application auditing messages,
and a success message is displayed. Otherwise, an error message is displayed.
The example in Section 6.4.1 shows how to declare and initialize the input
arguments to this procedure.
8.38 ACMSMGMT_SET_INTERFACE_1
This procedure modifies the status of a Remote Manager interface. Either the
SNMP or RPC interface can be modified.
Note
The ACMS Remote Manager will not allow the RPC interface to be
DISABLED through this call. The only way to disable the RPC interface
dynamically is to use the SNMP interface.
Format
int *acmsmgmt_set_interface_1(interface_config_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Interface_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
interface configuration fields.
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.
interface_type
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates the interface to be modified. Table 8–2
shows the valid symbolic values for interface
types.
state
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates desired state of the interface. Table 8–3
shows the valid symbolic values for the allowable
states.
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 NULL or MGMT_SUCCESS,
the RPC has succeeded. If neither NULL nor MGMT_SUCCESS,
the procedure call failed and the value pointed to is the reason
for failure.
Description
This procedure modifies the status of an interface. Interfaces can be enabled
(that is, requested to start) or disabled (that is, requested to stop) by setting the
state field in set_struct to the appropriate value.
Note that it is not possible to use the RPC interface to enable the RPC interface.
In order to use the RPC interface, it must already be enabled. In order to start
the RPC interface, either use the SNMP interface, or use the ACMSCFG utility to
configure the RPC interface to be enabled when the Remote Manager starts up.
It is also not possible to use this call to disable the RPC interface. The ACMS
Remote Manager does not allow an interface to disable itself. The only way to
disable the RPC interface dynamically is to use the SNMP interface.
Example
set_struct.client_id = client_id;
set_struct.interface_type = MGMT_IF_SNMP;
set_struct.state = MGMT_STATE_ENABLED;
status = acmsmgmt_set_interface_1(&set_struct,cl);
if (!status) {
printf("\n Call to update SNMP interface failed");
return(MGMT_FAIL);
}
if (*status != MGMT_SUCCESS) {
printf("\n Call to update SNMP interface failed with status %d",*status);
free(status);
return(MGMT_FAIL);
}
else
printf("\n Call to set SNMP interface completed");
free(status);
return(0);
}
In the preceding example, the ACMSMGMT_SET_INTERFACE_1 procedure is
called to enable the SNMP interface. If the call succeeds, the SNMP interface is
running on the target node, and a success message is displayed. Otherwise, an
error message is displayed. The example in Section 6.4.1 shows how to declare
and initialize the input arguments to this procedure.
8.39 ACMSMGMT_SET_PARAM_2
Format
param_status_rec2 *acmsmgmt_set_param_2(param_config_rec2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Param_config_rec2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
parameter configuration fields.
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.
params
Type: Param_rec2
Access: Read
Mechanism: By value
Usage: Structure containing a Parameter table
record. Parameter table fields are described
in Section 9.10. See the Description section for
information on how to initialize this record.
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: Param_status_rec2
Access: write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type param_rec2, which contains
status codes for each field. See the Description section for a
discussion of how to determine the update status for any field.
The following are the contents of this union:
rc
Type: Integer
Access: write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Param_rec_2
Access: write
Mechanism: By value
Usage: Structure containing a Parameter table record.
The entries in this field contain status codes
correspond to the fields in the params structure.
See the Description section for a discussion of
how to determine the update status for any field.
Description
This procedure requests updates to fields in the Parameter table (see
Section 9.10). Some field updates are dynamic; others are not. Updates to
this table are not durable; that is, they do not survive a restart of the Remote
Manager.
When this procedure is called, any fields with negative values are ignored.
Callers should initialize any fields to a negative value (for example, -1) for which
updates are not to be applied. All nonnegative fields are validated prior to being
updated.
For any nonnegative fields, the completion status of the update is returned in the
corresponding field in the return structure. For instance, if the mss_coll_interval
and max_logins fields in the params structure of the param_config_rec are
nonnegative when this procedure is called, the mss_coll_interval and max_logins
field of the data or data_warn structures of the param_status_rec will contain the
completion status for those updates.
The data and data_warn structures contain identical data. If the operation fails,
the status field of either structure is MGMT_WARN; in this case, use the data_
warn structure to fetch the status messages from the cmd_output linked list.
Example
8.40 ACMSMGMT_SET_QTI_2
This procedure modifies Queued Task Initator (QTI) Config class attributes.
Format
qti_status_rec_2 *acmsmgmt_set_qti_2(qti_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Qti_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and QTI
table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
active_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether active variables should be
updated (active_sw = 1). Active variables are
currently in use by the ACMS system; updates
to active variables take effect immediately but
are not durable (that is, they do not survive a
restart of the ACMS system). Not all variables
are dynamic, however. Refer to Section 9.11
and to the field descriptions in this section, to
determine whether a particular variable can be
updated dynamically.
current_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether current variables should be
updated (current_sw = 1). Current variables are
those stored in the ACMSGEN file currently in
use by the ACMS system and are durable (that
is, they survive a restart of the ACMS system).
Updates to current variables take effect when the
ACMS system is restarted.
qti_username
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Values to be updated. This field corresponds
to the qti_username field in the QTI table; the
exact field depends on the value of active_sw
and current_sw in this record (for example, qti_
username will update the qti_username_stored
field if current_sw is equal to 1). See Section 9.11
for a discussion of these fields. Note that not all
fields can be updated dynamically. In order to
have this field set to null (that is, ""), set the field
to the string "NULL".
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: Qti_status_rec_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type qti_config_rec_out_2, which
contains status codes for each field, as well as a linked list of
status messages associated with the update. See the Description
section for a discussion of how to determine the update status for
any field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Qti_config_rec_out_2
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
fields in the set_struct structure, as well as a
linked list of status messages associated with
the update. See the Description section for a
discussion of how to determine the update status
for any field. 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 updates to ACMS QTI Config class fields contained in
the QTI table (see Section 9.11). Note that the QTI table contains both active
and stored values. The active_sw field and current_sw field control which fields
should be updated.
Attempting to update an active field that is nondynamic is essentially useless,
since the active field value does not change. For instance, calling this procedure
with the active_sw field set to 1 and the qti_username field populated produces
no change to the system.
Setting the current_sw field to 1 causes updates to be written to the current
ACMSGEN file. These updates are durable (that is, they survive a restart of the
ACMS sytem) but do not affect the active system until the system is restarted.
For any nonnegative integer fields, the completion status of the update is
returned in the corresponding field in the return structure. For string fields, the
string field value is returned, regardless of the status of the call.
In order to have one of the string fields set to a null string (that is, ""), populate
the field with value "NULL". To have one of the string fields ignored, pass in a
null string.
Example
if (!ret_struct) {
printf("\n Call to modify qti failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS)
printf("\n Call to modify QTI returned the following warnings or
errors\n");
else
printf("\n Call to modify QTI completed\n");
for (nl = ret_struct->qti_status_rec_2_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
xdr_free(xdr_qti_status_rec_2, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_SET_QTI_2 procedure is called to
set the ACMSGEN parameter qti_polling_timer to 4999 milliseconds. If the call
succeeds, only the active value is modified, the stored value is unchanged, and
a success message is displayed. Otherwise, an error message is displayed. The
example in Section 6.4.1 shows how to declare and initialize the input arguments
to this procedure.
8.41 ACMSMGMT_SET_SERVER_1
This procedure modifies server (ACMS procedure server) Config class attributes.
Format
ser_status_rec *acmsmgmt_set_server_1(ser_config_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Ser_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Server table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Name of the application to which the server to be
updated belongs.
server_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Name of the server to update.
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: Ser_status_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either
a failure code or a structure of type ser_config_rec_out, which
contains status codes for each field, as well as a linked list of
status messages associated with the update. See the Description
section for a discussion of how to determine the update status for
any field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Ser_config_rec_out
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
fields in the ser_config_rec structure, as well as
a linked list of status messages associated with
the update. See the Description section for a
discussion of how to determine the update status
for any field. 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 updates to ACMS server Config class fields contained
in the Server table (see Section 9.12). Note that the Server table contains only
active values.
For any nonnegative integer fields, the completion status of the update is
returned in the corresponding field in the return structure.
Example
message is displayed. The example in Section 6.4.1 shows how to declare and
initialize the input arguments to this procedure.
8.42 ACMSMGMT_SET_TRAP_1
This procedure modifies entries in the Remote Manager Trap table. Trap table
entries can also be added (see Section 8.5) and deleted (see Section 8.8).
Format
trap_status_rec *acmsmgmt_set_trap_1(trap_config_rec *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Trap_config_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Trap table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
trap_entry
Type: Trap_update_rec_r
Access: Read
Mechanism: By value
Usage: Structure containing a Trap table record. Trap
table fields are described in Section 9.14. See
the Description section for information on how to
initialize this record.
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: Trap_status_rec
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either
a failure code or a structure of type trap_update_rec_r, which
contains status codes for each field. See the Description section
for a discussion of how to determine the update status for any
field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data_warn
Type: Trap_update_rec_r
Access: Write
Mechanism: By value
Usage: Structure containing a Trap table record.
The entries in this field contain status codes
corresponding to the fields in the trap_entry
structure. See the Description section for a
discussion of how to determine the update status
for any field.
Description
This procedure requests updates to fields in the Trap table (see Section 9.14).
Updates to this table are not durable; that is, they do not survive a restart of the
Remote Manager. To make nondynamic, permanent updates to the Trap table,
use the ACMSCFG utility.
Calls to this procedure must specify entity_type, entity_name, and param_to_
trap. These fields must exactly match an existing record in the Trap table for
the update to be applied. Table 8–1 and Table 8–4 contain symbolic values used
to populate the collection_class and entity_type fields; symbolic values to the
param_to_trap field are described in Table 8–8.
Setting fields trap_min, trap_max, or severity to -2 excludes them from being
updating. Otherwise, the corresponding field in the matching trap record is
modified. (-1 is a special value that causes the field to be ignored when evaluating
the trap conditions; see Section 7.8.)
Updates to the Trap table are processed immediately and may affect more than
one ACMS process. See Section 7.8 for a discussion of how to set SNMP traps.
Example
8.43 ACMSMGMT_SET_TSC_2
Format
tsc_status_rec_2 *acmsmgmt_set_tsc_2(tsc_config_rec_2 *set_struct,CLIENT *cl)
Parameters
set_struct
Type: Tsc_config_rec_2
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
TSC table fields.
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 of client_
id is 0, proxy access is used. Client_id is obtained
by calling the acms$mgmt_get_creds procedure.
active_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether active variables should be
updated (active_sw = 1). Active variables are
currently in use by the ACMS system; updates
to active variables take effect immediately but
are not durable (that is, they do not survive a
restart of the ACMS system). Not all variables
are dynamic, however. Refer to Section 9.15,
and to the field descriptions in this section, to
determine whether a particular variable can be
updated dynamically.
current_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether current variables should be
updated (current_sw = 1). Current variables are
those stored in the ACMSGEN file currently in
use by the ACMS system and are durable (that
is, they survive a restart of the ACMS system).
Updates to current variables take effect when the
ACMS system is restarted.
tsc_username, cp_username
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Values to be updated. These fields correspond
to fields of the same names in the TSC table,
depending on the value of active_sw and current_
sw in this record (for example, tsc_username
will update the tsc_username_stored field if
current_sw is equal to 1). See Section 9.15 for a
discussion of these fields. Note that not all fields
can be updated dynamically. In order to have any
of these fields set to null (that is, ""), set the field
to the string "NULL".
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: Tsc_status_rec_2
Access: Write
Mechanism: By reference
Usage: Pointer to a record that contains a union consisting of either a
failure code or a structure of type tsc_config_rec_out_2, which
contains status codes for each field, as well as a linked list of
status messages associated with the update. See the Description
section for a discussion of how to determine the update status for
any field. The following are the contents of this union:
rc
Type: Integer
Access: Write
Mechanism: By value
Usage: Failure return code.
data, data_warn
Type: Tsc_config_rec_out_2
Access: Write
Mechanism: By value
Usage: Structure containing fields corresponding to the
fields in the set_struct structure, as well as a
linked list of status messages associated with
the update. See the Description section for a
discussion of how to determine the update status
for any field. 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 updates to ACMS TSC Config class fields contained in
the TSC table (see Section 9.15). Note that the TSC table contains both active
and stored values. The active_sw field and current_sw field control which fields
are attempted to be updated.
Attempting to update an active field that is nondynamic is essentially useless,
since the active field value will not change. For instance, calling this procedure
with the active_sw field set to 1 and the tsc_username field populated does not
result in any change to the system.
Setting the current_sw field to 1 causes updates to be written to the current
ACMSGEN file. These updates are durable (that is, they survive a restart of the
ACMS sytem) but do not affect the active system until the system is restarted.
For any nonnegative integer fields, the completion status of the update is
returned in the corresponding field in the return structure. For string fields, the
string field value is returned, regardless of the status of the call.
In order to have one of the string fields set to a null string (that is, ""), populate
the field with value "NULL". To have one of the string fields ignored, pass in a
null string.
Example
if (!ret_struct) {
printf("\n Call to modify TSC failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS)
printf("\n Call to modify TSC returned the following warnings or
errors\n");
else
printf("\n Call to modify TSC completed\n");
for (nl = ret_struct->tsc_status_rec_2_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
xdr_free(xdr_tsc_status_rec_2, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_SET_TSC_2 procedure is called
to set the ACMSGEN parameter max_logins to 61. If the call succeeds, only
the active value is modified; the stored value is unchanged, and a success
message is displayed. Otherwise, an error message is displayed. The example
in Section 6.4.1 shows how to declare and initialize the input arguments to this
procedure.
8.44 ACMSMGMT_START_ACC_1
This procedure requests that the Remote Manager start the ACMS system.
Format
cmd_output_rec *acmsmgmt_start_acc_1(acc_startup_rec *start_struct,CLIENT *cl)
Parameters
start_struct
Type: Acc_startup_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following 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.
audit_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether system auditing should be
enabled (audit_sw = 1), or disabled (audit_sw =
0).
qti_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether the Queued Task Initiator
(QTI) should be started (qti_sw = 1), or not (qti_
sw = 0).
terminals_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether the Terminal Subsystem
Controller (TSC) should be started (terminals_sw
= 1), or not (terminals_sw = 0).
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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, which points to a
linked list containing status messages. The following are the
contents of this union:
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 startup of the ACMS run-time system on the same node
that the Remote Manager is running on. Fields in the input argument determine
how the ACMS system will be started (that is, with or without auditing, terminals
or QTI).
This call executes synchronously. It does not return to the caller until the attempt
to start the system is complete. Any messages associated with an unsuccessful
start of the system 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 structures 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. There are no status messages 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
8.45 ACMSMGMT_START_EXC_1
This procedure requests that the Remote Manager start an ACMS application on
the same node on which the Remote Manager is running.
Format
cmd_output_rec *acmsmgmt_start_exc_1(exc_startup_rec *start_struct,CLIENT *cl)
Parameters
start_struct
Type: Exc_startup_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following 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.
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Pointer to the application name of the application
to be started.
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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 starts an ACMS application on the same node on which the
Remote Manager is running. The appl_name field in the input record determines
which application will be started.
This call executes synchronously. It does not return to the caller until the
attempt to start the application is complete. Any messages associated with an
unsuccessful start of the application 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 either 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 either structure 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
if (ret_struct->status != MGMT_SUCCESS) {
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to start ACMS EXC failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
printf("\n Call to start ACMS EXC 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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
else {
printf("\nCall to start ACMS EXC was executed");
for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_START_EXC_1 procedure is called
to start an application named VR_APPL on the target node. If the call succeeds,
the VR_APPL application is started on the target node. Otherwise, any error
messages associated with the failure are displayed. The example in Section 6.4.1
shows how to declare and initialize the input arguments to this procedure.
8.46 ACMSMGMT_START_QTI_1
This procedure requests that the Remote Manager start a Queued Task Initiator
(QTI) on the same node on which the Remote Manager is running.
Format
cmd_output_rec *acmsmgmt_start_qti_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 starts an ACMS QTI 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 start the QTI is complete. Any messages associated with an unsuccessful start
of the QTI 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 structures 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
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to start ACMS QTI failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
printf("\n Call to start ACMS QTI 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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
else {
printf("\nCall to start ACMS QTI was executed");
for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL; \
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_START_QTI_1 procedure is called to
start the Queued Task Initiator (QTI) on the target node. If the call succeeds, the
QTI is started on the target node. Otherwise, any error messages associated with
the failure are displayed. The example in Section 6.4.1 shows how to declare and
initialize the input arguments to this procedure.
8.47 ACMSMGMT_START_TRACE_MONITOR_1
This procedure requests that the Remote Manager start 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_start_trace_monitor_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 start 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 start 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 start during that
period, the Remote Manager returns an error to the caller.
Example
associated with the failure are displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.48 ACMSMGMT_START_TSC_1
This procedure requests that the Remote Manager start a Terminal Subsystem
Controller (TSC) on the same node on which it is running.
Format
cmd_output_rec *acmsmgmt_start_tsc_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 that an ACMS TSC be started 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 start 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 structures 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
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to start ACMS TSC failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
printf("\n Call to start 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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
else {
printf("\nCall to start 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);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_START_TSC_1 procedure is called
to start the terminal subsystem on the target node. If the call succeeds, the
terminal subsystem is started on the target node. Otherwise, any error messages
associated with the failure are displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.49 ACMSMGMT_STOP_1
Format
int *acmsmgmt_stop_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 shuts down the Remote Manager server on the target node. As
part of shutdown, the RPC interface is stopped, which may result in a NULL
pointer being returned to the caller. A NULL pointer in this case signals success
of the shutdown request.
Note that the success of this procedure does not guarantee that the Remote
Manager server has actually shut down. It guarantees only that the shutdown
has been requested.
Example
8.50 ACMSMGMT_STOP_ACC_1
This procedure requests that the Remote Manager stop the ACMS system.
Format
cmd_output_rec *acmsmgmt_stop_acc_1(acc_shutdown_rec *stop_struct,CLIENT *cl)
Parameters
stop_struct
Type: Acc_shutdown_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
ACC control fields.
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.
cancel_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether the system should be stopped
immediately (cancel_sw = 1), or whether currently
executing tasks should be allowed to complete
first (cancel_sw = 0).
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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 shuts down the ACMS run-time system on the same node on
which the Remote Manager is running. Fields in the input argument determine
how the ACMS system will be stopped. If the value for cancel_sw is 1, currently
executing tasks are cancelled, and the system is stopped. If the value for cancel_
sw is 0, currently executing tasks are allowed to complete before the system is
shut down.
This call executes synchronously. It does not return to the caller until the attempt
to stop the system is complete. Any messages associated with an unsuccessful
stop of the system 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 structures 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
if (!ret_struct) {
printf("\n Call to stop ACC failed");
return(MGMT_FAIL);
}
if (ret_struct->status != MGMT_SUCCESS) {
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to stop ACMS ACC failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
printf("\n Call to stop ACMS ACC 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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
else {
printf("\nCall to stop ACMS ACC was executed");
for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_STOP_ACC_1 procedure is called
to stop the ACMS run-time system on the target node. The system is stopped
abruptly (/CANCEL), terminating any in-process tasks. If the call succeeds, the
ACMS system is stopped on the target node. Otherwise, any error messages
associated with the failure are displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.51 ACMSMGMT_STOP_EXC_1
This procedure requests that the Remote Manager stop the ACMS system.
Format
cmd_output_rec *acmsmgmt_stop_exc_1(exc_shutdown_rec *stop_struct,CLIENT *cl)
Parameters
stop_struct
Type: Exc_shutdown_rec
Access: Read
Mechanism: By reference
Usage: Structure that contains the following client identification and
Application Execution Controller (EXC) control fields.
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.
cancel_sw
Type: Integer
Access: Read
Mechanism: By value
Usage: Indicates whether the application should be
stopped immediately (cancel_sw = 1), or whether
currently executing tasks should be allowed to
complete first (cancel_sw = 0).
appl_name
Type: Null-terminated string
Access: Read
Mechanism: By reference
Usage: Name of the application to be stopped.
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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 shuts down an ACMS application on the same node on which
the Remote Manager is running. Fields in the input argument determine which
application to stop (appl_name) and how the application will be stopped. If
the value for cancel_sw is 1, currently executing tasks are cancelled, and the
application is stopped. If the value for cancel_sw is 0, currently executing tasks
are allowed to complete before the application is shut down.
This call executes synchronously. It does not return to the caller until the attempt
to stop the application is complete. Any messages associated with an unsuccessful
stop of the system 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
8.52 ACMSMGMT_STOP_QTI_1
This procedure requests that the Remote Manager stop a Queued Task Initiator
(QTI) on the same node on which the Remote Manager is running.
Format
cmd_output_rec *acmsmgmt_stop_qti_1(sub_id_struct *sub_rec,CLIENT *cl)
Parameters
sub_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 record that contains a union consisting of either a
failure code or a structure of type cmd_rec, 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 QTI 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 QTI is complete. Any messages associated with an unsuccessful stop
of the QTI 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 structures 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
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to stop ACMS QTI failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
printf("\n Call to stop ACMS QTI 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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(MGMT_FAIL);
}
else {
printf("\nCall to stop ACMS QTI was executed");
for (nl = ret_struct->cmd_output_rec_u.data.cmd_output; nl != NULL;
nl = nl->pNext)
printf("\n %s",nl->dcl_msg);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
return(0);
}
In the preceding example, the ACMSMGMT_STOP_QTI_1 procedure is called
to stop the Queued Task Initiator (QTI) on the target node. If the call succeeds,
the QTI is stopped on the target node. Otherwise, any error messages associated
with the failure are displayed. The example in Section 6.4.1 shows how to declare
and initialize the input arguments to this procedure.
8.53 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_rec,CLIENT *cl)
Parameters
sub_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
If the call succeeds, the process is stopped. Otherwise, any error messages
associated with the failure are displayed. The example in Section 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
8.54 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_rec,CLIENT *cl)
Parameters
sub_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, 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
if (ret_struct->status != MGMT_WARN) {
printf("\nCall to stop ACMS TSC failed with status %d",
ret_struct->status);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
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);
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
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);
}
xdr_free(xdr_cmd_output_rec, ret_struct);
free(ret_struct);
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 6.4.1 shows
how to declare and initialize the input arguments to this procedure.
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:
ACC table
Agent table
Collection table
CP table
Error Filter table
EXC table
Interfaces table
Manager status table
Parameter table
QTI table
Server table
Task Group table
Trap table
TSC table
Users table
Note
The following sections describe the records and fields in each Remote
Manager reference table. Many of these tables now contain a subset of
fields intended solely for use on or by systems running ACMS Version
4.4 or higher. These fields are denoted with the double dagger (‡) symbol
within each table listing.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• username_stored
The OpenVMS process name currently stored in the ACMSGEN file for this
process.
• start_time
Date and time the process was started.
• end_time
Date and time the process ended. If the process has not yet ended, this field
will be null.
• acms_version
Current version of the ACC.
• config_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
• acms_state
Current ACMS state of the process. This field can be set (to DISABLED or
to 0) by the SNMP interface only. RPC users use the ACMSMGMT_STOP_
ACC_1 procedure described in Section 8.50. ACMSMGR users use the STOP
SYSTEM command.
• acc_priority_active
The base priority for this process. This is the value of the ACMSGEN field
when the process was started.
• acc_priority_stored
The base priority currently stored in the ACMSGEN file for this process.
• max_appl_active
The maximum number of ACMS applications that can be started
simultaneously on this node. This is the value of the ACMSGEN field
when the ACC process was started.
• max_appl_stored
The value of the max_appl field currently stored in the ACMSGEN file.
• mss_maxobj_active
The maximum number of ACMS message switch objects that can be started
simultaneously on this node. This is the value of the ACMSGEN field when
the ACC process was started. See the MSS class field mss_objects for a count
of the current and maximum number of MSS objects instantiated on the
system.
• mss_maxobj_stored
The value of the mss_maxobj field currently stored in the ACMSGEN file.
• mss_maxbuf_active
The maximum size of a message segment of an ACMS message switch
message. This is the value of the ACMSGEN field when the ACC process was
started.
• mss_maxbuf_stored
The value of the mss_maxbuf field currently stored in the ACMSGEN file.
• mss_poolsize_active
The size of the MSS shared pool (in pagelets). This is the value of the
ACMSGEN field when the ACC process was started.
• mss_poolsize_stored
The value of the mss_poolsize field currently stored in the ACMSGEN file.
• mss_process_pool_active
The default size of the MSS pool (in pagelets) allocated for each ACMS
process. This is the value of the ACMSGEN field when the ACC process was
started.
• mss_process_pool_stored
The value of the mss_process_pool field currently stored in the ACMSGEN
file.
• mss_net_retry_active
The time ACMS processes will wait before retrying an MSS network
operation. This field can be modified dynamically.
• mss_net_retry_timer_stored
The value of the mss_net_retry_timer field currently stored in the ACMSGEN
file.
• audit_state
The current system auditing state.
• username_default_active
The default user name for remote users. This is the value of the ACMSGEN
field when the ACC process was started.
• username_default_stored
The value of the username_default field currently stored in the ACMSGEN
file.
• node_name_active
The node name for the current node. This is the value of the ACMSGEN field
when the ACC process was started.
• node_name_stored
The value of the node_name field currently stored in the ACMSGEN file.
• ws_poolsize_active, wsc_poolsize_active, tws_poolsize_active, twsc_poolsize
active
The default size of the group and user workspace (WS), user workspace
control (WSC), task workspace (TWS), or task workspace control (TWSC) pool
(in pagelets). This is the value of the ACMSGEN field when the ACC process
was started.
• ws_poolsize_stored, wsc_poolsize_stored, tws_poolsize_stored, twsc_poolsize_
stored
The value of associated poolsize field currently stored in the ACMSGEN file.
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_garbage
The number of garbage collections for this process that have been run to
reclaim space in the MSS process pool. The frequency with which this field is
updated is based on the value of the Parameter table field mss_coll_interval
(see Table 9–9).
• mss_objects
The number of MSS objects currently instantiated on the node. The frequency
with which this field is updated is based on the value of the Parameter table
field mss_coll_interval (see Table 9–9).
• mss_msgs_1-1024, mss_msgs_1025-2048, mss_msgs_2049-4096, mss_msgs_
4097-8192, mss_msgs_8193-16384, mss_msgs_16385-32768, mss_msgs_
32769-65636
The number of MSS messages whose sizes fall within the specified range (in
bytes).
• mss_msg_count_resets
The number of MSS message size counter resets that have occurred. Each
of the preceding counters (mss_msgs_n-n) are reset if one of the counters
overflows.
• tws_poolsize_total, twsc_poolsize_total
The total amount (in pagelets) of TWS or TWSC process pool being used by
all task groups running on the current node. The frequency with which these
fields are updated is based on the value of the wksp_coll_interval field in the
Parameter table (see Table 9–9).
• tws_pool_large_used, twsc_pool_large_used
The largest amount (in bytes) of TWS or TWSC process pool being used by
a task group running on the current node. The frequency with which these
fields are updated is based on the value of the wksp_coll_interval field in the
Parameter table (see Table 9–9).
• tws_pool_min_free, twsc_pool_min_free
The minimum amount (in bytes) of unused TWS or TWSC process pool
available on the current node. The frequency with which these fields are
updated is based on the value of the wksp_coll_interval field in the Parameter
table (see Table 9–9).
• ws_pool_large_used, wsc_pool_large_used
The largest amount (in bytes) of WS or WSC process pool being used by an
application running on the current node. The frequency with which these
fields are updated is based on the value of the wksp_coll_interval field in the
Parameter table (see Table 9–9).
• ws_pool_min_free, wsc_pool_min_free
The minimum amount (in bytes) of unused WS or WSC process pool available
on the current node. The frequency with which these fields are updated is
based on the value of the wksp_coll_interval field in the Parameter table (see
Table 9–9).
• err_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
Errors for this process are only sent to the Remote Manager if this field is set
to ENABLED. If this field is set to DISABLED, the process will not collect
data for the fields in this class; existing field values reflect activity during a
prior period when collection was enabled.
• err_count
The total number of errors related to this process that were sent to the
Remote Manager.
• last_err_msg
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• id_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. If this field is set
to DISABLED, the process is not currently collecting data for the fields in this
class. Any field values reflect activity during a prior period when collection
was enabled.
• process_name
The OpenVMS process name for the process.
• pid
The OpenVMS process identifier for the process.
• start_time
Date and time the process was started.
• end_time
Date and time the process ended. If the process has not yet ended, this field
is null.
• user_name
The OpenVMS account under which the process is running.
• acms_state
The ACMS state of the process.
• cfg_coll_state
Collection states can be modified by modifying entries in the Collection table.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• rt_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. If this field is set
to DISABLED, the process is not currently collecting data for the fields in this
class. Any field values reflect activity during a prior period when collection
was enabled.
• decnet_object
If the process has a current DECnet object, the value of this field is
STARTED. Otherwise, the value is STOPPED. If the DECnet object is stopped
(and the runtime_coll_state is enabled for this process), either distributed
processing has not been enabled (that is, the node_name parameter in the
ACMSGEN file is NULL) or there is currently a problem with DECnet. Also,
check the ACC CONFIG parameters node_name_active and node_name_
stored to determine the current status of the ACMSGEN node_name field.
• active_task_calls
The number of task calls currently being executed by all users of the Agent.
• current_attached_terms
The number of terminals currently attached to the Agent.
• active_tdms_menu_reqs
The number of TDMS menu requests currently being executed by all users of
the Agent.
• total_tdms_menu_reqs
The total number of TDMS menu requests executed by all users of the Agent
since the Agent was started.
• active_tdms_reqs
The number of TDMS requests of all types currently being executed by all
users of the Agent.
• active_tdms_msgrd
The number of TDMS read messages currently being executed by all users of
the Agent.
• active_tdms_msgwt
The number of TDMS write messages currently being executed by all users of
the Agent.
• active_tdms_cancel
The number of TDMS cancels currently being executed by all users of the
Agent.
• total_tdms_reqs
The total number of TDMS requests (menu and exchange) executed by all
users of the Agent since the Agent was started.
• total_tdms_msgrd
The total number of TDMS read messages executed by all users of the Agent
since the Agent was started.
• total_tdms_msgwt
The total number of TDMS write messages executed by all users of the Agent
since the Agent was started.
• total_tdms_cancel
The total number of TDMS cancels executed by all users of the Agent since
the Agent was started.
• active_vf_menu_reqs
The number of HP DECforms menu requests currently being executed by all
users of the Agent.
• total_vf_menu_reqs
The total number of HP DECforms menu requests executed by all users of the
Agent since the Agent was started.
• active_vf_reqs
The number of HP DECforms requests of all types currently being executed
by all users of the Agent.
• active_vf_enable
The number of HP DECforms enable requests currently being executed by all
users of the Agent.
• active_vf_disable
The number of HP DECforms disable requests currently being executed by all
users of the Agent.
• active_vf_cancel
The number of HP DECforms cancel requests currently being executed by all
users of the Agent.
• active_vf_send
The number of HP DECforms requests currently being executed by all users
of the Agent.
• active_vf_receive
The number of HP DECforms receive requests currently being executed by all
users of the Agent.
• active_vf_xceive
The number of HP DECforms enable transceives currently being executed by
all users of the Agent.
• total_vf_reqs
The total number of HP DECforms requests of all types executed by all users
of the Agent since the Agent was started.
• total_vf_enable
The total number of HP DECforms enable requests executed by all users of
the Agent since the Agent was started.
• total_vf_disable
The total number of HP DECforms disable requests executed by all users of
the Agent since the Agent was started.
• total_vf_cancel
The total number of HP DECforms cancel requests executed by all users of
the Agent since the Agent was started.
• total_vf_send
The total number of HP DECforms send requests executed by all users of the
Agent since the Agent was started.
• total_vf_receive
The total number of HP DECforms receive requests executed by all users of
the Agent since the Agent was started.
• total_vf_xceive
The total number of HP DECforms transceive requests executed by all users
of the Agent since the Agent was started.
• total_tasks_executed
The total number of tasks started in the Agent since the Agent was started.
• pool_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. If this field is set
to DISABLED, the process is not currently collecting data for the fields in this
class. Any field values reflect activity during a prior period when collection
was enabled.
• mss_process_total
The total size of the MSS process pool allocated for this process. The
frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval.
• mss_process_free
The amount of unused MSS process pool for this process. The frequency with
which this field is updated is based on the value of the Parameter table field
mss_coll_interval.
• mss_process_largest
The largest unused block available in the MSS process pool for this process.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval.
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval.
• mss_process_garbage
The number of garbage collections that have been run to reclaim space in this
processes MSS process pool. The frequency with which this field is updated is
based on the value of the Parameter table field mss_coll_interval.
• error_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. Errors for this
process are only sent to the Remote Manager if this field is set to ENABLED.
If this field is set to DISABLED, the process will not collect data for the fields
in this class; existing field values reflect activity during a prior period when
collection was enabled.
• error_count
The total number of errors related to this process that were sent to the
Remote Manager.
• last_error_message
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• storage_interval
Controls the frequency (in seconds) at which data snapshots are collected. A
lower value causes data snapshots to be collected more often; a higher value
causes data snapshots to be collected less often.
The storage_interval value should be a multiple of the timer_interval value.
The timer_interval value determines the minimum elapsed time for many
Remote Manager parameters, including the storage interval setting. The
relationship of the values in these two fields 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.
See Section 5.1 for more information on creating data snapshots by
periodically saving data collections.
• storage_begini_time
The date and time (DD-MMM-YY:hh:mm:ss.nn) when the data snapshot
interval is scheduled to begin. The default value is NOW (begin immediately).
See Section 5.1 for more information on creating data snapshots by
periodically saving data collections.
• storage_end_time
The date and time (DD-MMM-YY:hh:mm:ss.nn) when the data snapshot
interval is scheduled to end. The default value is NEVER (run indefinitely).
See Section 5.1 for more information on creating data snapshots by
periodically saving data collections.
9.5 CP Table
The CP table contains a row for each terminal Command Process (CP) running
on the node.
ID pid integer R R
ID start_time time R R
ID end_time time R R
ID user_name string R R
CONFIG astlm_active‡ integer R R
CONFIG astlm_stored‡ integer RW RW
CONFIG biolm_active‡ integer R R
CONFIG biolm_stored‡ integer RW RW
CONFIG bytlm_active‡ integer R R
CONFIG bytlm_stored‡ integer RW RW
CONFIG diolm_active‡ integer R R
CONFIG diolm_stored‡ integer RW RW
CONFIG enqlm_active‡ integer R R
CONFIG enqlm_stored‡ integer RW RW
CONFIG fillm_active‡ integer R R
CONFIG fillm_stored‡ integer RW RW
CONFIG pgflquota_active‡ integer R R
CONFIG pgflquota_stored‡ integer RW RW
CONFIG tqelm_active‡ integer R R
CONFIG tqelm_stored‡ integer RW RW
CONFIG wsdefault_active‡ integer R R
CONFIG wsdefault_stored‡ integer RW RW
CONFIG wsextent_active‡ integer R R
CONFIG wsextent_stored‡ integer RW RW
CONFIG wsquota_active‡ integer R R
CONFIG wsquota_stored‡ integer RW RW
RUNTIME runtime_coll_state integer R R
RUNTIME acms_state integer R R
RUNTIME decnet_object integer R R
RUNTIME current_attached_terms gauge R R
RUNTIME active_task_calls gauge R R
RUNTIME active_tdms_menu_reqs gauge R R
RUNTIME total_tdms_menu_reqs integer R R
RUNTIME active_tdms_reqs gauge R R
RUNTIME active_tdms_read_msgs gauge R R
RUNTIME active_tdms_write_msgs gauge R R
RUNTIME active_tdms_cancels gauge R R
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
The value of the related process quota currently stored in the OpenVMS
system user authorization file (SYSUAF.DAT).
• runtime_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• acms_state
The ACMS state of the process.
• decnet_object
If the process has a current DECnet object, the value of this field is
STARTED. Otherwise, the value is STOPPED. If the DECnet object is stopped
(and the runtime_coll_state is enabled for this process), either distributed
processing has not been enabled (that is, the node_name parameter in the
ACMSGEN file is NULL) or there is currently a problem with DECnet. Also,
check the ACC CONFIG parameters node_name_active and node_name_
stored to determine the current status of the ACMSGEN node_name field.
• current_attached_terms
The number of terminals currently attached to the CP.
• active_task_calls
The number of task calls currently being executed by all users of the CP.
• active_tdms_menu_reqs
The number of TDMS menu requests currently being executed by all users of
the CP.
• total_tdms_menu_reqs
The total number of TDMS menu requests executed by all users of the CP
since the CP was started.
• active_tdms_reqs
The number of TDMS requests of all types currently being executed by all
users of the CP.
• active_tdms_read_msgs
The number of TDMS read messages currently being executed by all users of
the CP.
• active_tdms_write_msgs
The number of TDMS write messages currently being executed by all users of
the CP.
• active_tdms_cancels
The number of TDMS cancels currently being executed by all users of the CP.
• total_tdms_reqs
The total number of TDMS requests (menu and exchange) executed by all
users of the CP since the CP was started.
• total_tdms_read_msgs
The total number of TDMS read messages executed by all users of the CP
since the CP was started.
• total_tdms_write_msgs
The total number of TDMS write messages executed by all users of the CP
since the CP was started.
• total_tdms_cancels
The total number of TDMS cancels executed by all users of the CP since the
CP was started.
• active_df_menu_reqs
The number of HP DECforms menu requests currently being executed by all
users of the CP.
• total_df_menu_reqs
The total number of HP DECforms menu requests executed by all users of the
CP since the CP was started.
• active_df_reqs
The number of HP DECforms requests of all types currently being executed
by all users of the CP.
• active_df_enables
The number of HP DECforms enable requests currently being executed by all
users of the CP.
• active_df_disables
The number of HP DECforms disable requests currently being executed by all
users of the CP.
• active_df_cancels
The number of HP DECforms cancel requests currently being executed by all
users of the CP.
• active_df_sends
The number of HP DECforms requests currently being executed by all users
of the CP.
• active_df_receives
The number of HP DECforms receive requests currently being executed by all
users of the CP.
• active_df_transceives
The number of HP DECforms enable transceives currently being executed by
all users of the CP.
• total_df_reqs
The total number of HP DECforms requests of all types executed by all users
of the CP since the CP was started.
• total_df_enables
The total number of HP DECforms enable requests executed by all users of
the CP since the CP was started.
• total_df_disables
The total number of HP DECforms disable requests executed by all users of
the CP since the CP was started.
• total_df_cancels
The total number of HP DECforms cancel requests executed by all users of
the CP since the CP was started.
• total_df_sends
The total number of HP DECforms send requests executed by all users of the
CP since the CP was started.
• total_df_receives
The total number of HP DECforms receive requests executed by all users of
the CP since the CP was started.
• total_df_transceives
The total number of HP DECforms transceive requests executed by all users
of the CP since the CP was started.
• data_set_hangups
The total number of data set hangups detected by the CP since the CP was
started.
• astlm_current, biolm_current, bytlm_current, diolm_current, enqlm_current,
fillm_current, pgflquota_current, tqelm_current, wssize_current, channelcnt_
current
The actual amount of the related OpenVMS process or system resource that is
being consumed by the CP process. The frequency with which these fields are
updated is based on the value of the vms_coll_interval field in the Parameter
table (see Table 9–9).
• pool_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 9.4
and Section 5.1 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• mss_process_total
The total size of the MSS process pool allocated for this process. The
frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_free
The amount of unused MSS process pool for this process. The frequency with
which this field is updated is based on the value of the Parameter table field
mss_coll_interval (see Table 9–9).
• mss_process_largest
The largest unused block available in the MSS process pool for this process.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_garbage
The number of garbage collections that have been run to reclaim space in this
processes MSS process pool. The frequency with which this field is updated
is based on the value of the Parameter table field mss_coll_interval (see
Table 9–9).
• err_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
Errors for this process are only sent to the Remote Manager if this field is set
to ENABLED. If this field is set to DISABLED, the process will not collect
data for the fields in this class; existing field values reflect activity during a
prior period when collection was enabled.
• err_count
The total number of errors related to this process that were sent to the
Remote Manager.
• last_err_msg
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
• user_name
The OpenVMS account under which the process is running.
• pid
The OpenVMS process identifier of the process.
• start_time
Date and time the process was started.
• end_time
Date and time the process ended. If the process has not yet ended, this field
will be null.
• appl_name
Name of the application.
• build_time
Date and time the application database (ADB) was built.
• exc_appl_tbl_state
This field is available to the SNMP interface only. It contains the state of
the application global section for this EXC. When EXCs have completed
their startup, they construct global sections containing server and task group
tables. If this field is not MGMT$K_VALID (2), the Server and Task Group
tables are not available.
• exc_server_types
This field is available to the SNMP interface only. It contains the number of
server types contained in the application, which is also the number of rows in
the Server table for this EXC.
• exc_task_groups
This field is available to the SNMP interface only. It contains the number of
task groups contained in the application, which is also the number of rows in
the Task Group table for this EXC.
• config_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
• audit_state_active
Current auditing state of the application.
• audit_state_stored
Value of the auditing state of the application as specified in the ACMS
application database (.ADB file).
• max_tasks_active
The current maximum number of executing tasks allowed.
• max_tasks_stored
The maximum number of executing tasks allowed as specified in the ACMS
application database (.ADB file).
• sp_monitoring_interval_active
The current server process monitoring interval for the application.
• sp_monitoring_interval_stored
The server process monitoring interval for the application as specified in the
ACMS application database (.ADB file).
• max_servers_active
The current maximum number of started server instances for the application.
• max_servers_stored
The maximum number of started server instances for the application as
specified in the ACMS application database (.ADB file).
• transaction_timeout_active
The current default task timeout for the application.
• transaction_timeout_stored
The default task timeout for the application as specified in the ACMS
application database (.ADB file).
• astlm_active, biolm_active, bytlm_active, diolm_active, enqlm_active, fillm_
active, pgflquota_active, tqelm_active, wsdefault_active, wsextent_active,
wsquota_active
The default value of the related OpenVMS process quota. This is the value of
the quota when the EXC process was started.
• astlm_stored, biolm_stored, bytlm_stored, diolm_stored, enqlm_stored, fillm_
stored, pgflquota_stored, tqelm_stored, wsdefault_stored, wsextent_stored,
wsquota_stored
The value of the related process quota currently stored in the OpenVMS
system user authorization file (SYSUAF.DAT).
• ws_poolsize, wsc_poolsize
The default size (in pagelets) of WS or WSC process pool for the application.
• tws_poolsize, twsc_poolsize
The default size (in pagelets) of TWS or TWSC process pool for the
application.
• acms_state
The current ACMS state of this process.
• runtime_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• decnet_object
If the process has a current DECnet object, the value of this field is
STARTED. Otherwise, the value is STOPPED. If the DECnet object is stopped
(and the runtime_coll_state is enabled for this process), either distributed
processing has not been enabled (that is, the node_name parameter in the
ACMSGEN file is NULL) or there is currently a problem with DECnet. Also,
check the ACC CONFIG parameters node_name_active and node_name_
stored to determine the current status of the ACMSGEN node_name field.
• current_servers
The number of server instances currently started in this application.
• current_submitters
The number of submitters currently logged in to this application.
• current_tasks
The number of tasks currently started in the application.
• total_tasks_executed
The total number of tasks started in the application since the application was
started.
• total_submitters
The total number of submitters who have submitted tasks to this application
since the application was started.
• current_active_servers
The current number of active servers (that is, those servers performing
processing steps).
• current_free_servers
The number of started servers which are not currently active (that is, not
currently executing processing steps).
• current_waiting_tasks
The number of tasks that are not executing, waiting for a procedure server to
become available.
• server_start_count
The number of times servers have been started in this application.
• server_failure_count
The number of times servers have been stopped in this application.
• server_process_total
The number of concurrent server processes (active or free) running in this
application.
• task_failures
The number of tasks in this application that have failed to complete
successfully.
• task_start_failures
The number of tasks in this application that have failed to start.
• task_security_failures
The number of tasks in this application that have failed to start because of
security violations.
• task_cancels
The number of tasks in this application that have been canceled.
• active_tdms_requests
The number of TDMS requests (both exchange and menu) that are currently
executing for this process.
• active_tdms_read_messages
The number of TDMS read messages currently outstanding for this process.
• active_tdms_write_messages
The number of TDMS write messages currently outstanding for this process.
• active_tdms_cancels
The number of TDMS cancels currently outstanding for this process.
• total_tdms_requests
The total number of TDMS requests (both exchange and menu) processed by
this process while the runtime_coll_state has been ENABLED.
• total_tdms_read_messages
The total number of TDMS read messages processed by this process while the
runtime_coll_state has been ENABLED.
• total_tdms_write_messages
The total number of TDMS write messages processed by this process while
the runtime_coll_state has been ENABLED.
• total_tdms_cancels
The total number of TDMS cancels processed by this process while the
runtime_coll_state has been ENABLED.
• total_dataset_hangups
The total number of TDMS dataset hangups (unexpected session
interruptions) processed by this process while the runtime_coll_state has
been ENABLED.
• astlm_current, biolm_current, bytlm_current, diolm_current, enqlm_current,
fillm_current, pgflquota_current, tqelm_current, wssize_current, channelcnt_
current
The actual amount of the related OpenVMS process or system resource that
is being consumed by the EXC process.
• pool_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• mss_process_total
The total size of the MSS process pool (in bytes) allocated for this process.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_free
The amount of unused MSS process pool (in bytes) for this process. The
frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_largest
The largest unused block available (in bytes) in the MSS process pool for this
process. The frequency with which this field is updated is based on the value
of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_garbage
The number of garbage collections for this process that have been run to
reclaim space in the MSS process pool for this process. The frequency with
which this field is updated is based on the value of the Parameter table field
mss_coll_interval (see Table 9–9).
• ws_pool_total, wsc_pool_total
The total size of the WS or WSC pool (in bytes) allocated for this application.
The frequency with which these fields are updated is based on the value of
the Parameter table field wksp_coll_interval (see Table 9–9).
• ws_pool_used, wsc_pool_used
The amount of WS or WSC pool (in bytes) used by this application. The
frequency with which these fields are updated is based on the value of the
Parameter table field wksp_coll_interval (see Table 9–9).
• ws_pool_free, wsc_pool_free
The amount of unused WS or WSC pool (in bytes) for this application. The
frequency with which these fields are updated is based on the value of the
Parameter table field wksp_coll_interval (see Table 9–9).
• ws_pool_largest, wsc_pool_largest
The largest unused block available in the WS or WSC pool for this application.
The frequency with which these fields are updated is based on the value of
the Parameter table field wksp_coll_interval (see Table 9–9).
• ws_pool_failures, wsc_pool_failures
The number of failed attempts to allocate space in the WS or WSC pool for
this application. The frequency with which these fields are updated is based
on the value of the Parameter table field wksp_coll_interval (see Table 9–9).
• ws_pool_garbage, wsc_pool_garbage
The number of garbage collections that have been run to reclaim space in the
WS or WSC pool for this application. The frequency with which these fields
are updated is based on the value of the Parameter table field wksp_coll_
interval (see Table 9–9).
• tws_pool_total, twsc_pool_total
The default size for TWS or TWSC pools (in bytes) allocated for this
application. The frequency with which these fields are updated is based
on the value of the Parameter table field wksp_coll_interval (see Table 9–9).
• tws_poolsize_total, twsc_poolsize_total
The total size of all TWS or TWSC pools (in bytes) for all task groups in this
application. The frequency with which these fields are updated is based on
the value of the Parameter table field wksp_coll_interval (see Table 9–9).
• tws_pool_large_used, twsc_pool_large_used
The largest amount of TWS or TWSC pool used (in bytes) by a task group in
this application. The frequency with which these fields are updated is based
on the value of the Parameter table field wksp_coll_interval (see Table 9–9).
• err_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
Errors for this process are only sent to the Remote Manager if this field is set
to ENABLED. If this field is set to DISABLED, the process will not collect
data for the fields in this class; existing field values reflect activity during a
prior period when collection was enabled.
• err_count
The total number of errors generated by this process. related to this process
that were sent to the Remote Manager.
• last_err_msg
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
get_request_count integer R R
set_request_count integer R R
alarms_sent integer R R
time_alarm_last_ integer R R
sent
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• set_request_count
The number of write requests submitted to the interface. This includes
requests that are rejected because of authorization failures.
• alarms_sent
The number of alarms that have been sent by this interface. For SNMP, these
are SNMP traps. For RPC, this field is undefined.
• time_alarm_last_sent
The time the most recent alarm was sent by this interface. For SNMP, this is
the time the last SNMP trap was sent. For RPC, this field is undefined.
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
• rpc_udp_state
Current state of the RPC interface using the UDP protocol. A value of 1
means that the UDP protocol is active. A value of 0 means that the UDP
protocol is inactive.
• rpc_tcp_state
Current state of the RPC interface using the TCP protocol. A value of 1
means that the UDP protocol is active. A value of 0 means that the UDP
protocol is inactive.
Note
All the fields in Table 9–9 are of type integer, and all fields have read and
write access.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Interface
S—SNMP
R—RPC (API and ACMSMGR utility)
F—File (configuration file)
D—Field is dynamic.
• max_logins
Maximum number of external processes allowed to concurrently connect to
the Remote Manager. Starting the SNMP interface counts as one login. Each
RPC client counts as one login. RPCs are serviced serially.
• max_rpc_return_recs
The maximum number of records to be returned to any given request for data.
This parameter allows network bandwidth to be conserved by sending data in
user-managed chunks.
• msg_proc_priority
Relative priority of the message processor thread. The message processor is
responsible for removing messages sent by ACMS processes to the Remote
Manager from the error input queue and for processing messages according
to configuration values specified in the Collection and Trap tables. This value
should be left at the default. Priority is specified as a whole number between
1 and 10, where 1 is the lowest priority and 10 is the highest.
• mss_coll_interval
Controls the frequency (in seconds) at which MSS values are collected. A
lower value causes MSS values to be collected more often; a higher value
causes MSS values to be collected less often. MSS values are collected by all
ACMS run-time processes except SWL, ATR, and procedure servers.
• proc_mon_interval
The frequency (in seconds) at which the process monitor thread should run.
The process monitor thread checks for the existence of the ACC and other
ACMS run-time processes in order to map the MGMT global section and to
send alarms.
• proc_mon_priority
Relative priority of the process monitor thread. The process monitor thread
periodically checks for the existence of the ACC process in order to map the
MGMT global section and to send alarms. Priority is specified as a whole
number between 1 and 10, where 1 is the lowest priority and 10 is the
highest. This value should be left at the default.
• proxy_creds_lifetime
The amount of time (in minutes) that proxy logins are valid. When a user
first accesses a Remote Manager process using an ACMS proxy, a login
is created for the user, and the expiration of that login is calculated and
stored based on this parameter. When the current time is greater than the
expiration time, the user’s proxy information is refreshed. A change to this
parameter takes effect for any login that takes place after the change is made.
A change to this parameter does not take effect for any login that took place
before the change was made.
• rpc_priority
Relative priority of the RPC management thread. The RPC management
thread responds to RPC requests to get or set data values. Priority is
specified as a whole number between 1 and 10, where 1 is the lowest priority
and 10 is the highest.
• snap_priority
Relative priority of the data snapshot management thread. The data snapshot
thread responds to data snapshot requests to get or set data values. Priority
is specified as a whole number between 1 and 10, where 1 is the lowest and
10 is the highest.
• snmp_agent_time_out
Number of seconds that the SNMP Master agent waits for a response from
the Remote Manager. The maximum is 10 seconds for HP TCP/IP Services
Version 4.2. For HP TCP/IP Services Version 5.0 and higher, the maximum is
60 seconds.
• snmp_are_you_there
Controls how often are you there messages are sent by the Remote Manager
to the SNMP Master agent. This value should be entered as a multiple of the
snmp_sel_time_out value. Each time a timeout occurs, a timeout counter is
incremented. The product of the timeout counter and the snmp_sel_timeout
are then compared to the snmp_are_you_there value. If the product is greater
than the snmp_are_you_there value, an are_you_there message is sent.
• snmp_priority
Relative priority of the SNMP management thread. The SNMP management
thread responds to SNMP requests to get or set data values. Priority is
specified as a whole number between 1 and 10, where 1 is the lowest and 10
is the highest.
• snmp_sel_time_out
Controls how long the Remote Manager waits for a response from the SNMP
master agent. If the timeout value is reached and no messages are expected,
the snmp_are_you_there interval is checked (see snmp_are_you_there) .
If a message is expected and is not received before the select times out,
the connection to the master agent is assumed to have been lost and an
attempt is made to reregister. There is a hard coded 2 second wait prior to
reregistration.
This value also controls how long it takes to begin disabling this interface.
Requests to disable the interface do not interrupt the socket select—they wait
for it to either timeout or end naturally (that is, when a message is received).
At worse case, a request to disable the interface has to wait snmp_sel_time_
out seconds before the shutdown of the interface begins. Once it begins, it
usually shuts down quickly—within a second or two.
• tcp_enabled
Controls how the Remote Manager client and desktop server work together.
If this field is set to 0, then the current TCP/IP connection is disabled. If both
the tcp_enabled and udp_enabled fields are set to 0, the entire RPC thread is
shut down.
• timer_interval
The Remote Manager runs one internal timer that controls the operation of
all other timers. The interval of this timer effectively sets the smallest timer
interval for the process. The interval is set in seconds. If the value is too
small, the timer will run frequently with no work to do. This value should be
set to smallest desired timer interval.
• timer_priority
Relative priority of the timer thread. The timer thread manages all internal
timers. Priority is specified as a whole number between 1 and 10, where 1
is the lowest priority and 10 is the highest. This value should be left at the
default.
• total_entity_slots
The total number of Collection table entries to allow. When this number is
reached, additional ACMSMGR ADD COLLECTION requests are rejected.
Slots are allocated when the ACMS run-time system is started.
• trace_msg_wait_time
The number of seconds the Remote Manager should wait for updates to the
mss_coll_interval and wksp_coll_interval parameters to become effective
(processed by the ACC). Updates to the ACC are sent by means of the trace
monitor. The Remote Manager will poll the value being changed for up to
trace_msg_wait_time seconds to see whether the value was in fact changed.
If it is not changed within this timeframe, the Remote Manager logs an error
and returns an error to the caller.
• trace_start_wait_time
The number of seconds the Remote Manager should wait for the trace monitor
to be started. The Remote Manager communicates to ACMS process through
the trace monitor. The Remote Manager attempts to start the trace monitor
if the Remote Manager needs to send a message and the trace monitor is not
already running. This value controls how long the Remote Manager will wait
for the trace monitor to start before aborting the message send. Messages
that are not sent are discarded (lost).
• trap_priority
Relative priority of the trap sender thread. The trap sender thread dispatches
trap messages to SNMP and RPC receivers. Priority is specified as a whole
number between 1 and 10, where 1 is the lowest priority and 10 is the
highest. This value should be left at the default.
• udp_enabled
Controls how the Remote Manager client and desktop server work together. If
this field is set to 0, a UDP listener is not registered for the Remote Manager.
If both the tcp_enabled and udp_enabled fields are set to 0, the entire RPC
thread is shut down.
• vms_coll_interval
Controls the frequency (in seconds) at which OpenVMS process quota and
system parameter values are collected. A lower value causes these values to
be collected more often; a higher value causes these values to be collected less
often. OpenVMS process quota values are collected by all ACMS processes;
system parameter values are collected only by ACC.
• wksp_coll_interval
Controls the frequency (in seconds) at which workspace (WS, WSC, TWS,
TWSC) pool values are collected. A lower value causes workspace values to
be collected more often; a higher value causes workspace pool values to be
collected less often. Workspace pool values are collected only by ACC and
EXC.
• max_agents
Controls the value for the number of agents to be monitored. The default
value is 2, and the minimum value is 1. This value sets the size of the table
used to monitor agents. If the value is set too low, newly created agents will
not be monitored.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• qti_priority_stored
The base priority currently stored in the ACMSGEN file for this process.
• sub_timeout_active
The current value of the QTI submitter timeout.
• sub_timeout_stored
The value of the qti_sub_timeout field in the current ACMSGEN file.
• retry_timer_active
The current value of the QTI retry timer.
• retry_timer_stored
The value of the qti_retry_timer field in the current ACMSGEN file.
• polling_timer_active
The current value of the QTI polling timer.
• polling_timer_stored
The value of the qti_polling_timer field in the current ACMSGEN file.
• astlm_active, biolm_active, bytlm_active, diolm_active, enqlm_active, fillm_
active, pgflquota_active, tqelm_active, wsdefault_active, wsextent_active,
wsquota_active
The default value of the related OpenVMS process quota. This is the value of
the quota when the QTI process was started.
• astlm_stored, biolm_stored, bytlm_stored, diolm_stored, enqlm_stored, fillm_
stored, pgflquota_stored, tqelm_stored, wsdefault_stored, wsextent_stored,
wsquota_stored
The value of the related process quota currently stored in the OpenVMS
system user authorization file (SYSUAF.DAT).
• acms_state
The current ACMS state of this process.
• runtime_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• max_threads
The maximum number of threads allowed.
• started_queues
The number of queues currently started on the node.
• current_tasks
The number of tasks currently executed that were submitted by the QTI.
• current_submitters
The number of submitters currently logged in by the QTI.
• task_successes
The number of tasks successfully submitted and executed by the QTI.
• task_failures
The number of tasks that failed to complete successfully after being submitted
by the QTI.
• task_retries
The number of times the QTI has attempted to re-run a task that is currently
failed.
• errors_queued
The number of tasks queued to error queues by the QTI.
• astlm_current, biolm_current, bytlm_current, diolm_current, enqlm_current,
fillm_current, pgflquota_current, tqelm_current, wssize_current, channelcnt_
current
The actual amount of the related OpenVMS process or system resource that
is being consumed by the QTI process. The frequency with which these
fields are updated is based on the value of the vms_coll_interval field in the
Parameter table (see Table 9–9).
• pool_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• mss_process_total
The total size of the MSS process pool allocated for this process. The
frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_free
The amount of MSS process pool for this process that is currently unused.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_largest
The largest unused block available in the MSS process pool for this process.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_garbage
The number of garbage collections for this process that have been run to
reclaim space in the MSS process pool. The frequency with which this field is
updated is based on the value of the Parameter table field mss_coll_interval
(see Table 9–9).
• err_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
Errors for this process are only sent to the Remote Manager if this field is set
to ENABLED. If this field is set to DISABLED, the process will not collect
data for the fields in this class; existing field values reflect activity during a
prior period when collection was enabled.
• err_count
The total number of errors related to this process that were sent to the
Remote Manager.
• last_err_msg
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• minimum_instances_active
The current minimum number of started instances for this server type.
• maximum_instances_active
The current maximum number of started instances for this server type.
• runtime_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
If this field is set to DISABLED, the process is not currently collecting data
for the fields in this class. Any field values reflect activity during a prior
period when collection was enabled.
• current_servers
The current number of started servers of this type in the application.
• current_waiting_tasks
The current number of tasks waiting to execute processing steps that call
servers of this type in this application.
• server_start_count
The number of times a server instance has been created for servers of this
type in this application.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
• tws_pool_used, twsc_pool_used
The amount of TWS or TWSC pool used by this task group. The frequency
with which these fields are updated is based on the value of the Parameter
table field wksp_coll_interval (see Table 9–9).
• tws_pool_total, twsc_pool_total
The total size of the TWS or TWSC pool allocated for this task group. The
frequency with which these fields are updated is based on the value of the
Parameter table field wksp_coll_interval (see Table 9–9).
• tws_pool_free, twsc_pool_free
The amount of unused TWS or TWSC pool this task group. The frequency
with which these fields are updated is based on the value of the Parameter
table field wksp_coll_interval (see Table 9–9).
• tws_pool_largest, twsc_pool_largest
The largest unused block available in the TWS or TWSC pool for this task
group. The frequency with which these fields are updated is based on the
value of the Parameter table field wksp_coll_interval (see Table 9–9).
• tws_pool_failures, twsc_pool_failures
The number of failed attempts to allocate space in the TWS or TWSC pool for
this task group, The frequency with which these fields are updated is based
on the value of the Parameter table field wksp_coll_interval (see Table 9–9).
• tws_pool_garbage, twsc_pool_garbage
The number of garbage collections that have been run to reclaim space in
the TWS or TWSC pool for this task group. The frequency with which these
fields are updated is based on the value of the Parameter table field wksp_
coll_interval (see Table 9–9).
severity integer RW RW RW D
alarms_sent integer R R
alarm_last_sent integer R R
trap_delete integer RW D
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
EXISTS
This parameter causes a test to be performed each time the Remote
Manager detects that a process has started or stopped.
• min_value
The minimum allowable value for the parameter. Valid minimums are
parameter dependent (see Table 9–14). If the field or condition being
monitored is less than the value specified, an alarm is generated. A value of
-1 is used when this field is not to be evaluated.
• max_value
The maximum allowable value for the parameter. Valid maximums are
parameter dependent (see Table 9–14). If the field or condition being
monitored is greater than the value specified, an alarm is generated. A
value of -1 is used when this field is not to be evaluated.
• severity
A severity to be associated with the trap. Severity codes are embedded in the
trap message (see Section 9.14.3) and must be parsed by the trap receiver.
Valid values are:
INFO
WARN
ERROR
FATAL
• alarms_sent
A count of the number of alarms that have been sent.
• alarm_last_sent
The date and time the last alarm was sent.
• trap_delete
This field is available only through the SNMP interface. Set this field to 1
to delete the table row. RPC users call the procedure shown in Section 8.8.
ACMSMGR and ACMSCFG each provide a DELETE TRAP command for this
purpose.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
‡Only valid for use with systems running ACMS Version 4.4 or higher.
Key to Access Modes
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic
• tsc_username_stored
The value of the tsc_username field currently stored in the ACMSGEN file.
• cp_priority_active
The base priority for CP processes. This is the value of the ACMSGEN field
when the TSC process was started.
• cp_priority_stored
The base priority currently stored in the ACMSGEN file for CP processes.
• cp_slots_active
The current number of CP slots. This is the value of the ACMSGEN field
when the TSC process was started. This field also represents the maximum
number of entries in the CP table.
• cp_slots_stored
The value of the cp_slots field in the current ACMSGEN file.
• max_logins_active
The current maximum number of logins allowed.
• max_logins_stored
The value of the max_logins field in the current ACMSGEN file.
• max_tts_cp_active
The current maximum number of terminals that a CP will support.
• max_tts_cp_stored
The value of the max_tts_cp field in the current ACMSGEN file.
• perm_cps_active
The number of permanent CPs that will be maintained on the system.
• perm_cps_stored
The value of the perm_cps field in the current ACMSGEN file.
• min_cpis_active
The number of CP slots that will be left open on a given CP.
• min_cpis_stored
The value of the min_cpis field in the current ACMSGEN file.
• cp_username_active
The current user name under which CP processes will run.
• cp_username_stored
The value of the cp_username field in the current ACMSGEN file.
• astlm_active, biolm_active, bytlm_active, diolm_active, enqlm_active, fillm_
active, pgflquota_active, tqelm_active, wsdefault_active, wsextent_active,
wsquota_active
The default value of the related OpenVMS process quota. This is the value of
the quota when the TSC process was started.
• mss_process_largest
The largest unused block available in the MSS process pool for this process.
The frequency with which this field is updated is based on the value of the
Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_failures
The number of failed attempts to allocate space in the MSS process pool for
this process. The frequency with which this field is updated is based on the
value of the Parameter table field mss_coll_interval (see Table 9–9).
• mss_process_garbage
The number of garbage collections that have been run to reclaim space in
the MSS process pool for this process. The frequency with which this field is
updated is based on the value of the Parameter table field mss_coll_interval
(see Table 9–9).
• err_coll_state
The current collection state for this class and this process. Collection states
can be modified by modifying entries in the Collection table. See Section 5.1
and Section 9.4 for discussions of data collection.
Errors for this process are only sent to the Remote Manager if this field is set
to ENABLED. If this field is set to DISABLED, the process will not collect
data for the fields in this class; existing field values reflect activity during a
prior period when collection was enabled.
• err_count
The total number of errors related to this process that were sent to the
Remote Manager.
• last_err_msg
The text of the most recent error message related to this process that was
sent to the Remote Manager.
• time_of_last_error
Date and time of the most recent error message related to this process that
was sent to the Remote Manager.
R—Read Access
RW—Read/Write Access
Blank—Not available to the interface
D—Field is dynamic.
• 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).
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.
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_
BEGIN_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, /MAX_AGENTS
TRAP /ENTITY, /NAME, /PARAMETER, /SEVERITY, /TRAP_MIN, /TRAP_
MAX
(continued on next page)
Format
ACMSCFG ADD COLLECTION [/qualifiers]
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.
/NAME=[*,entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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, HP recommends that EXC, Server, and Task Group collection
information be written to the same snapshot file.
/STORAGE_BEGIN_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.
Format
ACMSCFG ADD TRAP [/qualifiers]
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.35 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–13 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–13 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.14.2 for a discussion about setting appropriate trap minimums and
maximums. See Section 9.14.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.
Format
ACMSCFG DELETE COLLECTION [/qualifiers]
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.
/NAME=[*,entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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.
Format
ACMSCFG DELETE TRAP [/qualifiers]
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.35 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.
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.
Format
ACMSCFG SET COLLECTION [/qualifiers]
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.
/NAME=[*,entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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, HP recommends that EXC, Server, and Task Group collection
information be written to the same snapshot file.
This value can be modified dynamically.
/STORAGE_BEGIN_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.
Format
ACMSCFG SET INTERFACE [/qualifiers]
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.
Format
ACMSCFG SET PARAMETER [/qualifiers]
Privileges Required
None.
Parameters
None.
Qualifiers
/[parameter]=value
All qualifiers correspond directly to fields in the Parameter table. See
Section 9.10.1 for descriptions of each field.
Notes
See Section 9.10 for a description of each parameter.
Example
$ ACMSCFG SET PARAMETER /MGR_AUDIT_LEVEL=E
This command modifies the dynamic parameter field mgr_audit_level.
Format
ACMSCFG SET TRAP [/qualifiers]
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.35 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–13 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–13 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.14.2 for a discussion about setting appropriate trap minimums and
maximums. See Section 9.14.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.
Format
ACMSCFG SHOW COLLECTION [/qualifiers]
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.4 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.
Format
ACMSCFG SHOW CONTROL
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
The control record is used by the Remote Manager and cannot be modified or
deleted. The ACMSCFG SHOW CONTROL command displays the following
fields:
• Interface count — Number of interface records in the file.
• Collection count — Number of collection records in the file.
• Timer count — Number of timer records in the file.
• Trap count — Number of trap records in the file.
• Parameter count — Number of parameter records in the file.
• Version — Internal file version identifier.
Examples
1. $ ACMSCFG SHOW CONTROL
Record Counts
Record type Count
------------ -------
Interface 2
Collection 2
Timer 1
Trap 1
Parameter 1
Version 6
This command shows the current contents of the control record in the
configuration file.
Format
ACMSCFG SHOW INTERFACE
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
The Remote Manager supports two interfaces: RPC and SNMP. This command
displays the enabled states of each interface.
See Section 9.8 for a discussion of each field displayed.
Examples
1. $ ACMSCFG SHOW INTERFACE
Interface Enable
Type State
--------------------------------------------------------
rpc enabled
snmp enabled
This command shows the current contents of the Interfaces table in the
configuration file. As shown, both interfaces are started when the Remote
Manager is started.
Format
ACMSCFG SHOW PARAMETER
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
See Section 9.10 for a description of each parameter.
Examples
1. $ ACMSCFG SHOW PARAMETER
Management Parameters
Parameter Value Default Min Max (D)ynamic
------------------------------------------------------------------------
dcl_audit_level E E 0 F (D)
dcl_mgr_priority 5 5 1 10
dcl_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
error_interval 10 10 1 863999999 seconds (D)
event_log_priority 5 5 1 10
log_stacksize 300 300 1 2147483647 K (Vax), 8k (Alpha)
login_creds_lifetime 60 60 1 14399999 minutes (D)
max_logins 20 20 1 2147483647 (D)
max_rpc_return_recs 20 20 1 2147483647
mgr_audit_level E E 0 F (D)
msg_proc_audit_level E E 0 F (D)
msg_proc_priority 5 5 1 10
msg_proc_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
mss_coll_interval 10 10 1 863999999 seconds (D)
proc_mon_audit_level E E 0 F (D)
proc_mon_interval 30 30 1 14399999 seconds (D)
proc_mon_priority 5 5 1 10
proc_mon_stacksize 300 300 1 2147483647 K (Vax), 8k (Alpha)
proxy_creds_lifetime 60 60 1 14399999 minutes (D)
rpc_audit_level E E 0 F (D)
rpc_priority 5 5 1 10
rpc_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
security_audit_level E E 0 F (D)
snap_audit_level E E 0 F (D)
snap_priority 5 5 1 10
snap_stacksize 30 30 1 2147483647 k (Vax), 8k (Alpha)
snmp_agent_time_out 10 10 1 863999999 seconds
snmp_are_you_there 300 300 2 863999999 seconds
snmp_audit_level E E 0 F (D)
snmp_priority 5 5 1 10
Format
ACMSCFG SHOW TRAP
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
SNMP traps are generated only if the SNMP interface is started.
See Section 9.14 for a description of each field displayed.
Examples
1. $ ACMSCFG SHOW TRAP
Entity Entity
Type Name Parameter Min Max Severity
------- ----------------------- ---------------- ------- -------- --------
* * exists 1 -1 i
This command shows the current contents of the Trap table in the
configuration file. As shown, a single trap has been configured to send
an informational trap when any ACMS process is stopped. This is the default
configuration.
This chapter provides reference information about the commands for the
ACMSMGR utility.
Note
Certain ACMSMGR 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.
• REPLACE
• RESET
• SAVE
• SET
• SHOW
• START
• STOP
Each verb has an associated object and set of qualifiers.
DELETE Command
COLLECTION /CLASS, /ENTITY, /NAME, /NODE, /USER
FILTER /CODE, /NAME, /NODE, /USER
TRAP /ENTITY, /NAME, /NODE, /PARAMETER, /USER
HELP Command
None None
LOGIN Command
None /NODE, /PASSWORD, /USER
LOGOUT Command
None /NODE, /USER
REPLACE Command
SERVER /APPLICATION, /NODE, /SERVER, /USER
SAVE Command
FILTER /FILE, /NODE, /USER
(continued on next page)
SHOW Command
ACC /ACTIVE, /BRIEF, /CONFIG, /ERROR, /FULL, /ID, /INTERVAL,
/NODE, /OUT, /POOL, /RUNTIME, /STORED, /USER
AGENT /ACTIVE, /ALL, /BRIEF, /[CONFIG,ERROR,ID,POOL,RUNTIME],
/FULL, /INTERVAL, /OUT, /PROCESS_NAME, /STORED, /NODE,
/USER
COLLECTION /BRIEF, /FULL, /INTERVAL, /NODE, /OUT, /USER
CP /ACTIVE, /ALL, /BRIEF, /CONFIG, /ERROR, /FULL, /ID,
/INTERVAL, /NODE, /OUT, /POOL, /PROCESS_NAME, /RUNTIME,
/STORED, /USER
ERROR /BEFORE, /FILENAME, /INTERVAL, /LOCAL, /NODE, /OUT,
/SEVERITY, /SINCE, /USER
EXC /ACTIVE, /ALL, /APPLICATION, /BRIEF, /CONFIG, /ERROR, /FULL,
/ID, /INTERVAL, /NODE, /OUT, /POOL, /RUNTIME, /STORED,
/USER
FILTER /NODE, /USER
GROUP /APPLICATION, /BRIEF, /FULL, /GROUP, /ID, /INTERVAL, /NODE,
/OUT, /POOL, /USER
INTERFACE /INTERVAL, /NODE, /OUT, /USER
LOG /BEFORE, /FACILITY, /FILENAME, /INTERVAL, /LOCAL, /NODE,
/OUT, /SEVERITY, /SINCE, /USER
MANAGER /INTERVAL, /NODE, /OUT, /USER
PARAMETER /INTERVAL, /NODE, /OUT, /USER
PROCESS /ALL, /BRIEF, /FULL, /INTERVAL, /NODE, /OUT, /USER
QTI /ACTIVE, /ALL, /BRIEF, /CONFIG, /ERROR, /FULL, /ID,
/INTERVAL, /NODE, /OUT, /POOL, /RUNTIME, /STORED, /USER
SERVER /APPLICATION, /BRIEF, /CONFIG, /FULL, /ID, /INTERVAL, /NODE,
/OUT, /RUNTIME, /SERVER, /USER
TRAP /INTERVAL, /NODE, /OUT, /USER
TSC /ACTIVE, /ALL, /BRIEF, /CONFIG, /ERROR, /FULL, /ID,
/INTERVAL, /NODE, /OUT, /POOL, /RUNTIME, /STORED, /USER
USER /BRIEF, /FULL, /INTERVAL, /NODE, /OUT, /USER
VERSION None.
(continued on next page)
STOP Command
EXC /APPLICATION, /CANCEL, /NODE, /USER
MANAGER /NODE, /USER
QTI /NODE, /USER
SYS /CANCEL, /NODE, /USER
TERMINALS /NODE, /USER
TRACE_ /NODE, /USER
MONITOR
Format
ACMSMGR ADD COLLECTION [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/CLASS=[*, ERROR, POOL, RUNTIME]
This qualifier specifies the class to 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.
/NAME=[*, entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/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 ACMSMGR 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, HP recommends that EXC, Server, and Task Group collection
information be written to the same snapshot file.
/STORAGE_BEGIN_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.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
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 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.
Example
$ ACMSMGR ADD COLL/ENT=EXC/CLASS=RUNTIME/NAME=VR_APPL/COLL_STATE=ENABLED
This command creates an entry in the Collection table. As a result of
this command, the EXC entity for VR_APPL will begin collecting run-time
information; however this data will not be saved and written to the data snapshot
file.
Format
ACMSMGR ADD FILTER [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/CODE=value
This qualifier specifies the decimal or hexadecimal value (such as, %x5258028)
related to the error message being filtered.
/FILE=file-name
This qualifier specifies the name of an input file that contains a list of error filter
values. The Remote Manager reads this file and adds each code or symbolic name
to the Error Filter table.
/NAME=error-name
This qualifier specifies the symbolic name (such as, %ACMSACC-W-TCS_
LOADING) related to the error message being filtered.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
When adding new error filter records, you must specify either the /CODE,
/NAME, or /FILE qualifier.
ACMS processes read the Error Filter table during process startup to determine
which errors to refrain from sending to the Remote Manager server. Error
filtering begins or ends immediately after filter records are added. The Remote
Manager signals the appropriate ACMS process as soon as it has reevaluated
the Error Filter table following an addition. Messages are sent to active ACMS
processes using the ACMS Trace Monitor.
Certain system messages, such as event flags (ACMSACC-I-EVENT), often
spawn further status messages indicating the cause of the event (ACMSACC-W-
FORCEOUT). Error filtering is explicit; that is, only the specified messages are
suppressed. If you want to filter the initial and subsequent system messages, you
must add each message to the Error Filter table. See Section 5.5 for information
on working with error logs and error filtering.
Errors are also filtered using the command SET PARAMETER/ERROR_
INTERVAL=n. Any errors that are rebroadcast within the specified interval
are not sent to the Remote Manager server. The command ACMSMGR SHOW
PARAMETER can be used to determine the the current error interval for ACMS
systems.
Example
$ ACMSMGR ADD FILTER /NAME="ACMSACC-W-FORCEOUT" /NODE=SPARKS
This command adds the ACMS ACC force out warning message to the Error
Filter table. If this message is generated by an ACMS process on node SPARKS,
it is not relayed to the Remote Manager.
Format
ACMSMGR ADD TRAP [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 4.7 and
Section 11.35 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 9.14.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 9.14.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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
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 9.14.2 for a discussion about setting appropriate trap minimums
and maximums. See also Section 9.14.3 for a description of the trap message
generated.
Example
$ 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.
Format
ACMSMGR DELETE COLLECTION [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/CLASS=[*, CONFIG, ERROR, ID, POOL, RUNTIME]
This qualifier specifies the class to be enabled or disabled. The default is * (all).
See Section 5.1.1 for a description of each class type.
/NAME=[*, entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
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.
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.
Example
$ 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.
Format
ACMSMGR DELETE FILTER [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/CODE=value
This qualifier specifies the hexadecimal value (such as, %x5258028) related to the
error message being filtered.
/NAME=error-name
This required qualifier specifies the symbolic name (such as, %ACMSACC-W-
TCS_LOADING) related to the error message being filtered.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
If the /USER qualifier is not specified and the ACMS$MGMT_USER logical is not
defined, the ACMSMGR utility attempts proxy access. See Section 4.4.1.2 for a
discussion of proxy access.
Notes
Either the /CODE or /NAME qualifier must be specified. When deleting error
filter records, the combination of code (or name) and node must exactly match the
row to be deleted.
ACMS processes read the Error Filter table during process startup to determine
which errors to refrain from sending to the Remote Manager server. Error
filtering ends immediately after filter records are deleted. The Remote Manager
signals the appropriate ACMS process as soon as it has reevaluated the Error
Filter table following a deletion. Messages are sent to active ACMS processes
using the ACMS Trace Monitor.
Errors are also filtered using the command SET PARAMETER/ERROR_
INTERVAL=n. Any errors that are rebroadcast within the specified interval
are not sent to the Remote Manager server. The command ACMSMGR SHOW
PARAMETER can be used to determine the the current error interval for ACMS
systems.
See Section 5.5 for information on working with error logs and error filtering.
Example
$ ACMSMGR DELETE FILTER /NAME="ACMSACC-W-FORCEOUT" /NODE=SPARKS
This command deletes the ACMS ACC force out warning message from the Error
Filter table. If this message is generated by an ACMS process on node SPARKS,
it is relayed to the Remote Manager and written to the error log.
Format
ACMSMGR DELETE TRAP [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.35 and
Section 4.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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
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.
Example
$ ACMSMGR DELETE TRAP/ENT=ACC/PARAM=EXISTS
This command deletes a trap from the Trap table.
Displays help information about the ACMS Remote Manager Client (ACMSMGR)
and its commands.
Format
ACMSMGR HELP
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
Online help is available for each ACMSMGR command. Each help topic
summarizes the valid syntax, abbreviations, parameters, and qualifiers for a
particular command and also inidicates 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. $ ACMSMGR HELP
This command invokes online help for the ACMSMGR utility and displays a list
of available topics.
Format
ACMSMGR LOGIN [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/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.
/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.
Notes
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 4.4 for a complete discussion of how logins are processed and how
credentials files are handled.
Examples
1. $ ACMSMGR LOGIN /NODE=SPARKS /USER=USERNAME /PASSWORD=12345678
This command logs in user USERNAME to node SPARKS.
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.
Format
ACMSMGR LOGOUT [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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
from which to log out.
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. Logout cannot
be performed without a user name.
Notes
Once logout is complete, subsequent ACMSMGR commands for a user, process,
and node will fail authorization checks.
Examples
1. $ ACMSMGR LOGOUT /NODE=SPARKS /USER=USERNAME
This command logs out user USERNAME from node SPARKS.
4. $ ACMSMGR LOGOUT
This command logs out the user defined by the logical name ACMS$MGMT_
USER from 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.
Format
ACMSMGR REPLACE SERVER [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/APPLICATION=[*, application-name]
This qualifier specifies the name of the application. If this qualifier is not
specified, the command is executed for all applications on the target node.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/SERVER=[*, server-name]
This qualifier specifies the name of the server. If this qualifier is not specified, the
command is executed for all servers on the target node in the target application.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/REPLACE
SERVER. The command is executed synchronously.
Example
$ ACMSMGR REPLACE SERVER /APPL=VR_APPL/SERV=VR_READ_SERVER/NODE=SPARKS
This command replaces the VR_READ_SERVER in the VR_APPL application on
node SPARKS.
Resets (closes) the Remote Manager error log file and creates (opens) a new
version.
Format
ACMSMGR RESET ERROR [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
Notes
This command closes the current version of the ACMSMGR error log file and
opens a new version.
Example
$ ACMSMGR RESET ERROR /NODE=SPARKS /USER=USERNAME
This command resets the Remote Manager error log on node SPARKS.
Resets (closes) the Remote Manager log file and creates (opens) a new version.
Format
ACMSMGR RESET LOG [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command closes the current version of the ACMSMGR log file and opens a
new version.
Example
$ ACMSMGR RESET LOG /NODE=SPARKS /USER=USERNAME
This command resets the Remote Manager log on node SPARKS.
Format
ACMSMGR SAVE FILTER [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/FILE=file-name
This required qualifier specifies a full OpenVMS file specification
(node::device:[directory]file-name.ext) that indicates where the error filter
information is to be written. Partial specifications and logical names are not
valid.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
Notes
This command provides the ability to write the current set of error filter records
to an external file. The /FILE qualifier is required and must reference a
valid, complete OpenVMS file specification. Logicals and partial names are
not recognized.
See Section 5.5 for information on working with error logs and error filtering.
Example
$ ACMSMGR SAVE FILTER/FILE=VLCROW::DISK1$:[SYSTEM.FILTER]ERROR_FILTER.TXT/NODE=SPARKS
This command saves the error filter records for node SPARKS to the
DISK1$:[SYSTEM.FILTER]ERROR_FILTER.TXT on node VLCROW.
Format
ACMSMGR SET ACC [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
ACMS$MGMT_SYSUPD (for system parameters)
Parameters
None.
Qualifiers
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user specified by ACC_
USERNAME. Updated quota values apply to the next process that is created.
Because these qualifiers control the nondynamic values for the related process
quotas, the /ACTIVE qualifier cannot be specified. The /STORED qualifier is the
default and causes the specified values to be stored in the current SYSUAF.DAT
file.
For information on using AUTHORIZE to modify process quotas, see the
OpenVMS System Manager’s Manual. For more information about the individual
quotas and their values, see OpenVMS System Management Utilities Reference
Manual: A–L or access the online help for AUTHORIZE.
/system-parameter=value
These qualifiers correspond to and update the related OpenVMS System
Generation utility (SYSGEN) parameters. Updated parameter values apply
to the next process that is created. The ACMS$MGMT_SYSUPD rights identifier
is required to set these parameters.
Because these qualifiers control the nondynamic values for the related syste
parameters, the /ACTIVE qualifier cannot be specified. The /STORED qualifier is
the default and causes the specified values to be stored in the current SYSGEN
work area.
For information on using SYSGEN, see the OpenVMS System Manager’s Manual.
For more information about the individual parameters and their values, see
OpenVMS System Management Utilities Reference Manual: M–Z or access the
online help for SYSGEN.
/ACC_PRIORITY=value
This qualifier corresponds to and updates the ACMSGEN field ACC_PRIORITY.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/ACC_USERNAME=user-name
This qualifier corresponds to and updates the ACMSGEN field ACC_USERNAME.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/ACTIVE
This qualifier causes dynamic ACMSGEN field values to be updated from the
current ACMSGEN file. The /ACTIVE qualifier cannot be specified on the same
command with the /STORED qualifier. If neither is specified, the default is
/STORED. If /ACTIVE is specified, no updates are written to the file.
/AUDIT_STATE=[ENABLED, DISABLED]
This qualifier is equivalent to the ACMSOPER command ACMS/SET
SYSTEM/AUDIT (or /NOAUDIT if the value is DISABLED).
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/MAX_APPL=value
This qualifier corresponds to and updates the ACMSGEN field MAX_APPL.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/MSS_MAXBUF=value
This qualifer corresponds to and updates the ACMSGEN field MSS_MAXBUF.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/MSS_MAXOBJ=value
This qualifier corresponds to and updates the ACMSGEN field MSS_MAXOBJ.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/MSS_NET_RETRY_TIMER=value
This qualifier corresponds to and updates the ACMSGEN field MSS_NET_
RETRY_TIMER. As this is a dynamic ACMSGEN field, the /ACTIVE qualifier
causes the current value to be modified for the running system. The /STORED
qualifier causes the specified value to be stored in the current ACMSGEN file.
/MSS_POOLSIZE=value
This qualifier corresponds to and updates the ACMSGEN field MSS_POOLSIZE.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/MSS_PROCESS_POOL=value
This qualifier corresponds to and updates the ACMSGEN field MSS_PROCESS_
POOL. Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier
cannot be specified with this qualifier. The /STORED qualifier causes the
specified value to be stored in the current ACMSGEN file.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/NODE_NAME=node-name
This qualifier corresponds to and updates the ACMSGEN field NODE_NAME.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/STORED
This qualifier causes ACMSGEN field updates to be written and saved in the
current ACMSGEN file. The /STORED qualifier cannot be specified on the
same command as the /ACTIVE qualifier. If neither is specified, the default is
/STORED.
/TWS_POOLSIZE=value
This qualifier corresponds to and updates the ACMSGEN field TWS_POOLSIZE.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/TWSC_POOLSIZE=value
This qualifier corresponds to and updates the ACMSGEN field TWSC_POOLSIZE.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the value specified to
be stored in the current ACMSGEN file.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
/USERNAME_DEFAULT=user-name
This qualifier corresponds to and updates the ACMSGEN field USERNAME_
DEFAULT. Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier
causes the current value to be modified for the running system. The /STORED
qualifier causes the specified value to be stored in the current ACMSGEN file.
/WS_POOLSIZE=value
This qualifier corresponds to and updates the ACMSGEN field WS_POOLSIZE.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/WSC_POOLSIZE=value
This qualifier corresponds to and updates the ACMSGEN field WSC_POOLSIZE.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
Notes
This command provides the ability to remotely update either the running ACMS
system or the current ACMSGEN file.
The /ACTIVE and /STORED qualifiers control how updates are posted to
ACMSGEN. The /ACTIVE and /STORED qualifiers have no effect on the /AUDIT_
STATE qualifier, which is processed independently of any ACMSGEN updates.
Examples
1. $ ACMSMGR SET ACC /NODE=SPARKS/MSS_NET_RETRY_TIMER=250/ACTIVE
This command modifies the ACMSGEN field mss_net_retry_timer on node
SPARKS and updates the active system only. The change is not saved in the
ACMSGEN file.
Format
ACMSMGR SET AGENT [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
ACMS$MGMT_SYSUPD (for system parameters)
Parameters
None.
Qualifiers
/PID=pid
Specifies the Process ID of the Agent the stored values of which to modify. The
/PID qualifier is Mandatory.
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user of the Agent using
the supplied process PID. Updated quota values apply to the next Agent that is
created.
Because these qualifiers control the nondynamic values for the related process
quota fields, the /ACTIVE qualifier cannot be specified. The /STORED qualifier
causes the specified values to be stored in the current SYSUAF.DAT file.
For information on using AUTHORIZE to modify process quotas, see the
OpenVMS System Manager’s Manual. For more information about the individual
quotas and their values, see OpenVMS System Management Utilities Reference
Manual: A–L or access the online help for AUTHORIZE.
/LOG=value
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command provides the ability to remotely update the current ACMSGEN
file.
The /ACTIVE and /STORED qualifiers are not used with the ACMSMGR SET
AGENT command because only stored values can be modified.
Examples
1. $ ACMSMGR SET AGENT /NODE=SPARKS /ASTLM=250 /PID=274009D6
This command modifies the ACMSGEN field astlm on node SPARKS for the
Agent running in the process of the specified PID.
Format
ACMSMGR SET COLLECTION [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/CLASS=[*, CONFIG, ERROR, ID, POOL, RUNTIME]
This qualifier specifies the class to 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. 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.
/NAME=[*, entity-name]
This qualifier specifies particular instances of an entity. Wildcards (*) are allowed
in names.
For ACC, AGENT, 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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/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, HP recommends that EXC, Server, and Task Group collection
information be written to the same snapshot file.
This value can be modified dynamically.
/STORAGE_BEGIN_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.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
When updating collection records, the combination of class, entity, and name
must exactly match a record in the Collection table.
You cannot modify Collection table entries for the ID and CONFIG classes.
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 the Collection table are processed immediately, except for storage
location and storage end time values. These values are applied the next time
snapshot data is written. The Remote Manager signals the appropriate ACMS
process as soon as it has reevaluated the Collection table following an addition.
Messages are sent to the ACMS process using the ACMS Trace Monitor.
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 COLLECTION command displays weights for each row
in the table. See also Section 5.1.1 for a discussion of the Collection table and of
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.
Example
$ ACMSMGR SET COLLECTION/ENT=EXC/CLASS=RUNTIME/NAME=VR_APPL/COLL_S=DISABLED
This command disables run-time data collection for the VR_APPL application.
Format
ACMSMGR SET CP [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user specified by CP_
USERNAME. Updated quota values apply to the next process that is created.
Because these qualifiers control the nondynamic values for the related process
quota fields, the /ACTIVE qualifier cannot be specified. The /STORED qualifier
causes the specified values to be stored in the current SYSUAF.DAT file.
For information on using AUTHORIZE to modify process quotas, see the
OpenVMS System Manager’s Manual. For more information about the individual
quotas and their values, see OpenVMS System Management Utilities Reference
Manual: A–L or access the online help for AUTHORIZE.
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
Notes
This command provides the ability to remotely update either the running ACMS
system or the current ACMSGEN file quota values for subsequent CP processes.
Examples
1. $ ACMSMGR SET CP /ASTLM=1000 /LOG
This command modifies the ASTLM process quota and causes informational
messages to be displayed that indicate the status of the update. The new
ASTLM value will be applied to subsequent CP processes.
Format
ACMSMGR SET EXC [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user specified by SHOW
EXC/ID. Updated quota values apply to the next process that is created.
Because these qualifiers control the nondynamic values for the related process
quota fields, the /ACTIVE qualifier cannot be specified. The /STORED qualifier
causes the specified values to be stored in the current SYSUAF.DAT file.
For information on using AUTHORIZE to modify process quotas, see the
OpenVMS System Manager’s Manual. For more information about the individual
quotas and their values, see OpenVMS System Management Utilities Reference
Manual: A–L or access the online help for AUTHORIZE.
/ACTIVE
This qualifier causes dynamic ACMSGEN field values to be updated from the
current ACMSGEN file. The /ACTIVE qualifier cannot be specified on the same
command with the /STORED qualifier. If neither is specified, the default is
/ACTIVE for all values except for process quotas (which default to /STORED). If
/ACTIVE is specified, no updates are written to the file.
/APPLICATION=application-name
The name of the application to be modified. The command ACMSMGR SET EXC
requires the /APPL qualifier for any values that are stored values. If the /APPL
qualifier is missing, the error NOAPPLQUAL will be returned.
A different error, NOSUCHAPPL, will be returned if the application you are
attempting to modify is not active.
/AUDIT_STATE=[ENABLED, DISABLED]
This qualifier is equivalent to the ACMSOPER command ACMS/MODIFY
APPLICATION /APPL=AUDIT (or /APPL=NOAUDIT if the value is DISABLED).
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/MAX_SERVERS=value
This qualifier updates the MAX_SERVERS limit in the running application.
Updates are lost when the application is restarted.
/MAX_TASKS=value
This qualifier updates the MAX_TASKS limit in the running application. Updates
are lost when the application is restarted.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/SP_MON_INTERVAL=value
This qualifier updates the SP_MON_INTERVAL field in the running application.
Updates are lost when the application is restarted.
/STORED
This qualifier causes ACMSGEN field updates to be written and saved in the
current ACMSGEN file. The /STORED qualifier cannot be specified on the same
command as the /ACTIVE qualifier. If neither is specified, the default is /ACTIVE
for all values except for process quotas (which default to /STORED).
/TRANSACTION_TIME=value
This qualifier updates the TRANSACTION_TIMEOUT default value in the
running application. Updates are lost when the application is restarted.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/MOD
APPLICATION. Any changes made to the running system are lost when the
application is restarted.
Example
$ ACMSMGR SET EXC/APPL=VR_APPL/SP_MON_INTERVAL=10/MAX_TASKS=50
This command modifies the running application VR_APPL.
Format
ACMSMGR SET INTERFACE [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/INTERFACE=[RPC, SNMP]
This required qualifier specifies which interface to modify. Only SNMP is
supported.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/STATE=[ENABLED, DISABLED]
This qualifier specifies the operation to perform. If the value is ENABLED, the
interface will be started (if it is not already running). If the value is DISABLED,
the interface will be stopped (if it is not already stopped).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command allows interfaces to be stopped or started. However, an interface
cannot disable itself. Since the ACMSMGR utility uses the RPC interface, it
cannot be used to disable the RPC interface.To disable the RPC interface, either
use the ACMSCFG utility and restart the Remote Manager, or use the SNMP
interface.
The SNMP interface can be both enabled and disabled using this command. It
may take several seconds for this command to complete if the SNMP interface is
in a non-interruptible state when the command is issued
Example
$ ACMSMGR 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. Authorization is either performed for the
user specified by the logical ACMS$MGMT_USER, or is based on an ACMS proxy
on the target node if the logical is not defined.
Format
ACMSMGR SET PARAMETER [/qualifiers]
Privileges Required
ACMS$MGMT_WRITE
Parameters
None.
Qualifiers
/parameter=value
All qualifiers except NODE and USER correspond directly to fields in the
Parameter table. See Section 9.10.1 for a description of each field. For a
listing of the current default, minimum, and maximum values, use the SHOW
PARAMETER command.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
Some parameter changes take effect immediately; others take effect only when
the Remote Manager is restarted, and only if they are written to the ACMSCFG
file (using the ACMSCFG SET PARAMETER command). Table 9–9 shows which
parameters are dynamic and which are not.
For parameters that are not dynamic, you must restart the appropriate facility
for the change to take effect. For example, to modify the SNMP_SELECT_TIME_
OUT parameter, you must stop and restart the SNMP interface.
See Table 9–9 for a description of each parameter.
The ACMS Remote Manager allows an authorized user to make changes to the
VMS parameter file (via SYSGEN), ACMS parameter file (via ACMSGEN), user
quotas (via AUTHORIZE), ACMS Remote Manager parameters (via ACMSMGR
SET PARAM) and to a running ACMS system (via ACMSOPR commands).
Some values are checked for minimums, like negative numbers and zero. ACMS
Remote Manager parameters are checked for limits but Authorize, ACMSGEN
and SYSGEN values are not. Use the same caution with the ACMS Remote
Manager as you would with SYSGEN and AUTHORIZE and verify any changes
you make.
Example
$ ACMSMGR SET PARAMETER /MGR_AUDIT_LEVEL=E /NODE=SPARKS /USER=USERNAME
ACMS Remote Management Option -- Command line utility
Call to modify parameters on server sparks was executed
%ACMSMGMT-S-SUCCESS, Operation completed
This command modifies the dynamic parameter MGR_AUDIT_LEVEL on node
SPARKS and specifies that authorization be performed for user USERNAME.
Format
ACMSMGR SET QTI [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user specified by QTI_
USERNAME. Updated quota values apply to the next process that is created.
Because these qualifiers control the nondynamic values for the related process
quota fields, the /ACTIVE qualifier cannot be specified. The /STORED qualifier
causes the specified values to be stored in the current SYSUAF.DAT file.
For information on using AUTHORIZE to modify process quotas, see the
OpenVMS System Manager’s Manual. For more information about the individual
quotas and their values, see OpenVMS System Management Utilities Reference
Manual: A–L or access the online help for AUTHORIZE.
/ACTIVE
This qualifier causes dynamic ACMSGEN field values to be updated from the
current ACMSGEN file. The /ACTIVE qualifier cannot be specified on the same
command with the /STORED qualifier. If neither is specified, the default is
/STORED. If /ACTIVE is specified, no updates are written to the file.
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/POLLING_TIMER=node-name
This qualifier corresponds to and updates the ACMSGEN field QTI_POLLING_
TIMER. Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes
the current value to be modified for the running system. The /STORED qualifier
causes the specified value to be stored in the current ACMSGEN file.
/QTI_PRIORITY=value
This qualifier corresponds to and updates the ACMSGEN field QTI_PRIORITY.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/QTI_USERNAME=user-name
This qualifier corresponds to and updates the ACMSGEN field QTI_USERNAME.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/RETRY_TIMER=value
This qualifier corresponds to and updates the ACMSGEN field QTI_RETRY_
TIMER. Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes
the current value to be modified for the running system. The /STORED qualifier
causes the specified value to be stored in the current ACMSGEN file.
/STORED
This qualifier causes ACMSGEN field updates to be written and saved in the
current ACMSGEN file. The /STORED qualifier cannot be specified on the
same command as the /ACTIVE qualifier. If neither is specified, the default is
/STORED.
/SUB_TIMEOUT=value
This qualifier corresponds to and updates the ACMSGEN field QTI_SUB_
TIMEOUT. Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier
causes the current value to be modified for the running system. The /STORED
qualifier causes the specified value to be stored in the current ACMSGEN file.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command allows you to remotely update either the running ACMS system or
the current ACMSGEN file.
The /ACTIVE and /STORED qualifiers control how updates are posted to
ACMSGEN. The /ACTIVE and /STORED qualifiers have no effect on the /AUDIT_
STATE qualifier, which is processed independently of any ACMSGEN updates.
Examples
1. $ ACMSMGR SET QTI /NODE=SPARKS/SUB_TIMEOUT=5000/ACTIVE
This command modifies the ACMSGEN field qti_sub_timeout on node
SPARKS and updates the active system only. The change is not saved in the
ACMSGEN file.
Format
ACMSMGR SET SERVER [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/APPLICATION=application-name
The name of the application to be modified. If this qualifier is not specified,
modifications are applied to all applications.
/CREATION_DELAY=value
This qualifier updates the CREATION_DELAY for the specified server in the
running application. Updates are lost when the application is restarted.
/CREATION_INTERVAL=value
This qualifier updates the CREATION_INTERVAL for the specified server in the
running application. Updates are lost when the application is restarted.
/DELETION_DELAY=value
This qualifier updates the DELETION_DELAY for the specified server in the
running application. Updates are lost when the application is restarted.
/DELETION_INTERVAL=value
This qualifier updates the DELETION_INTERVAL for the specified server in the
running application. Updates are lost when the application is restarted.
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/MAX_INSTANCE=value
This qualifier updates the MAX_INSTANCE limit for the specified server in the
running application. Updates are lost when the application is restarted.
/MIN_INSTANCE=value
This qualifier updates the MIN_INSTANCE limit for the specified server in the
running application. Updates are lost when the application is restarted.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/SERVER=server-name
This qualifier specifies the name of the server to be modified. If this qualifier is
not specified, all servers in the application are modified.
/SP_DUMP_FLAG=value
This qualifier updates the SP_DUMP_FLAG for the specified server in the
running application. Updates are lost when the application is restarted.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/MOD
APPLICATION/SERVER. Any changes made to the running system are lost
when the application is restarted.
Example
$ ACMSMGR SET SERVER/APPL=VR_APPL/SERVER=VR_READ_SERVER/SP_DUMP_FLAG=ENABLED
This command modifies the SP_DUMP_FLAG field for the server VR_READ_
SERVER running in the VR_APPL application.
Format
ACMSMGR SET TRAP [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/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 host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.35 and
Section 4.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.
/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 9.14.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 9.14.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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
When updating trap records, the combination of entity, name, and parameter
must exactly match a record in the Trap table.
Changes become active as soon as they are added to the Trap table.
See Section 9.14.2 for a discussion about setting appropriate trap minimums and
maximums. See Section 9.14.3 for a description of the trap message generated.
Example
$ ACMSMGR SET TRAP /ENT=QTI/PARAM=EXISTS/MAX=0
This command causes an SNMP trap to be generated whenever the QTI process
is started if the SNMP interface is running.
Format
ACMSMGR SET TSC [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/process-quota=value
These qualifiers correspond to and update the related process quota fields in
the system user authorization (SYSUAF) record for the user specified by /TSC_
USERNAME. Updated quota values apply to the next process that is created.
Because these qualifiers control the nondynamic values for the related process
quota fields, the /ACTIVE qualifier cannot be specified. The /STORED qualifier
is the default and causes the specified values to be stored in the current
SYSUAF.DAT file.
/ACTIVE
This qualifier causes dynamic ACMSGEN field values to be updated from the
current ACMSGEN file. The /ACTIVE qualifier cannot be specified on the same
command with the /STORED qualifier. If neither is specified, the default is
/STORED. If /ACTIVE is specified, no updates are written to the file.
/CP_PRIORITY=value
This qualifier corresponds to and updates the ACMSGEN field CP_PRIORITY.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/CP_SLOTS=value
This qualifier corresponds to and updates the ACMSGEN field CP_SLOTS.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/CP_USERNAME=user-name
This qualifier corresponds to and updates the ACMSGEN field CP_USERNAME.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/LOG
This qualifier causes status information for the current SET transaction to be
displayed to the terminal (SYS$OUTPUT). This qualifier is useful when setting
multiple values; a separate status message is displayed for each value that is set.
/MAX_LOGINS=value
This qualifier corresponds to and updates the ACMSGEN field MSS_MAX_
LOGINS. As this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes
the current value to be modified for the running system. The /STORED qualifier
causes the value specified to be stored in the current ACMSGEN file.
/MAX_TTS_CP=value
This qualifier corresponds to and updates the ACMSGEN field MAX_TTS_CP.
Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes the
current value to be modified for the running system. The /STORED qualifier
causes the specified value to be stored in the current ACMSGEN file.
/MIN_CPIS=value
This qualifier corresponds to and updates the ACMSGEN field MIN_CPIS.
Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes the
current value to be modified for the running system. The /STORED qualifier
causes the specified value to be stored in the current ACMSGEN file.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/PERM_CPS=value
This qualifier corresponds to and updates the ACMSGEN field PERM_CPS.
Because this is a dynamic ACMSGEN field, the /ACTIVE qualifier causes the
current value to be modified for the running system. The /STORED qualifier
causes the specified value to be stored in the current ACMSGEN file.
/STORED
This qualifier causes ACMSGEN field updates to be written and saved in the
current ACMSGEN file. The /STORED qualifier cannot be specified on the
same command as the /ACTIVE qualifier. If neither is specified, the default is
/STORED.
/TSC_PRIORITY=value
This qualifier corresponds to and updates the ACMSGEN field TSC_PRIORITY.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/TSC_USERNAME=user-name
This qualifier corresponds to and updates the ACMSGEN field TSC_USERNAME.
Because this is a nondynamic ACMSGEN field, the /ACTIVE qualifier cannot be
specified with this qualifier. The /STORED qualifier causes the specified value to
be stored in the current ACMSGEN file.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command provides the ability to remotely update either the running ACMS
system or the current ACMSGEN file.
The /ACTIVE and /STORED qualifiers control how updates are posted to
ACMSGEN.
Examples
1. $ ACMSMGR SET TSC /NODE=SPARKS/MAX_LOGINS=500/ACTIVE
This command modifies the ACMSGEN field max_logins on node SPARKS and
updates the active system only. The change is not saved in the ACMSGEN
file.
Format
ACMSMGR SHOW ACC [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL). Note that OpenVMS process quota and SYSGEN parameter information
is only shown when /FULL is specified.
/[CONFIG,ERROR,ID,POOL,RUNTIME]
This qualifier causes data for only the specified class to be displayed. The default
is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about the ACC on the target node. The
/BRIEF and /FULL qualifiers control the format ofinformation to be displayed. To
display OpenVMS process quota and SYSGEN parameter information, use the
/FULL qualifier.
See Section 9.2 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the ACC. The Config Class field
indicates whether or not information is being collected for that class.
Examples
1. $ ACMSMGR SHOW ACC /CONFIG /NODE=GOCROW,VLCROW
ACMS Remote Management -- Command line utility
ACMS V5.0 ACC Table Display Time: 18-APR-2001 13:59:06.99
A Config Audit Max Mss Mss Proc Mss Mss WS TWS
Node S Class State Appl Max Obj Pool Poolsize Maxbuf Poolsize Poolsize
------ - ------- ------- ---- ------- -------- -------- ------ -------- --------
gocrow A enabled enabled 10 1006 512 4096 1544 256 1440
vlcrow A enabled enabled 10 1006 512 2048 1544 256 1440
This command displays ACC configuration information from nodes GOCROW and
VLCROW. Authorization is performed for the user specified by the logical name
Node RUNTIME
-------- -------------------------------------------------------------------------
vlcrow Runtime Class Collection State enabled
DECnet Object started
This command displays all ACC management information from node VLCROW.
Authorization is performed for user JONES. Since no class qualifiers (/ID,
/CONFIG, /RUNTIME, /POOL, /ERROR) were specified, information is returned
for all classes by default.
Format
ACMSMGR SHOW AGENT [/qualifiers]
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/ALL
This qualifier displays all available application data, even data for applications
that may no longer be running. When applications are stopped, the table row
they were occupying is marked for reuse. If the row has not been reused, the
data remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL). Available OpenVMS process quota and SYSGEN parameter information
is only displayed when /FULL is specified.
/[CONFIG,ERROR,ID,POOL,RUNTIME]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/PROCESS_NAME=process-name
This qualifier causes data for only the specified process to be displayed. If this
qualifier is omitted, the default is to display information for all Agent processes.
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Example
Node IDENTIFICATION
------------ -----------------------------------------------------------------
-
OHMARY ID Class Collection State enabled
Process Name _FTA37:
PID 00014D60
User Name HALL
Start Time 9-FEB-2005 09:58:47.12
End Time (null)
Node CONFIGURATION Active Stored
------------ ---------------------------------- -------------- --------------
OHMARY Config Class Collection State enabled
Working Set Default 65536 80000
Working Set Extent 262144 90000
Working Set Quota 65536 65535
AST Limit 1024 1024
Byte Limit 347184 350000
Direct I/O Limit 500 500
Buffered I/O Limit 500 500
Enqueue Limit 16776959 32767
File Limit 5000 5000
Page File Quota 1000000 1000000
Timer Queue Limit 150 150
Node RUNTIME
------------ -----------------------------------------------------------------
-----------
OHMARY Runtime Class Collection State enabled
Agent Running State started
DECnet Object stopped
Terminals/Tasks/User Defined Current Max Max Time
---------------------------------- -------- --------- -----------
-------------
Attached Terminals 0 0 (null)
Active Task Calls 0 1 9-FEB-
2005 09:58:50.64
Total Tasks Executed 258
User1 Time (null)
User2 Time (null)
User3 Time (null)
User1 Data 0
User2 Data 0
User3 Data 0
User4 Data 0
User5 Data 0
User6 Data 0
TDMS Current Max Max Time
---------------------------------- -------- --------- -----------
-------------
Active TDMS Requests 0 0 (null)
Active TDMS Menu Requests 0 0 (null)
Active TDMS Read Messages 0 0 (null)
Active TDMS Write Messages 0 0 (null)
Active TDMS Cancels 0 0 (null)
Total TDMS Requests 0
Total TDMS Menu Requests 0
Total TDMS Read Messages 0
Total TDMS Write Messages 0
Total TDMS Cancels 0
Node ERROR
------------ -----------------------------------------------------------------
------------
OHMARY Error Class Collection State enabled
Error Count 0
Last Error Message 0
Time of Last Error (null)
This command displays the contents of the Collection table for all Agents that are
running.
Format
ACMSMGR SHOW COLLECTION [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed.
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).
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays data-collection configuration information on the target
node. The /BRIEF and /FULL qualifiers control the format of information to be
displayed.
See Section 9.7 for a discussion of each field displayed. See Section 5.1 for a
discussion of collections.
Example
This command displays the contents of the Collection table on node VLCROW,
where all collections have been enabled for all entities. Authorization is
performed for the user specified by the logical ACMS$MGMT_USER, or by
proxy if the logical is not defined. Data snapshots for the ID class have been
enabled and are set to occur every 5 minutes (3600 seconds). The data files are
stored in the file specified by the logical ACMS$MGMT_SNAPSHOT.
Format
ACMSMGR SHOW CP [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/ALL
This qualifier displays all available application data, even data for applications
that are no longer running. When applications are stopped, the CP table row
they were occupying is marked for reuse. If the row has not been reused, the
data remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL). Available OpenVMS process quota and SYSGEN parameter information
is only displayed when /FULL is specified.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/PROCESS_NAME=process-name
This qualifier causes data for only the specified process to be displayed. If this
qualifier is omitted, the default is to display information for all CP processes.
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about ACMS command processes (CPs)
on the target node. The /BRIEF and /FULL qualifiers control the format of
information to be displayed. To display OpenVMS process quota and SYSGEN
parameter information, use the /FULL qualifier.
See Section 9.5 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the CP. The Runtime Class field
indicates whether or not information is being collected for that class.
Example
$ ACMSMGR SHOW CP/RUNTIME/NODE=VLCROW
Displays the errors recorded in the Remote Manager error log file.
Format
ACMSMGR SHOW ERROR [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/BEFORE=time
This qualifier causes only those error log entries with a timestamp less than or
equal to the time specified by time to be returned and displayed. 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 search ends
when the end of the audit file is reached.
/BRIEF
The /BRIEF and /FULL qualifiers control the amount of information shown for
any errors. ACMSMGR SHOW ERROR defaults to the /BRIEF display.
/FILENAME=file-name
This qualifier allows log records to be displayed from a file other than the current
error log file. Specify a fully- or partially-qualified file specification.
/FULL
The /BRIEF and /FULL qualifiers control the amount of information shown for
any errors. ACMSMGR SHOW ERROR defaults to the /BRIEF display.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
/LOCAL
This qualifier causes the ACMSMGR to open and read the error log on the
local node directly. You can use this qualifier if the Remote Manager process
is not started. The /LOCAL qualifier overrides the /NODE qualifier and the
ACMS$MGMT_SERVER_NODE logical.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/SEVERITY=[I, W, E, F]
This qualifier causes only error log entries with matching severities to be
displayed. Valid severities are informational (I), warning (W), error (E), and fatal
(F). If this qualifier is not specified, all severities are returned.
/SINCE=time
This qualifier causes only error log entries with a timestamp greater than or
equal to the time specified by time to be returned and displayed. 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 search begins
at the beginning of the audit file.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays Remote Manager error log information. The format of the
error log entries displayed is:
node time: severity: error-text
In this format:
• node is the node from which the information was obtained.
Example
$ ACMSMGR SHOW ERROR /NODE=VLCROW
ACMS Remote Management -- Command line utility
ACMS V5.0 Log Display Time: 18-APR-2001 13:59:13.39
Node Message
vlcrow : 17-APR-2001 10:40:41.04 : %ACMSACC-I-EVENT, Event
: -ACMSACC-E-ERRSTARTA, Error occurred starting application
: -ACMSEXC-E-
NO_TDB, Error opening TDB file !AS for task group !AS
vlcrow : 16-APR-2001 14:26:01.34 : %ACMSMSS-E-ERRNETCRE, Error creating DECnet object
: -ACMSMSS-E-
NODEMISMATCH, NODE_Name is ACMSPAR does not match DECnet node name
This command displays entries from the Remote Manager error log on node
VLCROW. Authorization is performed for the user specified by the logical name
ACMS$MGMT_USER, or by proxy if the logical is not defined.
Format
ACMSMGR SHOW EXC [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/ALL
This qualifier displays all available application data, even data for applications
that may no longer be running. When applications are stopped, the EXC table
row they were occupying is marked for reuse. If the row has not been reused, the
data remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/APPLICATION=application-name
This qualifer specifies a particular ACMS application to display. Wildcard
matching is performed on the name provided; use of asterisks (*) is allowed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/[CONFIG,ERROR,ID,POOL,RUNTIME]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically every interval
seconds. Use either Ctrl/C or Ctrl/Y to interrupt the command. If this qualifier is
not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about ACMS applications on the target
node. The /BRIEF and /FULL qualifiers control the format of information to
be displayed. To display OpenVMS process quota and SYSGEN parameter
information, use the /FULL qualifier.
See Section 9.7 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the application. The ID Class
field indicates whether or not information is being collected for that class.
Example
$ ACMSMGR SHOW EXC/ID
ACMS Remote Management -- Command line utility
ACMS V5.0 EXC Table Display Time: 18-APR-2001 13:59:09.33
ID
Node Class PID Process Name Start Time Application Name
------ ------- -------- --------------- ----------------------- --------------------------
vlcrow enabled 37C0025A ACMS01EXC001000 18-APR-2001 14:49:49.22 LDT_APPL_A
gocrow enabled 38000249 ACMS01EXC001000 18-AUG-2001 15:07:23.51 LDT_APPL_B
This command displays summary IDENTIFICATION class information for all
applications on the nodes specified by the logical name ACMS$MGMT_SERVER_
NODE. Authorization is performed for the user specified by the logical name
ACMS$MGMT_USER, or by proxy if the logical is not defined.
Format
ACMSMGR SHOW FILTER [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays all system errors currently being filtered for the specified
node or nodes.
See Section 5.5 for information on working with error logs and error filtering.
Example
$ ACMSMGR SHOW FILTER /NODE=VLCROW
ACMS Remote Management -- Command line utility
ACMS V5.0 ACMS Error Filter Table Display Time: 18-APR-2001 13:59:09.33
Node Filtered Message Name (Code)
------ ----------------------------------------------------------------------
VLCROW ACMSACC-W-AUDSYSSTARTS ( FD8748)
VLCROW SYSTEM-W-TOOMUCHDATA ( 298)
VLCROW SYSTEM-W-NOMOREREG ( AE8)
This command displays the current errors being filtered for node VLCROW. When
generated by an ACMS process on node VLCROW, these errors are not relayed to
the Remote Manager.
Displays information about one or more ACMS task groups on one or more nodes.
Format
ACMSMGR SHOW GROUP [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/APPLICATION=application-name
This qualifer specifies a particular ACMS application to display. Wildcard
matching is performed on the name provided; use of asterisks (*) is allowed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information
to be displayed. If no class qualifier (/ID or /POOL) is specified, this qualifier is
ignored and all details are displayed (equivalent to /FULL). If a class qualifier is
used on the command, the default action provides a brief format display. Using
/FULL with a class qualifier produces a full format display.
/GROUP=group-name
This qualifier specifies a particular ACMS task group to display. Wildcard
matching is performed on the name provided; use of asterisks (*) is allowed.
/[ID, POOL]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about ACMS application task groups on the
target node. The /BRIEF and /FULL qualifiers control the format of information
to be displayed. To display OpenVMS process quota and SYSGEN parameter
information, use the /FULL qualifier.
See Section 9.13 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the task group. The Pool Class
field indicates whether or not information is being collected for that class.
Example
$ ACMSMGR SHOW GROUP/POOL
Format
ACMSMGR SHOW INTERFACE [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
The ACMS Remote Manager supports two interfaces: RPC and SNMP. This
command displays the running and enabled states of each interface, along with
some counter and status information. See Section 9.8 for a discussion of each
field displayed.
Example
$ ACMSMGR SHOW INTERFACE /NODE=VLCROW,GOCROW /USER=JONES
Displays Remote Manager log entries for a server on one or more nodes.
Format
ACMSMGR SHOW LOG [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/BEFORE=time
This qualifier causes only audit log entries with a timestamp less than or equal
to the time specified by time to be returned and displayed. 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 search ends when the
end of the audit file is reached.
/FILENAME=file-name
This qualifier allows log records to be displayed from a file other than the current
log file. Specify a fully or partially qualified file specification.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/LOCAL
This qualifier causes the ACMSMGR to open and read the audit log on the
local node directly. You can use this qualifier if the Remote Manager process
is not started. The /LOCAL qualifier overrides the /NODE qualifier and the
ACMS$MGMT_SERVER_NODE logical.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/SEVERITY=[I, W, E, F]
This qualifier causes only audit log entries with matching severities to be
displayed. Valid severities are informational (I), warning (W), error (E), and fatal
(F). If this qualifier is not specified, all severities are returned.
/SINCE=time
This qualifier causes only audit log entries with a timestamp greater than or
equal to the time specified by time to be returned and displayed. 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 search begins
at the beginning of the audit file.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays Remote Manager audit file information. The format of
the audit entries displayed is:
node time: facility: severity: error-text
In this format:
• node is the node from which the information was obtained.
• time is the time the entry was logged.
• facility is the facility that generated the entry.
• severity is the severity of the entry.
Examples
1. $ ACMSMGR SHOW LOG /NODE=VLCROW /SINCE="20-MAR-2001 11:00" -
_$ /BEFORE="20-MAR-2001 12:00"
Format
ACMSMGR SHOW MANAGER [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/[BRIEF,FULL]
Specifies the format of the data displayed. /BRIEF is the default. /FULL qualifier
displays timer information in addition to the information displayed in the brief
display.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
See Section 9.9 for a discussion of each field displayed.
Example
$ ACMSMGR SHOW MANAGER
Format
ACMSMGR SHOW PARAMETER [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
See Section 9.10 for a description of each parameter.
Example
$ ACMSMGR SHOW PARAMETER /NODE=VLCROW
ACMS Remote Management -- Command line utility
ACMS V5.0 Parameters Table Display Time: 18-APR-2001 13:59:24.79
Node Parameter Value Default Min Max Units
---------------------------------------------------------------------------------------------
VLCROW dcl_audit_level E E 0 F (D)
VLCROW dcl_mgr_priority 5 5 1 10
VLCROW dcl_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW event_log_priority 5 5 1 10
VLCROW error_interval 10 10 1 863999999 seconds (D)
VLCROW log_stacksize 300 300 1 2147483647 K (Vax), 8k (Alpha)
VLCROW login_creds_lifetime 60 60 1 14399999 minutes (D)
VLCROW max_logins 20 20 1 2147483647 (D)
VLCROW max_rpc_return_recs 20 20 1 2147483647
VLCROW mgr_audit_level E E 0 F (D)
VLCROW msg_proc_audit_level E E 0 F (D)
VLCROW msg_proc_priority 5 5 1 10
VLCROW msg_proc_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW mss_coll_interval 10 10 1 863999999 seconds (D)
VLCROW proc_mon_audit_level E E 0 F (D)
VLCROW proc_mon_interval 3 30 1 14399999 seconds (D)
VLCROW proc_mon_priority 5 5 1 10
VLCROW proc_mon_stacksize 300 300 1 2147483647 K (Vax), 8k (Alpha)
VLCROW proxy_creds_lifetime 60 60 1 14399999 minutes (D)
VLCROW rpc_audit_level E E 0 F (D)
VLCROW rpc_priority 5 5 1 10
VLCROW rpc_stacksize 30 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW security_audit_level E E 0 F (D)
VLCROW snap_audit_level E E 0 F (D)
VLCROW snap_priority 5 5 1 10
VLCROW snap_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW snmp_agent_time_out 10 10 1 863999999 seconds
VLCROW snmp_are_you_there 300 300 2 863999999 seconds
VLCROW snmp_audit_level E E 0 F (D)
VLCROW snmp_priority 5 5 1 10
VLCROW snmp_sel_time_out 5 5 1 863999999 seconds
VLCROW snmp_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW tcp_enabled 1 1 0 1 [0,1] 1=enabled
VLCROW timer_audit_level E E 0 F (D)
VLCROW timer_interval 30 30 1 863999999 seconds (D)
VLCROW timer_priority 5 5 1 10
VLCROW timer_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW total_entity_slots 20 20 1 2147483647
VLCROW trace_msg_wait_time 5 5 1 14399999 seconds (D)
VLCROW trace_start_wait_time 5 5 1 14399999 seconds (D)
VLCROW trap_audit_level E E 0 F (D)
VLCROW trap_priority 5 5 1 10
VLCROW trap_stacksize 300 300 1 2147483647 k (Vax), 8k (Alpha)
VLCROW udp_enabled 1 1 0 1 [0,1] 1=enabled
VLCROW vms_coll_interval 10 10 0 863999999 seconds (D)
VLCROW wksp_coll_interval 10 10 1 863999999 seconds (D)
Displays summary data collection information for processes on one or more nodes.
Format
ACMSMGR SHOW PROCESS [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ALL
This qualifier displays all available application data, even data for applications
that may no longer be running. When applications are stopped, the table row
they were occupying is marked for reuse. If the row has not been reused, the
data remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/[BRIEF,FULL]
Specifies the format of the data displayed. /BRIEF is the default and displays
data in tabular format.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays the current data-collection states for all process entry
slots. Both active and inactive process data is displayed. Inactive data is flagged
with an asterisk ( * ) in the first column. The following fields are displayed:
• Server Node: The node from which the information was fetched.
• Entity Type: The ACMS entity type to which the data belongs.
• PID: The OpenVMS PID of the process.
• Process Name: The process name for the process.
• Collection States: The current collection state of the process for each
class (ID, CONFIG, RUNTIME, POOL, and ERROR). Collection states
are displayed as binary values.
0 = Collection is currently disabled.
1 = Collection is currently enabled.
Previously, the SHOW PROCESS/BRIEF and SHOW PROCESS/FULL commands
displayed all collection states for entities even when some were not applicable.
You can enable/disable collection states for all classes and all entities. However,
some combinations have no effect. These states are now shown in the SHOW
PROCESS/BRIEF display as a "-", and as "N/A" for the SHOW PROCESS/FULL
command. The display for the SHOW PROCESS command in the WEB display
has also been modified.
For Task Groups, the following classes are not applicable: CONFIG, RUNTIME,
ERROR. For Servers, the following classes are not applicable: POOL, ERROR.
Example
$ ACMSMGR SHOW PROCESS
Format
ACMSMGR SHOW QTI [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/ALL
This qualifier displays all available QTI data, including data for processes that
are no longer running. When QTI processes are stopped, the QTI table row they
were occupying is marked for reuse. If the row has not been reused, the data
remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL). Available OpenVMS process quota and SYSGEN parameter information
is only displayed when /FULL is specified.
/[CONFIG,ERROR,ID,POOL,RUNTIME]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about the QTIs on the target nodes. The
/BRIEF and /FULL qualifiers control the format of information to be displayed.
To display OpenVMS process quota and SYSGEN parameter information, use the
/FULL qualifier.
See Section 9.11 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the QTI. The Runtime Class field
indicates whether or not information is being collected for that class.
Example
$ ACMSMGR SHOW QTI /NODE=KAZONS /RUNTIME
This command displays summary run-time information for the QTI on node
KAZONS. Authorization is performed for the user specified by the logical name
ACMS$MGMT_USER, or by proxy if the logical is not defined.
Displays information about one or more ACMS application server types on one or
more nodes.
Format
ACMSMGR SHOW SERVER [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/APPL=application-name
Use this qualifer to specify a particular ACMS application to display. Wildcard
matching is performed on the name provided; use of asterisks (*) is allowed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information
to be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL).
/[CONFIG,ERROR,ID,RUNTIME]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/SERVER=server-name
This qualifier specifies a particular ACMS application server to display. Wildcard
matching is performed on the name provided; use of asterisks (*) is allowed.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about ACMS application servers on the
target node. The /BRIEF and /FULL qualifiers control the format of information
to be displayed.
See Section 9.12 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the server. The Runtime Class
field indicates whether or not information is being collected for that class.
Example
$ ACMSMGR SHOW SERVER /NODE=VLCROW /RUNTIME
Format
ACMSMGR SHOW TRAP [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays Remote Manager SNMP trap configuration information.
SNMP traps are generated only if the SNMP interface is started. Changes to this
table take effect immediately after they are processed.
See Section 9.14 for a description of each field displayed.
Example
$ ACMSMGR SHOW TRAP
This command displays SNMP traps that have been configured on the node
specified by the logical name ACMS$MGMT_SERVER_NODE. Authorization is
performed for the user specified by the logical name ACMS$MGMT_USER, or by
proxy if the logical is not defined.
Format
ACMSMGR SHOW TSC [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/ACTIVE
When specified with the /BRIEF qualifier, this qualifier causes active ACMSGEN
field values to be displayed. /ACTIVE is effective only when used with the
/CONFIG qualifier. If /BRIEF is not specified, or if /FULL is specified, this
qualifier has no effect (both active and stored values are displayed).
/ALL
This qualifier displays all available TSC data, including data for processes that
are no longer running. When TSC processes are stopped, the TSC table row they
were occupying is marked for reuse. If the row has not been reused, the data
remains available for display. This qualifier allows that data to be displayed.
Inactive rows are flagged with an asterisk ( * ) in the output.
To inhibit the display of old data, do not specify this qualifier. By default, only
data for currently running processes is displayed.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed. If no class qualifier (/CONFIG, /ERROR, /ID, /POOL, or /RUNTIME)
is specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL). Available OpenVMS process quota and SYSGEN parameter information
is only displayed when /FULL is specified.
/[CONFIG,ERROR,ID,POOL,RUNTIME]
This qualifier causes data for only the specified class to be displayed. If this
qualifier is omitted, the default is to display information for all classes.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/STORED
When specified with the /BRIEF qualifier, this qualifier causes field values from
the ACMSGEN file (not those active in memory) to be displayed. The /STORED
qualifier is effective only when used with the /CONFIG qualifier. If /BRIEF is
not specified, or if /FULL is specified, this qualifier has no effect (both active and
stored values are displayed).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about the TSCs on the target nodes. The
/BRIEF and /FULL qualifiers control the format of information to be displayed.
To display OpenVMS process quota and SYSGEN parameter information, use the
/FULL qualifier.
/ACTIVE is the default when the CONFIG class is being displayed.
See Section 9.15 for a discussion of each field displayed.
Note that some information may not be current, depending on whether the class
to which the data belongs has been enabled for the TSC. The Config Class field
indicates whether or not information is being collected for that class.
Examples
1. $ ACMSMGR SHOW TSC /NODE=VLCROW /CONFIG
This command displays all Configuration class information for the TSC on node
VLCROW. Authorization is performed for the user specified by the logical name
ACMS$MGMT_USER, or by proxy if the logical is not defined. Since neither the
/FULL nor the /BRIEF qualifier was supplied, and no specific class was selected,
all TSC information is displayed.
Displays Remote Manager user information for a server on one or more nodes.
Information about both proxy and nonproxy users is displayed.
Format
ACMSMGR SHOW USER [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/[BRIEF,FULL]
This qualifier causes detailed information about each user to be displayed. When
the qualifier is omitted, only summary information is displayed.
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command displays information about each user currently logged in to the
Remote Manager server. The following fields are displayed:
• Server Node: The node from which the information was obtained.
• Client Id: A unique identifier for each client.
• Username: The name of the local (server node) account to which the user is
logged in. This is the user name that is being used for authorization.
• Proxy: A flag indicating whether the user is logged in using an ACMS proxy.
A value of zero ( 0 ) indicates that the login is not proxy based; a value of 1
indicates that the login is proxy based.
• Login Node: The node from which the client logged in. This node may not be
the same as the server node.
If the /FULL qualifier is specified, the following additional information is
displayed:
• Credentials expiration: The date and time at which the user’s credentials will
expire.
• UIC: The UIC of the account from which the login was initiated.
• Proxy UIC: The UIC of the account on the server node that is used for
authorization.
Examples
1. $ ACMSMGR SHOW USERS
Displays the current version of ACMSMGR and its related software components.
Format
ACMSMGR SHOW VERSION [/qualifiers]
Privileges Required
ACMS$MGMT_READ
Parameters
None.
Qualifiers
/INTERVAL=interval
This qualifier causes the command to be reissued automatically at a specified
interval (in seconds). Use either Ctrl/C or Ctrl/Y to interrupt the command. If
this qualifier is not specified, the command is executed only once.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/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 11.9).
‡ This command (and its qualifiers) is only for use with systems running ACMS Version
4.4 or higher.
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 4.4.1.2 for a
discussion of proxy access.
Example
$ ACMSMGR SHOW VERSION /NODE=GOCROW
Format
ACMSMGR START EXC [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/APPLICATION=application-name
This required qualifier specifies a particular ACMS application to start. The full
application name must be specified.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/START APPL.
This command is executed synchronously. If the command completes successfully,
the application has been started on the target nodes. If not, error messages are
displayed.
Example
$ ACMSMGR START EXC/APPL=VR_APPL/NODE=SPARKS
This command starts the VR_APPL application on node SPARKS.
Starts an ACMS Queued Task Initiator (QTI) on one or more remote nodes.
Format
ACMSMGR START QTI [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/START QTI.
This command is executed synchronously. If the command completes successfully,
the application has been started on the target nodes. If not, error messages are
displayed.
Example
$ ACMSMGR START QTI/NODE=SPARKS
This command starts the QTI on node SPARKS.
Format
ACMSMGR START SYSTEM [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NOAUDIT
This qualifier starts the system with auditing disabled. If this qualifier is not
specified, the system is started with auditing enabled.
There is no "/AUDIT" qualifier to start ACMS with auditing enabled. Rather as
the notes below describe, just start ACMS without the /NOAUDIT qualifier in
order for ACMS to start with auditing enabled.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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.
/QTI
This qualifier starts the system with QTI running. If this qualifier is not
specified, the system is started with QTI in stopped state.
There is no "/NOQTI" qualifier to start ACMS with QTI stopped. Rather as the
notes below describe, just start ACMS without the /QTI qualifier in order for
ACMS to start with QTI stopped.
/NOTERMINALS
This qualifier starts the system without the TSC and CPs running. If this
qualifier is not specified, the system is started with the TSC and CPs running.
There is no "/TERMINALS" qualifier to start ACMS with the TSC and CPs
running. Rather as the notes below describe, just start ACMS without the
/NOTERMINALS qualifier in order for ACMS to start without the TSC and CPs
running.
/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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/START SYS.
This command is executed synchronously. If the command completes successfully,
the system has been started on the target nodes. If not, error messages are
displayed.
If no qualifiers are specified with this command, the equivalent ACMSOPER
command is ACMS/START SYS/NOQTI/TERMINALS/AUDIT. In other words,
the default values for the ACMSMGR START SYS command are /AUDIT,
/TERMINALS, and /NOQTI. If you want to override a default you may use
/NOAUDIT, /NOTERMINALS, or /QTI however you may not specify any of the
defaults directly. You may only select them by leaving out the qualifier and
taking the default.
Example
$ ACMSMGR START SYSTEM/NODE=SPARKS/NOTERMINALS
This command starts the ACMS run-time system on node SPARKS, without the
QTI, TSC, or CPs running.
Starts an ACMS TSC and any associated CPs on one or more remote nodes.
Format
ACMSMGR START TERMINALS [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/START
TERMINALS. This command is executed synchronously. If the command
completes successfully, the application has been started on the target nodes.
If not, error messages are displayed.
Example
$ ACMSMGR START TERMINALS/NODE=SPARKS
This command starts the TSC on node SPARKS.
This command requests the Remote Manager on the target nodes to start
the ACMS$TRACE_MON process. The ACMS$TRACE_MON process is an
intermediate process used by the Remote Manager to communicate with ACMS
run-time processes to enable and disable collections.
Format
ACMSMGR START TRACE_MONITOR [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command requests the Remote Manager to start the ACMS$TRACE_MON
process on the target node. The ACMS$TRACE_MON 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 or 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 running until the Remote
Manager shuts down.
After issuing the start 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 start during that
period, the ACMSMGR command returns an error.
Example
$ ACMSMGR START TRACE_MONITOR
This command starts the ACMS$TRACE_MON process on the node specified by
the logical name ACMS$MGMT_SERVER_NODE. Authorization is performed
for the user specified by the logical name ACMS$MGMT_USER, or based on an
ACMS proxy on the target node if the logical is not defined. If the process is
successfully started, no messages are displayed.
Format
ACMSMGR STOP EXC [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/APPLICATION=application-name
This required qualifier specifies a particular ACMS application to start. The
entire application name must be specified.
/CANCEL
This qualifier stops the application without waiting for currently executing tasks
to complete. If this qualifier is omitted, any tasks currently executing are allowed
to complete before the application is stopped.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/STOP APPL.
This command is executed synchronously. If the command completes successfully,
the application has been stopped on the target nodes. If not, error messages are
displayed.
Example
$ ACMSMGR STOP EXC/APPL=VR_APPL/NODE=SPARKS
This command stops the VR_APPL application on node SPARKS.
Format
ACMSMGR STOP MANAGER [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command requests an orderly shutdown of the Remote Manager process.
This command may take several minutes to complete if any of the interfaces is in
a noninterruptible state when the command is issued.
If the command fails to complete successfully, an alternative means of stopping
the Remote Manager is to use the DCL command STOP/ID.
The Remote Manager can be restarted only by logging in to the target node and
running the ACMS$MGMT_STARTUP command procedure.
Example
$ ACMSMGR STOP MANAGER
This command stops the Remote Manager on the node specified by the logical
name ACMS$MGMT_SERVER_NODE. Authorization is performed for the user
specified by the logical ACMS$MGMT_USER, or is based on an ACMS proxy on
the target node if the logical is not defined. If the server is successfully stopped,
no messages are displayed.
Stops an ACMS Queued Task Initiator (QTI) on one or more remote nodes.
Format
ACMSMGR STOP QTI [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/STOP QTI. This
command is executed synchronously. If the command completes successfully, the
QTI has been stopeed on the target nodes. If not, error messages are displayed.
Example
$ ACMSMGR STOP QTI/NODE=SPARKS
This command stops the QTI on node SPARKS.
Format
ACMSMGR STOP SYSTEM [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/CANCEL
This qualifier stops the ACMS run-time system without waiting for currently
executing tasks to complete. If not specified, any tasks currently executing are
allowed to complete before the application is stopped.
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/STOP SYSTEM.
This command is executed synchronously. If the command completes successfully,
the application has been stopped on the target nodes. If not, error messages are
displayed.
Example
$ ACMSMGR STOP SYS/NODE=SPARKS/CANCEL
This command stops the ACMS run-time system on node SPARKS. All currently
executing tasks, servers, and users are canceled.
Stops the TSC and any related CPs on one or more remote nodes.
Format
ACMSMGR STOP TERMINALS [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command is equivalent to the ACMSOPER command ACMS/STOP
TERMINALS. This command is executed synchronously. If the command
completes successfully, the terminal subsystem has been stopped on the target
nodes. If not, error messages are displayed.
Example
$ ACMSMGR STOP TERMINALS/NODE=SPARKS/CANCEL
This command stops the ACMS terminal subsystem on node SPARKS.
Format
ACMSMGR STOP TRACE_MONITOR [/qualifiers]
Privileges Required
ACMS$MGMT_OPER
Parameters
None.
Qualifiers
/NODE=node-name
This qualifier specifies a fully- or partially-qualified TCP/IP host name. This
name must match the current DECnet host name. IP addresses and host names
(or aliases) that exceed six characters or include mixed case are not allowed. For
more information on TCP/IP host names and defining aliases, see Section 2.2.1.
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 11.9).
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 4.4.1.2 for a
discussion of proxy access.
Notes
This command requests the Remote Manager to stop the ACMS$TRACE_MON
process on the target node. The ACMS$TRACE_MON process is an intermediate
process used by the Remote Manager to communicate with ACMS run-time
processes to enable and disable collections.
Example
$ ACMSMGR STOP TRACE_MONITOR
This command stops the ACMS$TRACE_MON process on the node specified by
the logical name ACMS$MGMT_SERVER_NODE. Authorization is performed
for the user specified by the logical name ACMS$MGMT_USER, or based on an
ACMS proxy on the target node if the logical is not defined. If the process is
successfully stopped, no messages are displayed.
EXIT Command
None None
HELP Command
None None
NEXT Command
[number] None
OPEN Command
[file-name] /AT, /CP_SLOTS, /MAX_AGENTS, /MAX_APPL, /SUMMARY
PREV Command
[number] None
QUIT Command
None None
RESET Command
None /ALL
(continued on next page)
TRACE Command
None None
Format
ACMSSNAP> CLOSE
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
Only one snapshot file can be open at a time.
Example
ACMSSNAP> CLOSE
This command closes the current data snapshot file.
Format
ACMSSNAP> EXIT
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
This command ends the current ACMSSNAP session and returns control to DCL.
It is equivalent to the QUIT command.
Example
ACMSSNAP> EXIT
This command ends the current ACMSSNAP session.
Displays help information about the ACMS Remote Manager Data Snapshot
Utility (ACMSSNAP) and its commands.
Format
ACMSSNAP> HELP
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
Online help is available for each ACMSSNAP command. Each help topic
summarizes the valid syntax, abbreviations, parameters, and qualifiers for a
particular command and also in‘dicates 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.
Example
ACMSSNAP> HELP
This command invokes online help for the ACMSSNAP utility and displays a list
of available topics.
Format
ACMSSNAP> NEXT [number]
Privileges Required
None.
Parameters
number
A numeric value that indicates the number of records to be read. If a value is not
specified, the default value of 1 record is used.
Qualifiers
None.
Notes
Use the NEXT command to move forward incrementally in a data snapshot file.
When the NEXT command is issued, the ACMSSNAP utility reads the next
record or series of records from the currently open snapshot file in chronological
order. If a number is not specified with this command, NEXT moves forward one
record at a time.
Note that the NEXT and PREV commands are not intended to be the primary
means of navigation through a data snapshot file. Use the ACMSSNAP
SHOW/AT command to first identify an approximate timeframe for the ACMS
activity that you want to view. Then use the NEXT or PREV command to move
forward or backward incrementally from that timeframe.
If tracing is turned on (TRACE command), header information is displayed for
each record read.
See Section 5.3.2.3 for more information on navigating through a data snapshot
file with ACMSSNAP.
Example
ACMSSNAP> NEXT 10
This command reads the next 10 records in the data snapshot file. These records
overlay any previous records for this entity and class.
Format
ACMSSNAP> OPEN file-name [/qualifiers]
Privileges Required
None.
Parameters
file-name
This required parameter specifies an OpenVMS file specification or logical that
indicates the name and location of the data snapshot file.
Qualifiers
/AT=time
This qualifier moves through the open data snapshot file to the first record
equal to or greater than the specified time. 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.
/CP_SLOTS=value
This qualifier reserves space for CP records in a statically-sized internal table. CP
records are stored in the table by process name. These records are not removed
from the table until the snapshot file is closed. If there is insufficient space in
the table, data for subsequent CP processes is discarded. (A warning message
is issued if the CP table becomes full and TRACE is turned on). Specifying
this qualifier overrides the value of the logical name ACMS$MGMT_SNAP_CP_
SLOTS, if defined. The default value is 3.
/MAX_AGENTS=value
This qualifier determines the number of different AGENT processes that can
be read while the file is open. AGENT data is stored internally in a statically
sized table, with one row for each unique AGENT process name found. If there is
insufficient space in the table to hold all the AGENT records in the file, AGENT
records are discarded. This qualifier overrides the ACMS$MGMT_SNAP_MAX_
AGENTS logical name, which is an alternative way of specifying this value.
Specifying this qualifier overrides the value of the logical name ACMS$MGMT_
SNAP_MAX_AGENTS, if defined. The default value is 2.
/MAX_APPLS=value
This qualifier reserves space for EXC records in a statically-sized internal table.
EXC records are stored in the table by application name. These records are not
removed from the table until the snapshot file is closed. If there is insufficient
space in the table, data for subsequent EXC processes is discarded. (A warning
message is issued if the EXC table becomes full and TRACE is turned on).
Specifying this qualifier overrides the value of the logical name ACMS$MGMT_
SNAP_MAX_APPL, if defined. The default value is 10.
/SUMMARY
This qualifier scans the entire data snapshot file and displays a summary report
that shows the total number of records written (per entity, class, and file) as well
as the time when the first and last record was written (per entity).
Notes
Data snapshot files are RMS indexed files. You can open a snapshot file with the
ACMSSNAP utility even if it is currently being written to by an ACMS Remote
Manager process.
For more information about opening and closing data snapshot files, see
Section 5.3.2.2.
Example
ACMSSNAP> OPEN ACMS$MGMT_SNAPSHOT /SUMMARY /CP_SLOTS=10 /MAX_APPL=5
ACMS Remote Management -- Snapshot utility
Compiling summary statics ...
Entity # Recs First
Record Last Record All Id Cfg
Rt Pool Error
------ ------ ---------------------- ---------------------- ---- --- --- ---
---- -----
* 0 0 0 0
0 0 0
acc 42 7-JUN-2001 14:00:56.69 7-JUN-
2001 14:21:32.19 42 0 0 0 0 0
tsc 42 7-JUN-2001 14:00:56.69 7-JUN-
2001 14:21:32.19 42 0 0 0 0 0
qti 0 0 0 0 0 0 0
cp 184 7-JUN-2001 14:00:56.69 7-JUN-
2001 14:21:32.19 184 0 0 0 0 0
exc 204 7-JUN-2001 14:01:28.01 7-JUN-
2001 14:21:32.19 204 0 0 0 0 0
server 6496 7-JUN-2001 14:01:28.01 7-JUN-
2001 14:21:32.19 6496 0 0 0 0 0
group 3032 7-JUN-2001 14:01:28.01 7-JUN-
2001 14:21:32.19 3032 0 0 0 0 0
mgr 0 0 0 0 0 0 0
10000 Records Read
MAX_APPL = 10 (use /MAX_APPL on OPEN or define ACMS$MGMT_SNAP_MAX_APPL to change)
CP_SLOTS = 10 (use /CP_SLOTS on OPEN or define ACMS$MGMT_SNAP_CP_SLOTS to change)
This command opens the data snapshot file referenced by the ACMS$MGMT_
SNAPSHOT logical, scans all the records, and displays a summary report. The
CP_SLOTS and MAX_APPLS values are explicitly set.
Format
ACMSSNAP> PREV [number]
Privileges Required
None.
Parameters
number
A numeric value that indicates the number of records to be read. If a value is not
specified, the default value of 1 record is used.
Qualifiers
None.
Notes
Use the PREV command to move backward incrementally in a data snapshot file.
When the PREV command is issued, the ACMSSNAP utility reads the previous
record or series of records from the currently open snapshot file in reverse
chronological order. If a number is not specified with this command, PREV moves
backward one record at a time.
Note that the NEXT and PREV commands are not intended to be the primary
means of navigation through a data snapshot file. Use the SHOW/AT=date-time
command to first identify an approximate timeframe for the ACMS activity that
you want to view. Then use the NEXT or PREV command to move forward or
backward incrementally from that timeframe.
If tracing is turned on (TRACE command), header information is displayed for
each record read.
See Section 5.3.2.3 for more information on navigating through a data snapshot
file with ACMSSNAP.
Example
ACMSSNAP> PREV 10
This command scans and reads the previous 10 data snapshot records. These
records overlay any previous records for this entity and class.
Format
ACMSSNAP> QUIT
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
This command ends the current ACMSSNAP session and returns control to DCL.
It is equivalent to the EXIT command.
Example
ACMSSNAP> QUIT
This command ends the current ACMSSNAP session.
Format
ACMSSNAP> RESET [/qualifiers]
Privileges Required
None.
Parameters
None.
Qualifiers
/ALL
This qualifier instructs the ACMSSNAP utility to place the file pointer at the
beginning of the data snapshot file. If this qualifier is not specified, the local
memory tables are cleared; however, the file pointer remains at the current
position within the data snapshot file.
Notes
Use the RESET command to remove all data snapshot records from internal data
tables and clear the local memory buffer.
Specifying the /ALL qualifier is equivalent to closing and reopening the data
snapshot file; the position marker is moved to the beginning of the data snapshot
file. Without the /ALL qualifier, the internal tables are cleared, but the location
of the position marker is not changed.
Example
ACMSSNAP> RESET /ALL
This command clears the local buffer of all data snapshot records and places the
position marker at the beginning of the data snapshot file.
Locates and displays information from one or more data snapshot records.
Format
ACMSSNAP> SHOW entity [/qualifiers]
Privileges Required
None.
Parameters
entity
This parameter can be one of the following ACMS entities: ACC, AGENT, CP,
EXC, GROUP, QTI, SERVER, or TSC.
Qualifiers
/APPL=application-name
This qualifier specifies the application for which you want to view information.
This qualifier is only valid when specified with the EXC, SERVER, or GROUP
entity.
/AT=time
This qualifier moves through the available data snapshot records and displays
the first record equal to or greater than the specified time. 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.
/[BRIEF,FULL]
This qualifier causes either summary (/BRIEF) or detailed (/FULL) information to
be displayed.
/[CONFIG,ID,POOL,RUNTIME]
This qualifier causes data for the class to be displayed. If no class qualifier is
specified, this qualifier is ignored and all details are displayed (equivalent to
/FULL).
/GROUP=group-name
This qualifier specifies the ACMS task group for which you want to view
information. Wildcard matching is performed on the name provided. This
qualifier is only valid when specified with the GROUP entity.
/NEXT=value
Use this qualifier to display the specified number of records (in chronological
order) for an entity. Data is displayed for each record found. If /FULL is
not specified, a timestamp that indicates when the record was created is also
displayed. A value is required with this qualifier.
/OUT=file-name
This qualifier causes output to be written to the specified file. If this qualifier is
not specified, output is displayed to the terminal (SYS$OUTPUT).
/PREV=value
Use this qualifier to display the specified number of records (in reverse
chronological order) for an entity. Data is displayed for each record found. If
/FULL is not specified, a timestamp that indicates when the record was created is
also displayed. A value is required with this qualifier.
/SERVER=server-name
This qualifier specifies the ACMS procedure server for which you want to view
information. Wildcard matching is performed on the name provided. This
qualifier is only valid when specified with the SERVER entity.
Notes
The data shown for each entity parallels the format of the equivalent ACMSMGR
command with the following exceptions:
• A timestamp is appended within square brackets to the output of /BRIEF
displays. This is provided as a navigational aid.
• The node name is derived from the translation of the UCX$INET_HOST
logical on the system the snapshot file was created. In ACMSMGR, the
node name is taken from whatever was specified by the client when the
ACMSMGR command was issued (such as from the /NODE qualifier or from
the ACMS$MGMT_SERVER_NODE logical).
Data is written to snapshot files based on entries in the Collection table. As
a result, only specific classes of information for a given entity may have been
stored. Show commands for entities and classes that were not stored may display
their default collection values along with a state value of disabled. The storage
state for the collection row must be enabled for the actual data to be stored.
The /AT qualifier is intended to be the initial means of navigation by locating a
specific entity record for a point in time. The ACMSSNAP utility uses the date
given with the /AT qualifier and reads either backwards or forwards through the
file until it finds a record for the specified entity. If the timestamp of the record is
greater than the one specified, the utility begins reading backwards through the
file until it finds an entity record with a time stamp equal to or less than the one
specified.
If end or beginning of file is reached first, the search ends and an end-of-file
message is displayed. Otherwise, the requested data is displayed. The end result
is that when the command completes, a record is shown which is either at the
exact time requested, or is the record just before or just after the time requested.
You can then use the /NEXT or /PREV qualifier to navigate chronologically
through adjacent records.
Special timestamps are used to deal with beginning and end of file conditions.
If the beginning of file is reached, the current timestamp is forced to be NULL
(17-NOV-1958 00:00:00.00). If the end of file is reached, the current timestamp is
forced to be 17-NOV-3000 00:00:00.00. To recover from these situations, a single
NEXT or PREV command will read either the first or last record in the file.
See Section 5.3.2.3 for more information on navigating through a data snapshot
file with ACMSSNAP.
Examples
1. ACMSSNAP> SHOW ACC /RUNTIME /AT="7-JUN-2001 14:21"
ACMS Remote Management -- Snapshot utility
Runtime DECnet ----- Users ----- - Applications --Application
Node Class Object Current Maximum Current Maximum Starts
------- -------- ------- ------ ------- ------- ------- ------------
sparks enabled started 97 100 5 5 5 [7-JUN-2001
14:20:31.98]
This command displays ACC runtime information for the record written on
June 7, 2001 at 14:20:31.98.
Format
ACMSSNAP> TRACE
Privileges Required
None.
Parameters
None.
Qualifiers
None.
Notes
The main function of tracing is to display the node, timestamp, entity, and class
type for the record being read. Tracing also provides some warning information
when the internal CP or EXC tables become full.
The TRACE command either turns tracing on or off, depending on the current
state. A status message is displayed when the command is issued that indicates
which action was performed.
Example
ACMSSNAP> TRACE
This command activates tracing for the current ACMSSNAP session.
This appendix contains information about the Remote Manager logical names
used by the Remote Manager server and the Remote Manager client (ACMSMGR)
and Remote Manager Data Snapshot (ACMSSNAP) utilities.
• ACMS$MGMT_ERR_LOG
File specification for the run-time error log. If not defined, the default is
ACMS$MGMT_LOG.LOG in the default directory of the Remote Manager.
• ACMS$MGMT_SERVER_NODE
Defines one or more fully- or partially-qualified TCP/IP host names.
ACMS$MGMT_SERVER_NODE determines the nodes to which the
ACMSMGR command can be submitted.
This logical can be specified as a comma-separated list of node names, in
which case an attempt is made to execute the command on each node in
the list serially. This logical name can be overridden by using the /NODE
qualifier to ACMSMGR commands.
Note
To ensure consistent handling and display of command output, the names
of TCP/IP hosts specified by this logical must match the current DECnet
host name. IP addresses and host names (or aliases) that exceed six
characters or include mixed case are not allowed. For more information
on TCP/IP host names and defining aliases, see Section 2.2.1.
• ACMS$MGMT_SNAPSHOT
Full OpenVMS file specification (node::device:[directory]filename.ext) for a data
snapshot file. If not defined, the default is ACMS$MGMT_SNAPSHOT.DAT
in the default directory of the Remote Manager.
• ACMS$MGMT_USER
Defines the user name for Remote Manager authentication and authorization.
This logical name should not be defined if proxy access is being used. If
ACMS$MGMT_USER is not defined, the ACMSMGR utility either creates a
user name (during login) or searches for the credentials file for this user. This
logical name can be overriden by using the /USER qualifier on ACMSMGR
commands.
Table B–1 lists RPC procedures and their corresponding rights identifiers.
ACMSMGMT_RESET_LOG_1 ACMS$MGMT_WRITE
ACMSMGMT_SAVE_FILTER_2 ACMS$MGMT_WRITE
ACMSMGMT_SET_ACC_2 ACMS$MGMT_OPER (+
ACMS$MGMT_SYSUPD, if updating
OpenVMS system parameter values.)
ACMSMGMT_SET_AGENT_2 ACMS$MGMT_OPER
ACMSMGMT_SET_COLLECTION_2 ACMS$MGMT_WRITE
ACMSMGMT_SET_COLLECTION_2 ACMS$MGMT_WRITE
ACMSMGMT_SET_CP_2 ACMS$MGMT_WRITE
ACMSMGMT_SET_INTERFACE_1 ACMS$MGMT_WRITE
ACMSMGMT_SET_PARAM_2 ACMS$MGMT_WRITE
ACMSMGMT_SET_QTI_2 ACMS$MGMT_OPER
ACMSMGMT_SET_SERVER_1 ACMS$MGMT_OPER
ACMSMGMT_SET_TRAP_1 ACMS$MGMT_OPER
ACMSMGMT_SET_TSC_2 ACMS$MGMT_OPER
ACMSMGMT_START_ACC_1 ACMS$MGMT_OPER
ACMSMGMT_START_EXC_1 ACMS$MGMT_OPER
ACMSMGMT_START_QTI_1 ACMS$MGMT_OPER
ACMSMGMT_START_TRACE_MONITOR_1 ACMS$MGMT_OPER
ACMSMGMT_START_TSC_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_ACC_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_EXC_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_QTI_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_TRACE_MONITOR_1 ACMS$MGMT_OPER
ACMSMGMT_STOP_TSC_1 ACMS$MGMT_OPER
This appendix contains the error messages related to the Remote Manager server
process, as well as the ACMSMGR, ACMSCFG, and ACMSSNAP utilities.
BADDAY, network access is prohibited for this day of week for this account
Explanation: This status is returned during user login if the UAF record for
this user does not allow network access on this day of the week. Day-of-week
restrictions on network access are set by system administrators or security
personnel.
User Action: Either wait until an authorized day of the week to access the
Remote Manager, or modify the network access portion of the UAF for this
user.
BADHOUR, network access is prohibited for this hour for this account
Explanation: This status is returned during user login if the UAF record for
this user does not allow network access during this time of day. Time-of-day
restrictions on network access are set by system administrators or security
personnel.
User Action: Either wait until an authorized hour to access the Remote
Manager, or modify the network access portion of the UAF for this user.
ERRBOTHFLAGS, both current and active flags were set. They are mutually
exclusive. No updates performed.
Explanation: This status is returned when a request is made to modify
Configuration data for an entity by setting both the current_flag (/CURRENT)
and active_flag (/ACTIVE) parameters. These flags are mutually exclusive;
the Remote Manager rejects the request.
User Action: Resubmit the RPC call or ACMSMGR SET command setting
only one flag per call or command.
INTERNALERR, an internal error has occurred. See audit log for details
Explanation: A request was to update the runtime ACMS system, but an
unexpected error was returned by the DCL manager subsystem.
User Action: Examine the Remote Manager log for related informational
messages. If the problem persists, restart the Remote Manager process.
NOT_VALID, entity data is stale, please resubmit query or wait until later
Explanation: The entity record in the global section is not valid. If this
status code is returned, it means that the entity has never been started on
the Remote Manager node. If the entity had been running at one time but no
longer is, a severity level of WARN is returned and the record_state is set to
INACTIVE.
User Action: No action is required. However, if the entity is started on the
Remote Manager node, the data will become available.
ACTUPDINV, /active was specified for <field>, but this value is not dynamic. No
update was performed
Explanation: An attempt was made to modify Configuration class data for
an entity using ACMSMGR SET <entity> /ACTIVE command; however, one
of the specified variables does not have an active value.
User Action: Reissue the command either without the /ACTIVE qualifier or
with only variables that have an active value. For a list of variables and their
valid values, see the ACMSMGR online help.
INACTDATA, some or all data is old and may not accurately reflect the running
system
Explanation: The data being displayed may contain information about
processes that are no longer running. Old, or stale, data is displayed only
if the /ALL qualifier was included with the command. The old records are
flagged with an asterisk (*) in the first character of the node name.
User Action: No action is required. Remove the /ALL qualifier if you do not
want to see old data.
NOCOMPND, compound name is not allowed for this entity (only server and
group).
Explanation: An attempt was made to add a collection record using a
compound name for an entity that is not a server or group. Compound
names (that is, names that contain an application specification and a process
specification) are valid for only servers and groups.
User Action: Modify the command so it does not include a compound name.
For more help about adding collection records, use the ACMSMGR HELP
ADD COLLECTION command.
OLDDATA, this data is old and may not accurately reflect the running system
Explanation: The data being displayed may contain information about
processes that are no longer running. Old, or stale, data is displayed only
if the /ALL qualifier was included with the command. The old records are
flagged with an asterisk (*) in the first character of the node name.
User Action: No action is required. Remove the /ALL qualifier if you do not
want to see old data.
STORUPDINV, /stored was specified for <field>, but this value cannot be stored.
No update was performed
Explanation: An attempt was made to modify Configuration class data for
an entity using ACMSMGR SET <entity> /STORED command; however, one
of the specified variables does not have a stored value.
User Action: Reissue the command either without the /STORED qualifier or
with only variables that have a stored value. For a list of variables and their
valid values, see the ACMSMGR online help.
WRONGPARAM, parameter type is not valid for this entity type, please correct
and reexecute command
Explanation: The parameter type in the command is not valid for the entity
type specified. Each parameter is valid for only a particular set of entity
types; the combination specified is not a valid pair.
User Action: Modify the command to include a valid combination of entity
type and parameter. To learn more about valid combinations, use the
ACMSMGR HELP command.
WRONGQUAL, qualifier <qualifier> is not supported for this verb and object,
please correct and re-execute command
Explanation: A command qualifier was specified that is not valid for the
verb/object combination specified.
User Action: Modify the command to include a valid qualifier. To learn more
about the valid qualifiers for a verb/object combination, use the ACMSMGR
HELP command.
ADDREC, record does not exist, creating new record from defaults
Explanation: This message is obsolete.
User Action: No action is required.
INVPARAMTYPE, parameter type <parameter> is not valid for this entity type,
please correct and re-execute the command
Explanation: The parameter type indicated is not valid for the entity type
specified. Each parameter is valid for only a particular set of entity types; the
combination specified is not a valid pair.
User Action: Modify the command to include a valid combination of entity
type and parameter. To learn more about valid combinations, use the
ACMSCFG HELP command.
FILEISOPEN, a file is already open. Use the CLOSE command to close the
current file
Explanation: A request was made to process an ACMS data snapshot file
that is already open. Only one file can be open at a time.
User Action: No action is required.
NOFILEOPEN, no file is open. Use the OPEN command to open a file first
Explanation: A request was made to process an ACMS data snapshot file,
but no file has been opened. A data snapshot file must be open in order for
the command to be executed.
User Action: Use the ACMSSNAP OPEN command to open the file; then
reissue the command.
Index–1
ACMSMGMT_LIST_LOG_1 procedure, 8–66 ACMSMGR commands (cont’d)
ACMSMGMT_LIST_PROC_1 procedure, 8–72 ACMSMGR SET CP, 11–46
ACMSMGMT_LIST_SERVER_1 procedure, 8–77 ACMSMGR SET EXC, 11–48
ACMSMGMT_LIST_TG_2 procedure, 8–81 ACMSMGR SET INTERFACE, 11–51
ACMSMGMT_LIST_TRAP_1 procedure, 8–85 ACMSMGR SET PARAMETER, 11–53
ACMSMGMT_LIST_USERS_1 procedure, 8–88 ACMSMGR SET QTI, 11–56
ACMSMGMT_REPLACE_SERVER_1 procedure, ACMSMGR SET SERVER, 11–59
8–94 ACMSMGR SET TRAP, 11–62
ACMSMGMT_RESET_ERR_2 procedure, 8–100 ACMSMGR SET TSC, 11–64
ACMSMGMT_RESET_LOG_1 procedure, 8–98 ACMSMGR SHOW
ACMSMGMT_SAVE_ERR_FILTER_2 procedure, example, 5–9
8–102 ACMSMGR SHOW ACC, 11–68
ACMSMGMT_SET_ACC_2 procedure, 8–106 ACMSMGR SHOW AGENT, 11–73
ACMSMGMT_SET_AGENT_2 procedure, 8–112 ACMSMGR SHOW COLLECTION, 5–6, 11–78
ACMSMGMT_SET_COLLECTION_2 procedure, ACMSMGR SHOW CP, 11–80
8–117 ACMSMGR SHOW ERROR, 5–19, 11–83
ACMSMGMT_SET_CP_2 procedure, 8–120 ACMSMGR SHOW EXC, 11–86
ACMSMGMT_SET_EXC_2 procedure, 8–123 ACMSMGR SHOW FILTER, 5–18, 11–89
ACMSMGMT_SET_INTERFACE_1 procedure, ACMSMGR SHOW GROUP, 11–91
8–128 ACMSMGR SHOW INTERFACE, 11–94
ACMSMGMT_SET_PARAM_2 procedure, 8–131 ACMSMGR SHOW LOG, 11–96
ACMSMGMT_SET_QTI_2 procedure, 8–134 ACMSMGR SHOW MANAGER, 11–101
ACMSMGMT_SET_SERVER_1 procedure, 8–140 ACMSMGR SHOW PARAMETER, 11–103
ACMSMGMT_SET_TRAP_1 procedure, 8–145 ACMSMGR SHOW PROCESS, 11–106
ACMSMGMT_SET_TSC_2 procedure, 8–148 ACMSMGR SHOW QTI, 11–109
ACMSMGMT_START_ACC_1 procedure, 8–154 ACMSMGR SHOW SERVER, 11–112
ACMSMGMT_START_EXC_1 procedure, 8–158 ACMSMGR SHOW TRAP, 11–115
ACMSMGMT_START_QTI_1 procedure, 8–162 ACMSMGR SHOW TSC, 11–117
ACMSMGMT_START_TRACE_MONITOR_1 ACMSMGR SHOW USER, 11–121
procedure, 8–166 ACMSMGR SHOW VERSION, 11–124
ACMSMGMT_START_TSC_1 procedure, 8–169 ACMSMGR START, 5–15
ACMSMGMT_STOP_1 procedure, 8–173 ACMSMGR START EXC, 11–126
ACMSMGMT_STOP_ACC_1 procedure, 8–175 ACMSMGR START QTI, 11–128
ACMSMGMT_STOP_EXC_1 procedure, 8–179 ACMSMGR START SYSTEM, 11–130
ACMSMGMT_STOP_QTI_1 procedure, 8–183 ACMSMGR START TERMINALS, 11–132
ACMSMGMT_STOP_TRACE_MONITOR_1 ACMSMGR START TRACE_MONITOR,
procedure, 8–187 11–134
ACMSMGMT_STOP_TSC_1 procedure, 8–190 ACMSMGR STOP, 5–15
ACMSMGR commands ACMSMGR STOP EXC, 11–136
ACMSMGR ADD COLLECTION, 11–7 ACMSMGR STOP MANAGER, 11–138
ACMSMGR ADD FILTER, 5–18, 11–11 ACMSMGR STOP QTI, 11–140
ACMSMGR ADD TRAP, 11–13 ACMSMGR STOP SYSTEM, 11–142
ACMSMGR DELETE COLLECTION, 5–6, ACMSMGR STOP TERMINALS, 11–144
11–16 ACMSMGR STOP TRACE_MONITOR, 11–146
ACMSMGR DELETE FILTER, 5–19, 11–18 format, 11–1
ACMSMGR DELETE TRAP, 11–20 objects, 11–2
ACMSMGR HELP, 11–22 qualifiers, 11–2
ACMSMGR LOGIN, 11–23 verbs, 11–1
ACMSMGR LOGOUT, 11–25 ACMSMGR utility
ACMSMGR REPLACE SERVER, 11–27 functions, 11–1
ACMSMGR RESET ERROR, 5–19, 11–29 hangs, 2–23
ACMSMGR RESET LOG, 11–31 logical names, A–1
ACMSMGR SAVE FILTER, 5–19, 11–33 modifying ACMS run-time, 5–15
ACMSMGR SET, 5–15 modifying parameters, 4–10
example, 5–15 NOCLNT_ATTACH messages, 2–23
ACMSMGR SET ACC, 11–35 problems, 2–23
ACMSMGR SET AGENT, 11–40 starting interfaces, 4–9
ACMSMGR SET COLLECTION, 5–6, 11–42 stopping interfaces, 4–9
Index–2
ACMSMGR utility (cont’d) Class (cont’d)
using, 2–17 pool, 5–3
using to start collection, 5–5 run-time, 5–3
using to start data snapshots, 5–8 wildcard (*), 5–3
ACMS postinstallation procedure Client authentication, 4–5
See Postinstallation procedure Client node
ACMS proxies, 2–17 definition, 2–1
ACMS run-time system, 5–16 setup, 2–4
modifying, 5–15 Client programs
ACMSSNAP commands, 12–4 phases
ACMSSNAP CLOSE, 5–10, 12–4 initialization, 6–4
ACMSSNAP EXIT, 5–10, 12–5 processing, 6–4
ACMSSNAP HELP, 12–6 termination, 6–4
ACMSSNAP NEXT, 12–7 Clnt_create function, 6–4
ACMSSNAP OPEN, 5–10, 12–8 Collection classes
ACMSSNAP PREV, 12–10 table, 8–1
ACMSSNAP QUIT, 12–11 Collections
ACMSSNAP RESET, 12–12 displaying
ACMSSNAP SHOW, 5–10, 12–13 using ACMSMGR SHOW command, 5–9
ACMSSNAP TRACE, 12–17 using ACMSSNAP utility, 5–9
format, 12–1 saving
objects, 12–2 using ACMSCFG utility, 5–8
qualifiers, 12–2 using ACMSMGR utility, 5–8
verbs, 12–1 using SNMP, 5–9
ACMSSNAP utility starting
how to run, 5–10 using ACMSCFG utility, 5–5
logical names, A–2 using ACMSMGR utility, 5–5
overview, 12–1 using SNMP, 5–6
ACMS_POST_INSTALL.COM procedure, 2–4 Collection table, 9–21
Active variable, 5–14 accessing, 5–4
Add procedures, 6–14 fields, 9–21 to 9–23
example, 6–14 purpose, 5–1
table, 6–14 specifying data, 5–1
Agent table, 9–12 Common RPC fields, 8–1
fields, 9–15 to 9–20 Configuration class, 5–2
Architecture, 1–1 Configuration file
illustration, 1–1 reviewing, 2–15
Audit levels updating, 2–15
parameters, 4–10 Controlling data collection, 5–1
setting, 4–10 CP table, 9–23
values, 4–11 fields, 9–26 to 9–30
Audit messages, 4–12 Credentials
Authentication, 6–4 creating, 6–5
client, 4–5
explicit, 6–4 D
implicit, 6–4
Data collection, 5–1
Authorization, 4–7
dynamic, 5–1
Authunix_create_default function, 6–5
static, 5–1
Data collection state, 5–4
C Data snapshots, 5–6
starting
Callable procedures, 6–3
using ACMSCFG, 5–8
Capabilities, 1–3
using ACMSMGR, 5–8
Class, 5–2
using SNMP, 5–9
configuration, 5–2
Data types
definition, 5–1
DisplayString, 7–5
error, 5–3
gauge, 7–5
identification, 5–2
Index–3
Data types (cont’d)
integer, 7–5
mapping, 7–5 H
SNMP INTEGER, 7–5 Hang, 2–22
string, 7–5
supported, 7–5
Debug tracing, 7–11
I
starting, 7–11 Identification class, 5–2
stopping, 7–12 Identity validation, 7–4
Defining symbols, 2–5 IDL, 6–2
Delete procedures, 6–13 support, 6–2
example, 6–13 Implicit authentication, 6–4
table, 6–13 Initialization, 6–4
Displaying audit messages, 4–12 example, 6–5
Displaying error messages, 5–19 Interface Definition Language
DisplayString data type, 7–5 See IDL
Dynamic tables, 7–6 Interfaces
controlling, 4–8
E ONC RPC, 6–1
SNMP, 6–1
Enable states Interfaces table, 9–40
table, 8–2 fields, 9–41 to 9–42
Entity Interface types
definition, 5–1 table, 8–2
valid types, 5–2
Entity types
table, 8–2 L
Error class, 5–3 Linked list
Error filters illustration, 6–9
setting, 5–17 Linked lists
Error Filter table, 9–30 example, 6–8
fields, 9–31 List procedures, 6–7
Error log, 5–17 limitations, 6–7
Error messages, 2–21 to 2–23, 5–19 table, 6–7
eSNMP return codes, 7–12 Log entries
EVENT_SEVERITY trap parameter, 7–10 Remote Manager, 2–21
EXC table, 9–31 Log file
fields, 9–34 to 9–40 viewing, 2–4
EXISTS trap parameter, 7–10 Logging in, 4–6
Explicit authentication, 6–4 Logical names
ACMS$MGMT_ALLOW_PROXY_ACCESS,
F A–1
ACMS$MGMT_CONFIG, A–1
Facility types ACMS$MGMT_CREDS_DIR, A–1
table, 8–3 ACMS$MGMT_DISABLED, A–1
ACMS$MGMT_ERR_LOG, A–1
G ACMS$MGMT_LOG, A–1
ACMS$MGMT_SERVER_NODE, A–2
Gauge data type, 7–5
ACMS$MGMT_SNAPSHOT, A–2
Get procedures, 6–6
ACMS$MGMT_SNAP_CP_SLOTS, A–2
example, 6–6
ACMS$MGMT_SNAP_MAX_AGENTS, A–2
table, 6–6
ACMS$MGMT_SNAP_MAX_APPL, A–2
Get requests, 7–8
ACMS$MGMT_TEMP, A–1
ACMS$MGMT_USER, A–2
Index–4
procmon: f : error, 2–21
Protocols, 1–1
M Proxy accounts, 2–17, 4–7
Management Proxy files
overview, 4–1 creating, 2–17
Management APIs, 8–1
Management information base
See MIB
Q
Manager Status table, 9–42 QTI table, 9–49
fields, 9–42 fields, 9–51 to 9–54
mgr: f: error, 2–21
MIB, 7–1 R
tables, 7–4
Modifying class variables, 5–15 Read access, 4–7
mrg: f: error, 2–21 Remote Manager
ACC table, 9–3
Agent table, 9–12
N capabilities, 1–3
Name collection classes, 8–1
definition, 5–1 Collection table, 9–21
communications, 2–5, 2–17
compatibility, 9–1, 10–1, 11–1, 12–1
O CP table, 9–23
Object identifiers data types, 7–5, 9–2
See OIDs enable states, 8–2
OIDs, 7–2 entity types, 8–2
ONC RPC, 6–1 Error Filter table, 9–30
callable procedures, 6–3 eSNMP return codes, 7–12
illustration, 6–1 EXC table, 9–31
management APIs, 8–1 facility types, 8–3
overview, 6–1 getting started, 2–1 to 2–24
programming, 6–2 hanging during startup, 2–22
interfaces, 6–1
Open Network Computing Remote Procedure Call
symbolic names, 8–2
See ONC RPC Interfaces table, 9–40
Operate access, 4–7 maintaining, 6–1
Manager Status table, 9–42
P managing, 4–1 to 4–13
Parameter table, 9–43
Parameter table, 9–43
problems starting, 2–20
fields, 9–45 to 9–48
programming model, 6–4
PATROL, 7–1
QTI table, 9–49
Pool class, 5–3
reference tables, 9–1
Portmapper
running states, 8–3
configuration
Server table, 9–54
determining, 2–8
setup, 2–13
removing, 2–8
severity codes, 8–3
enabling, 2–3
shutdown, 4–5
setting up, 2–7
starting, 2–3, 2–16, 4–4
verifying, 2–2 to 2–3
startup, 4–1
Postinstallation procedures, 2–3
troubleshooting, 2–19
how to run, 2–4
stopping, 4–4
Processing, 6–4
Task Group table, 9–56
Process logicals
trap parameters, 8–4
defining, 2–3, 2–15
Trap table, 9–58
procmon: e : error, 2–21
troubleshooting, 2–20
TSC table, 9–62
Users table, 9–67
Index–5
Remote Manager (cont’d) RPC calls (cont’d)
using to make ACMS changes, 5–14 ACMSMGMT_SET_SERVER_1, 8–140
web agent, 3–1 ACMSMGMT_SET_TRAP_1, 8–145
Remote Manager log, 4–10 ACMSMGMT_SET_TSC_2, 8–148
Remote Manager log entries, 2–21 ACMSMGMT_START_ACC_1, 8–154
Remote Manager log file ACMSMGMT_START_EXC_1, 8–158
managing, 4–10 ACMSMGMT_START_MONITOR_1, 8–166
Remote Manager server ACMSMGMT_START_QTI_1, 8–162
logical names, A–1 ACMSMGMT_START_TSC_1, 8–169
Remote Manager web agent ACMSMGMT_STOP_1, 8–173
See Web agent ACMSMGMT_STOP_ACC_1, 8–175
ACMSMGMT_STOP_EXC_1, 8–179
Remote Procedure Calls
ACMSMGMT_STOP_QTI_1, 8–183
See RPC calls
ACMSMGMT_STOP_TRACE_MONITOR_1,
Replace procedures, 6–15
8–187
Resetting error log, 5–19
ACMSMGMT_STOP_TSC_1, 8–190
Resetting log, 4–13
RPC fields, 8–1
Rights identifiers, B–1
RPC interface
rpc: f : error, 2–22
modifying class parameters, 5–17
RPC calls, 8–5
RPC procedures
ACMSMGMT_ADD_COLLECTION_2, 8–5
rights identifiers, B–1
ACMSMGMT_ADD_ERR_FILTER_2, 8–8
Running states
ACMSMGMT_ADD_TRAP_1, 8–11
table, 8–3
ACMSMGMT_DELETE_COLLECTION_1,
Run-time class, 5–3
8–14
ACMSMGMT_DELETE_ERR_FILTER_2, 8–17
ACMSMGMT_DELETE_TRAP_1, 8–19 S
ACMSMGMT_GET_ACC_2, 8–22 Saving data collections, 5–6
ACMSMGMT_GET_ERR_FILTER_2, 8–27 sec: e : error, 2–22
ACMSMGMT_GET_MGR_STATUS_1, 8–30 sec: e: error, 2–22
ACMSMGMT_GET_PARAM_2, 8–33 sec: f : error, 2–22
ACMSMGMT_GET_QTI_2, 8–35 Server group tables, 7–7
ACMSMGMT_GET_TSC_2, 8–37 Server node
ACMSMGMT_GET_VERSION_2, 8–39 definition, 2–1
ACMSMGMT_LIST_AGENT_2, 8–41 setup, 2–2
ACMSMGMT_LIST_COLLECTIONS_2, 8–45 Server table, 9–54
ACMSMGMT_LIST_CP_2, 8–49 fields, 9–55 to 9–56
ACMSMGMT_LIST_ERR_2, 8–53 Set procedures, 6–11
ACMSMGMT_LIST_EXC_2, 8–59 example, 6–12
ACMSMGMT_LIST_INTERFACES_1, 8–63 table, 6–11
ACMSMGMT_LIST_LOG_1, 8–66 Set requests, 7–8
ACMSMGMT_LIST_PROC_1, 8–72 Setting audit levels, 4–10
ACMSMGMT_LIST_SERVER_1, 8–77 Setting error filters, 5–17
ACMSMGMT_LIST_TG_2, 8–81 Severity codes
ACMSMGMT_LIST_TRAP_1, 8–85 table, 8–3
ACMSMGMT_LIST_USERS_1, 8–88 Shutdown, 4–5
ACMSMGMT_REPLACE_SERVER_1, 8–94 Single-row tables, 7–5
ACMSMGMT_RESET_ERR_2, 8–100 SNMP, 6–1
ACMSMGMT_RESET_LOG_1, 8–98 accessing MIB, 7–1
ACMSMGMT_SAVE_ERR_FILTER_2, 8–102 communities, 7–3
ACMSMGMT_SET_ACC_2, 8–106 configuration, 2–11
ACMSMGMT_SET_AGENT_2, 8–112 determining, 2–10
ACMSMGMT_SET_COLLECTION_2, 8–117 removing, 2–10
ACMSMGMT_SET_CP_2, 8–120 debug tracing, 7–11
ACMSMGMT_SET_EXC_2, 8–123 starting, 7–11
ACMSMGMT_SET_INTERFACE_1, 8–128 stopping, 7–12
ACMSMGMT_SET_PARAM_2, 8–131 get requests, 7–8
ACMSMGMT_SET_QTI_2, 8–134 illustration, 7–1
Index–6
SNMP (cont’d) Trap, 7–9
initializing, 7–3 to 7–4 parameters, 7–10, 8–4
OIDs, 7–2 EVENT_SEVERITY, 7–10
overview, 7–1 EXISTS, 7–10
security, 7–2 Trap maximums, 9–60
set requests, 7–8 Trap minimums, 9–60
setup, 2–9 Trap table, 9–58
starting ACMS processes, 5–16 fields, 9–59 to 9–60
stopping ACMS processes, 5–16 Troubleshooting, 2–20
tables, 7–4 TSC table, 9–62
testing, 2–12 fields, 9–64 to 9–67
traps, 7–9
using to delete rows, 5–16
using to modify ACMS run-time system, 5–16 U
using to save collections, 5–9 Update access, 4–8
using to start collections, 5–6 Users table, 9–68
using to start entities, 7–9 fields, 9–68 to 9–69
using to stop entities, 7–9 Using proxy accounts, 2–17
writing your own, 7–1
snmp: e: error, 2–22
snmp: f : error, 2–22 V
snmp: w : error, 2–22, 2–23 Variables
SNMP get requests, 7–8 active, 5–14
SNMP INTEGER data type, 7–5 Configuration class, 5–13
SNMP set requests, 7–8 stored, 5–13
Starting ACMS entities, 7–9
Start procedures, 6–15
example, 6–16
W
Startup, 4–1, 4–4 Web agent
State validation, 7–4 accessing the web page, 3–5
Static tables, 7–5 customizing the display, 3–7
Stopping ACMS entities, 7–9 issuing commands, 3–8
Stop procedures, 6–15 reporting problems, 3–12
Stored variable, 5–13 selecting a host, 3–8
Supported protocols, 1–1 setting up, 3–2
Symbols starting, 3–5
defining, 2–15 stopping, 3–5
troubleshooting problems, 3–12
Wildcard (*), 5–3
T Wildcards
Tables example, 5–3, 5–4
dynamic, 7–6 Write access, 4–8
server group, 7–7
single-row, 7–5
static, 7–5
task group, 7–7
Task Group table, 7–7, 9–56
fields, 9–57 to 9–58
TCP/IP alias
defining, 2–7
TCP/IP hosts
name restriction, 2–7
TCP/IP setup, 2–6
TCP/IP support, 2–2
Temporary command procedures, 5–14
Termination, 6–4
Index–7