QUERY STATUS (Query system parameters)
Use the QUERY STATUS command to display information about system parameters.
Use this command for the following reasons:
- To display the service level of the server
- To display information about the general server parameters, such as those defined by the SET commands
- To request information about client sessions, such as the availability of the server, password authentication, accounting settings, or the retention period for the information that is retained in the activity log
- To display information about the central scheduler, such as the central scheduling mode of the server
- To display the maximum number of repeated attempts that are allowed after a failed attempt to run a scheduled command
- To display whether subfiles can be backed up to this server, as indicated by the SET SUBFILE command
- To display information about a target replication server
- To display licensing information
Tip: To display information about a target replication
server, you must issue the command from the target replication server.
Privilege class
Any administrator can issue this command.
Syntax
Parameters
None.
Example: Query the status of a configuration manager
Display general information about server parameters. The command is run from a configuration manager. For descriptions of displayed fields, see Field descriptions.query status
Server Name: SETSHOT
Server host name or IP address: setshot
Server TCP/IP port number: 1500
Crossdefine: On
Server Password Set: Yes
Server Installation Date/Time: 2016-07-08, 09:45:53
Server Restart Date/Time: 2016-10-10, 05:38:49
Authentication: Off
Password Expiration Period: 9,999 Day(s)
Invalid Sign-on Attempt Limit: 0
Minimum Password Length: 8
Registration: Closed
Subfile Backup: Client
Availability: Enabled
Inbound Sessions Disabled:
Outbound Sessions Disabled:
Accounting: Off
Activity Log Retention: 30 Day(s)
Activity Log Number of Records: 222919
Activity Log Size: 6 M
Activity Summary Retention Period: 30 Day(s)
License Audit Period: 30 Day(s)
Last License Audit: 2016-10-21, 07:40:20
Server License Compliance: Valid
Central Scheduler: Active
Maximum Sessions: 300
Maximum Scheduled Sessions: 75
Event Record Retention Period: 14 Day(s)
Client Action Duration: 5 Day(s)
Schedule Randomization Percentage: 25
Query Schedule Period: Client
Maximum Command Retries: Client
Retry Period: Client
Client-side Deduplication Verification Level: 0 %
Scheduling Modes: Any
Active Receivers: CONSOLE ACTLOG
Configuration manager?: Off
Refresh interval: 60
Last refresh date/time:
Context Messaging: On
Table of Contents (TOC) Load Retention: 120 Minute(s)
Machine Globally Unique ID: d4.cg.f6.ae.04.6e.11.e3.80.1f.00.21.5e.18.df.01
Archive Retention Protection: Off
Database Directories: /TSMserver/DB1,/TSMserver/DB2
Total Space of File System (MB): 222,720.00
Used Space on File System (MB): 47,780.74
Free Space Available (MB): 174,939.26
Encryption Strength: AES
Client CPU Information Refresh Interval: 180
Outbound Replication: Enabled
Target Replication Server: POWER
Default Replication Rule for Archive: ALL_DATA
Default Replication Rule for Backup: ALL_DATA
Default Replication Rule for Space Management: ALL_DATA
Replication Record Retention Period: 30 Day(s)
LDAP User:
LDAP Password Set: No
Default Authentication: Local
Failover High Level Address:
Scratchpad retention: 365 Day(s)
Replication Recovery of Damaged Files: On
SUR Occupancy (TB): 5.66
SUR Retention Occupancy (TB): 0
SUR Occupancy Date/Time: 2016-10-10, 05:39:33
Front-End Capacity (MB): 226,331
Front-End Client Count: 6
Front-End Capacity Date: 2016-10-13, 09:20:02
Product Offering: IBM Spectrum Protect
Command Approval: On
Approver Administrators Require Approval: On
Server Name: GOBI
Server host name or IP address:
Server TCP/IP port number: 1500
Crossdefine: On
Server Password Set: Yes
Server Installation Date/Time: 2016-07-08, 11:29:03
Server Restart Date/Time: 2016-11-10, 14:25:03
Authentication: On
Password Expiration Period: 90 Day(s)
Invalid Sign-on Attempt Limit: 0
Minimum Password Length: 8
Registration: Closed
Subfile Backup: No
Availability: Enabled
Inbound Sessions Disabled:
Outbound Sessions Disabled:
Accounting: Off
Activity Log Retention: 30 Day(s)
Activity Log Number of Records: 21346
Activity Log Size: <1 M
Activity Summary Retention Period: 30 Day(s)
License Audit Period: 30 Day(s)
Last License Audit: 2016-10-21, 23:27:23
Server License Compliance: Valid
Central Scheduler: Active
Maximum Sessions: 500
Maximum Scheduled Sessions: 250
Event Record Retention Period: 14 Day(s)
Client Action Duration: 5 Day(s)
Schedule Randomization Percentage: 25
Query Schedule Period: Client
Maximum Command Retries: Client
Retry Period: Client
Client-side Deduplication Verification Level: 0 %
Scheduling Modes: Any
Active Receivers: CONSOLE ACTLOG
Configuration manager?: Off
Refresh interval: 60
Last refresh date/time:
Context Messaging: Off
Table of Contents (TOC) Load Retention: 120 Minute(s)
Machine Globally Unique ID: fc.e7.be.58.4a.a7.11.e0.8a.c8.e4.1f.13.34.11.e0
Archive Retention Protection: Off
Database Directories: /TSMdbspace1/gpcinst1,/TSMdbspace2/gpcinst1,/TSMdbspace3/gpcinst1
Total Space of File System (MB): 302,379.84
Used Space on File System (MB): 106,793.65
Free Space Available (MB): 195,586.20
Encryption Strength: AES
Client CPU Information Refresh Interval: 180
Outbound Replication: Enabled
Target Replication Server:
Default Replication Rule for Archive: ALL_DATA
Default Replication Rule for Backup: ALL_DATA
Default Replication Rule for Space Management: ALL_DATA
Replication Record Retention Period: 30 Day(s)
LDAP User:
LDAP Password Set: No
Default Authentication: Local
Failover High Level Address:
Scratchpad retention: 365 Day(s)
Replication Recovery of Damaged Files: Off
SUR Occupancy (TB): 0.00
SUR Retention Occupancy (TB): 0
SUR Occupancy Date/Time: 2016-10-10, 14:25:35
Front-End Capacity (MB): 226,331
Front-End Client Count: 6
Front-End Capacity Date: 2016-10-13, 09:20:02
Product Offering: IBM Spectrum Protect
Command Approval: On
Approver Administrators Require Approval: On
Server Name: EXCELSIOR
Server host name or IP address: excelsior.storage.
newyork.example.com
Server TCP/IP port number: 1500
Crossdefine: On
Server Password Set: Yes
Server Installation Date/Time: 2016-07-08, 18:02:50
Server Restart Date/Time: 2016-11-10, 11:48:32
Authentication: On
Password Expiration Period: 90 Day(s)
Invalid Sign-on Attempt Limit: 0
Minimum Password Length: 8
Registration: Closed
Subfile Backup: No
Availability: Enabled
Inbound Sessions Disabled:
Outbound Sessions Disabled:
Accounting: On
Activity Log Retention: 30 Day(s)
Activity Log Number of Records: 1346376
Activity Log Size: 37 M
Activity Summary Retention Period: 30 Day(s)
License Audit Period: 30 Day(s)
Last License Audit: 2016-10-21, 17:05:16
Server License Compliance: Valid
Central Scheduler: Active
Maximum Sessions: 25
Maximum Scheduled Sessions: 12
Event Record Retention Period: 14 Day(s)
Client Action Duration: 5 Day(s)
Schedule Randomization Percentage: 25
Query Schedule Period: Client
Maximum Command Retries: Client
Retry Period: Client
Client-side Deduplication Verification Level: 0 %
Scheduling Modes: Any
Active Receivers: CONSOLE ACTLOG
NTEVENTLOG
Configuration manager?: Off
Refresh interval: 60
Last refresh date/time:
Context Messaging: Off
Table of Contents (TOC) Load Retention: 120 Minute(s)
Machine Globally Unique ID: e9.3e.f1.70.ff.c5.11.e2.
a5.67.5c.f3.fc.0c.5e.60
Archive Retention Protection: Off
Database Directories: e:\Server1\TSMDBdir
Total Space of File System (MB): 102,270.00
Used Space on File System (MB): 22,032.79
Free Space Available (MB): 80,237.20
Encryption Strength: AES
Client CPU Information Refresh Interval: 180
Outbound Replication: Enabled
Target Replication Server: EXPLORER
Default Replication Rule for Archive: ALL_DATA
Default Replication Rule for Backup: ALL_DATA
Default Replication Rule for Space Management: ALL_DATA
Replication Record Retention Period: 30 Day(s)
LDAP User: cn=excelsior_ldapadmin,ou=excelsior,
ou=John Doe,dc=tsmadldap,dc=storage,
dc=newyork, dc=example,dc=com
LDAP Password Set: Yes
Default Authentication: LDAP
Failover High Level Address:
Scratchpad retention: 365 Day(s)
Replication Recovery of Damaged Files: On
SUR Occupancy (TB): 8.98
SUR Retention Occupancy (TB): 0
SUR Occupancy Date/Time: 2016-10-10, 11:49:27
Front-End Capacity (MB): 226,331
Front-End Client Count: 6
Front-End Capacity Date: 2016-10-13, 09:20:02
Product Offering: IBM Spectrum Protect
Command Approval: On
Approver Administrators Require Approval: OnField descriptions
- Server Name
- Specifies the name of the server.
- Server host name or IP address
- Specifies the server TCP/IP address.
- Server TCP/IP port number
- Specifies the server port address.
- Crossdefine
- Specifies whether another server that is running the DEFINE SERVER command automatically defines itself to this server. See the SET CROSSDEFINE command.
- Server Password Set
- Specifies whether the password was set for the server.
- Server Installation Date/Time
- Specifies the date and time when the server was installed.
- Server Restart Date/Time
- Specifies the last date and time when the server was started.
- Authentication
- Specifies whether password authentication is set on or off.
- Password Expiration Period
- Specifies the period, in days, after which the administrator or client node password expires.
- Invalid Sign-on Attempt Limit
- Specifies the number of invalid sign-on attempts before a node is locked.
- Minimum Password Length
- Specifies the minimum number of characters for the password. This value does not apply to configurations where an LDAP server is used.
- Registration
- Specifies whether client node registration is open or closed.
- Subfile Backup
- Specifies whether subfiles can be backed up to this server, as indicated by the SET SUBFILE command.
- Availability
- Specifies whether the server is enabled or disabled.
- Inbound Sessions Disabled
- Specifies the names of servers from which server-to-server communications are not allowed. To enable inbound server sessions, use the ENABLE SESSIONS command.
- Outbound Sessions Disabled
- Specifies the names of servers to which server-to-server communications are not allowed. To enable outbound server sessions, use the ENABLE SESSIONS command.
- Accounting
- Specifies whether an accounting record is generated at the end of each client node session.
- Activity Log Retention
- Specifies the number of days information is retained in the activity log, or the size of the log.
- Activity Log Number of Records
- Specifies the number of records in the activity log.
- Activity Log Size
- Specifies the size of the activity log.
- Activity Summary Retention Period
- Specifies the number of days information is retained in the SQL activity summary table.
- License Audit Period
- Specifies the period, in days, after which the license manager automatically audits the IBM Spectrum® Protect license. Additional licensing information is available by using the QUERY LICENSE command.
- Last License Audit
- Specifies the date and time when the last license audit occurred. Additional licensing information is available by using the QUERY LICENSE command.
- Server License Compliance
- Specifies whether the server is in compliance (Valid) or out of compliance (Failed) with the license terms. Use the QUERY LICENSE command to see what factors are causing the server to fail to comply with the license terms.
- Central Scheduler
- Specifies whether central scheduling is running (active or inactive).
- Maximum Sessions
- Specifies the maximum number of client/server sessions.
- Maximum Scheduled Sessions
- Specifies the maximum number of client/server sessions available for processing scheduled work.
- Event Record Retention Period
- Specifies the number of days central scheduler event records are retained.
- Client Action Duration
- Specifies the duration of the period during which the client processes the schedule that is defined with the DEFINE CLIENTACTION command.
- Schedule Randomization Percentage
- Specifies how much of the startup window is used for running scheduled events in client-polling mode.
- Query Schedule Period
- Specifies the frequency with which clients poll the server to obtain scheduled work, in client-polling mode. If the value in this field is Client, the polling frequency is determined by the client node.
- Maximum Command Retries
- Specifies the maximum number of times that a client scheduler tries to run a scheduled command after a failed attempt. If the value in this field is Client, the client node determines the maximum number.
- Retry Period
- Specifies the number of minutes between failed attempts by the client scheduler to contact the server or to run a scheduled command. If the value in this field is Client, the client node determines the number of minutes.
- Client-side Deduplication Verification Level
- Specifies a percentage of extents to be verified by the IBM Spectrum Protect server. The extents are created during client-side data deduplication.
- Scheduling Modes
- Specifies the central scheduling modes that are supported by the server.
- Active Receivers
- Specifies the receivers for which event logging began.
- Configuration manager?
- Specifies whether the server is a configuration manager.
- Refresh interval
- Specifies the interval that elapses before the managed server requests a refresh of any changes from a configuration manager.
- Last refresh date/time
- If the server is a managed server, specifies the date and time of the last successful refresh of configuration information from the configuration manager.
- Context Messaging
- Specifies whether context messaging is enabled or disabled.
- Table of Contents (TOC) Load Retention
- Specifies the approximate number of minutes that unreferenced TOC data is retained in the database.
- Machine Globally Unique ID
- The globally unique identifier (GUID) as of the last time that the server was started. This GUID identifies the host system to which the current server belongs.
- Archive Retention Protection
- Specifies whether archive data retention protection is activated or deactivated.
- Database Directories
- Specifies the locations of the database directories.
- Total Space of File System (MB)
- Specifies the total size of the file system.
- Used Space on File System (MB)
- Specifies the amount of space that is in use on the file system.
- Free Space Available (MB)
- Specifies the amount of space that is available.
- Encryption Strength
- Indicates data encryption strength: AES or DES.
- Client CPU Information Refresh Interval
- Specifies the number of days that elapse between client scans for CPU information that is used for PVU estimation.
- Outbound Replication
- Specifies whether replication processing is enabled or disabled. If outbound replication is disabled, new replication processes cannot start on the server.
- Target Replication Server
- Specifies the name of the server that is the target for node replication operations. If a target replication server does not exist, this field is blank.
- Default Replication Rule for Archive
- Specifies the server replication rule that applies to archive data. The following values are possible:
- ALL_DATA
- Replicates archive data. The data is replicated with a normal priority.
- ALL_DATA_HIGH_PRIORITY
- Replicates archive data. The data is replicated with a high priority.
- NONE
- Archive data is not replicated.
- Default Replication Rule for Backup
- Specifies the server replication rule that applies to backup data. The following values are possible:
- ALL_DATA
- Replicates active and inactive backup data. The data is replicated with a normal priority.
- ACTIVE_DATA
- Replicates only active backup data. The data is replicated with a normal priority.Attention: If you specify ACTIVE_DATA and one or more of the following conditions are true, inactive backup data on the target replication server is deleted, and inactive backup data on the source replication server is not replicated.
- When a server version earlier than Version 7.1.1 is installed on either the source or target replication servers.
- When you are using the REPLICATE NODE command with the
FORCERECONCILE=YESparameter. - When you are running the initial replication of a file space after you configure replication, restore the database, or upgrade both the source and target replication servers from a server version earlier than V7.1.1.
- ALL_DATA_HIGH_PRIORITY
- Replicates active and inactive backup data. The data is replicated with a high priority.
- ACTIVE_DATA_HIGH_PRIORITY
-
This rule is the same as the ACTIVE_DATA replication rule except data is replicated with a high priority.
- NONE
- Backup data is not replicated.
- Default Replication Rule for Space Management
- Specifies the server replication rule that applies to space-managed data. The following values
are possible:
- ALL_DATA
- Replicates space-managed data. The data is replicated with a normal priority.
- ALL_DATA_HIGH_PRIORITY
- Replicates space-managed data. The data is replicated with a high priority.
- NONE
- Space-managed data is not replicated.
- Replication Record Retention Period
- Specifies the number of days that replication history records are retained in the database of the source replication server.
- LDAP User
- Specifies the user ID that is named in the SET LDAPUSER command. This user ID can issue administrative commands on the namespace that is reserved for IBM Spectrum Protect on the LDAP directory server.
- LDAP Password Set
- This output field shows if a password is defined for the user ID that is named in the SET LDAPUSER command. The values are YES and NO. If YES, the user ID that is named in the SET LDAPUSER command can issue administrative commands on the LDAP namespace that is reserved for IBM Spectrum Protect. If NO, issue the SET LDAPPASSWORD command to set the password for the user ID that is named in the SET LDAPUSER command.
- Default Authentication
- Specifies the default password authentication method: LOCAL or LDAP.
When you issue the SET DEFAULTAUTHENTICATION command, you define the resulting authentication method for all REGISTER ADMIN and REGISTER NODE commands. The default is LOCAL.
Authentication Target Authentication Method IBM Spectrum Protect server LOCAL LDAP directory server LDAP - Failover High Level Address
- Specifies the high-level address for the failover server that is used by the client. Client restore operations fail over to this high-level address when the interface that is used by the client is different from the interface that is used by replication.
- Scratchpad retention
- Specifies the number of days for which scratch pad entries are retained since they were last updated.
- Replication Recovery of Damaged Files
- Specifies whether node replication is enabled to recover damaged files from a target replication server. This is a system-side setting. If ON is specified, the node replication process can be configured to detect damaged files on a source replication server and replace them with undamaged files from a target replication server. If OFF is specified, damaged files are not recovered from a target replication server.
- SUR Occupancy (TB)
- If you have an IBM Spectrum Protect Suite (SUR) license, this field specifies the SUR occupancy on the server. The SUR occupancy is the amount of space that is used to store data that is managed by the IBM Spectrum Protect products that are included in the SUR bundle.
- SUR Retention Occupancy (TB)
- If you have an IBM Spectrum Protect Suite (SUR) license, this field specifies the SUR occupancy on the server that is used for long-term data retention only. The SUR retention occupancy is the amount of space that is used to store data for long-term retention that is managed by the IBM Spectrum Protect products that are included in the SUR bundle.
- SUR Occupancy Date/Time
- Specifies the date and time when SUR occupancy data was last collected.
- Front-End Capacity (MB)
- Specifies the amount of primary data that is reported as being backed up by clients. Clients include applications, virtual machines, and systems. This value is used for the front-end licensing model.
- Front-End Client Count
- Specifies the number of clients that reported capacity usage based on the front-end licensing model.
- Front-End Capacity Date
- Specifies the date and time when front-end capacity data was last collected.
- Product Offering
- Specifies a product offering.
Value specified by the SET PRODUCTOFFERING command Value shown in the QUERY STATUS command output ENTry IBM Spectrum Protect Entry DATARet IBM Spectrum Protect for Data Retention BASIC IBM Spectrum Protect EE IBM Spectrum Protect Extended Edition SUIte IBM Spectrum Protect Suite SUITECloud IBM Spectrum Protect Suite - IBM Cloud Object Storage Option SUITEEntry IBM Spectrum Protect Suite Entry SUITEArchive IBM Spectrum Protect Suite - Archive SUITEProtectier IBM Spectrum Protect Suite - ProtecTier SUITEFrontend IBM Spectrum Protect Suite - FrontEnd SUITEENTRYFrontend IBM Spectrum Protect Suite Entry - FrontEnd CLEAR NULL - Command Approval
- Specifies whether command approval is enabled. When command approval is set to ON, an approval administrator must approve restricted commands before they are run.
- Approver Administrators Require Approval
- Specifies whether restricted commands that are issued by approval administrators require approval by a different approval administrator when command approval is enabled.
Related commands
| Command | Description |
|---|---|
| BEGIN EVENTLOGGING | Starts event logging to a specified receiver. |
| DISABLE REPLICATION | Prevents outbound replication processing on a server. |
| DISABLE SESSIONS | Prevents new sessions from accessing IBM Spectrum Protect but permits existing sessions to continue. |
| ENABLE REPLICATION | Allows outbound replication processing on a server. |
| ENABLE SESSIONS | Resumes server activity following the DISABLE command or the ACCEPT DATE command. |
| END EVENTLOGGING | Ends event logging to a specified receiver. |
| QUERY LICENSE | Displays information about licenses and audits. |
| REGISTER ADMIN | Defines a new administrator. |
| SET ACCOUNTING | Specifies whether accounting records are created at the end of each client session. |
| SET ACTLOGRETENTION | Specifies the number of days to retain log records in the activity log. |
| SET COMMANDAPPROVAL | Specifies whether command approval is required. |
| SET CONTEXTMESSAGING | Specifies to turn on context messaging to debug an ANR9999D message. |
| SET CPUINFOREFRESH | Specifies the number of days between client scans for workstation information used for PVU estimates. |
| SET CROSSDEFINE | Specifies whether to cross define servers. |
| SET DEDUPVERIFICATIONLEVEL | Specifies the percentage of extents verified by the server during client-side deduplication. |
| SET DEFAULTAUTHENTICATION | Specifies the default password authentication method for any REGISTER NODE or REGISTER ADMIN commands. |
| SET EVENTRETENTION | Specifies the number of days to retain records for scheduled operations. |
| SET LDAPPASSWORD | Sets the password for the LDAPUSER. |
| SET LDAPUSER | Sets the user who oversees the passwords and administrators on the LDAP directory server. |
| SET MAXCMDRETRIES | Specifies the maximum number of retries after a failed attempt to execute a scheduled command. |
| SET MAXSCHEDSESSIONS | Specifies the maximum number of client/server sessions available for processing scheduled work. |
| SET PASSEXP | Specifies the number of days after which a password is expired and must be changed. |
| SET PRODUCTOFFERING | Set the product offering licensed to your enterprise. |
| SET QUERYSCHEDPERIOD | Specifies the frequency for clients to obtain scheduled work, in client-polling mode. |
| SET RANDOMIZE | Specifies the randomization of start times within a window for schedules in client-polling mode. |
| SET REPLRECOVERDAMAGED | Specifies whether node replication is enabled to recover damaged files from a target replication server. |
| SET RETRYPERIOD | Specifies the time between retry attempts by the client scheduler. |
| SET SCHEDMODES | Specifies the central scheduling mode for the server. |
| SET SERVERHLADDRESS | Specifies the high-level address of a server. |
| SET SERVERLLADDRESS | Specifies the low-level address of a server. |
| SET SERVERNAME | Specifies the name by which the server is identified. |
| SET SERVERPASSWORD | Specifies the server password. |
| SET SUMMARYRETENTION | Specifies the number of days to retain information for the activity summary table. |
| SET TOCLOADRETENTION | Specifies the number of minutes to retain information for unreferenced TOC sets. |
| UPDATE ADMIN | Changes the password or contact information associated with any administrator. |