Use this command to display information about file spaces
that belong to a client node. The output from this command includes
the results of the last incremental backup or replication.
Tip: If a node has more than one file space,
you can issue a DELETE FILESPACE command for one
of the file spaces. However, if you issue a QUERY FILESPACE command
for the node during the deletion process, the output shows no file
spaces. To obtain accurate information about remaining file spaces,
issue the QUERY FILESPACE command after the deletion
process ends.
Privilege class
Any administrator can issue
this command.
Syntax
.-*--*---------------------------.
>>-Query FIlespace--+--------------------------------+---------->
| .-*---------------. |
'-node_name--+-----------------+-'
'-file_space_name-'
.-Format--=--Standard-----. .-NAMEType--=--SERVER------.
>--+-------------------------+--+--------------------------+---->
'-Format--=--+-Standard-+-' '-NAMEType--=--+-SERVER--+-'
'-Detailed-' +-UNIcode-+
'-FSID----'
.-CODEType--=--BOTH-----------.
>--+-----------------------------+-----------------------------><
'-CODEType--=--+-UNIcode----+-'
+-NONUNIcode-+
'-BOTH-------'
Parameters
- node_name
- Specifies the client node to which the file space belongs. You
can use wildcard characters to specify this name. This parameter is
optional. The default is all client node names.
You must specify
a value for this parameter if you specify a file name.
- file_space_name
- Specifies the name of the file space to be queried. You can use
wildcard characters to specify this name. This parameter is optional.
If a value is not specified, all file spaces are queried.
If a server includes clients that use Unicode-enabled
files spaces, the server might have to convert the name that you enter.
For example, the server might have to convert the file space name
that you enter from the server code page to Unicode. For more information,
see the NAMETYPE parameter. If you do not specify
a file space name, or if you specify only a single wildcard character
for the name, you can use the CODETYPE parameter
to limit the operation to Unicode file spaces or to non-Unicode file spaces.
File
space names are case-sensitive. You can use the QUERY FILESPACE command
to determine the correct capitalization for the file space to be queried.
- Format
- Specifies how the information is displayed. This parameter is
optional. The default value is STANDARD. You can specify one of the
following values:
- Standard
- Specifies that partial information is displayed for the specified
file space.
- Detailed
- Specifies that complete information is displayed for the specified
file space.
- NAMEType
- Specify how you want the server to interpret the file space names
that you enter. This parameter is useful when the server has clients
with support for Unicode. You can use this parameter for Unicode-enabled Tivoli® Storage
Manager clients
that have Windows, Macintosh
OS X, and NetWare operating systems.
Use this parameter only when
you enter a partly qualified or fully qualified file space name. The
default value is SERVER. You can specify one of the following values:
- SERVER
- The server uses the server code page to interpret the file space
names.
- UNIcode
- The server converts the file space name that is entered from the
server code page to the UTF-8 code page. The success of the conversion
depends on the actual characters in the name and the server code page. Conversion
can fail if the string includes characters that are not available
in the server code page, or if the server has problems accessing system
conversion routines.
- FSID
- The server interprets the file space names as their file space
IDs (FSIDs).
- CODEType
- Specify what type of file spaces are to be included in the operation.
The default is BOTH, meaning that file spaces are included regardless
of code page type. Use this parameter only when you enter a single
wildcard character for the file space name. You can specify one of
the following values:
- UNIcode
- Include only file spaces that are in Unicode.
- NONUNIcode
- Include only file spaces that are not in Unicode.
- BOTH
- Include file spaces regardless of code page type.
Example: List all file spaces
Query all
file spaces that are associated with all client nodes.
query filespace
Node Filespace FSID Platform Filespace Is Capacity Pct
Name Name Type Filespace (MB) Util
Unicode?
------ ----------- ---- ------- --------- --------- --------- ----
JOE \\joe\c$ 1 WinNT NTFS Yes 2,502.3 75.2
JOE \\joe\d$ 2 WinNT NTFS Yes 6,173.4 59.6
See
Field descriptions for field descriptions.
Example: Display detailed file space information for
a virtual file space
Display detailed information for the file
space
/HomeDir, which is a virtual file space
mapping and belongs to the NAS node NAS1.
query filespace nas1 /HomeDir
Node Filespace FSID Platform Filespace Is Capacity Pct
Name Name Type Filespace (MB) Util
Unicode?
------ ----------- ---- ------- --------- --------- --------- ----
NAS1 /HomeDir 1 NetApp WAFL (VFS) No 2,502.3 75.2
See
Field descriptions for
field descriptions.
Important: You might not see the expected
results after you request a detailed format because several fields
must be completed by the API application. These fields include:
- File space type
- Platform
- Capacity (MB)
- Pct Util
- Last backup start Date/Time
- Last backup completion Date/Time
For more information about specific fields that are updated by
the API, see the
IBM® Tivoli Storage Manager: Using
the Application Programming Interface.
Example: Display detailed file space information for
a specific file space and node
Display detailed information
about the
\\joe\c$ file space that belongs to
the client node JOE.
query filespace joe \\joe\c$ nametype=unicode format=detailed
Node Name: JOE
Filespace Name: \\joe\c$
Hexadecimal Filespace Name: 5c5c6a6f655c6324
FSID: 1
Collocation Group Name: FSGRP1
Platform: WinNT
Filespace Type: NTFS
Is Filespace Unicode?: Yes
Capacity (MB): 2,502.3
Pct Util: 75.2
Last Backup Start Date/Time:
Days Since Last Backup Started:
Last Backup Completion Date/Time:
Days Since Last Backup Completed:
Last Replication Start Date/Time: 12/02/2012, 12:42:00
Days Since Last Node Replication Started: 30
Last Replication End Date/Time: 12/02/2012, 12:42:00
Days Since Last Replication Ended: 30
Last Backup Date/Time From Client (UTC): 06/02/2013, 09:10:00
Last Archive Date/Time From Client (UTC): 06/02/2013, 09:10:00
Backup Replication Rule: ACTIVE_DATA
Backup Data-Type Replication State: ENABLED
Archive Replication Rule: DEFAULT
Archive Data-Type Replication State: ENABLED
Space-Managed Replication Rule: NONE
Space-Managed Data-Type Replication State: DISABLED
At-risk type: Custom interval
At-risk interval: 2,222
See
Field descriptions for
field descriptions.
Field descriptions
Important: You might not see the expected results after requesting
a detailed format because several fields must be completed by the
API application. These fields include:
- Filespace Type
- Platform
- Capacity (MB)
- Pct Util
- Last Backup Start Date/Time
- Last Backup Completion Date/Time
For more information about specific fields that are updated by
the API, see the
IBM Tivoli Storage Manager: Using
the Application Programming Interface.
- Node Name
- Specifies the name of the client node.
- Filespace Name
The name of the file space that belongs to the node.
File space names can be in a different code page or
locale than the server. If they are, the names in the Operations Center and the administrative
command-line interface might not be displayed correctly. Data is backed
up and can be restored normally, but the file space name or file name
might be displayed with a combination of invalid characters or blank
spaces.
If the file space name is Unicode-enabled, Tivoli Storage
Manager converts
the name to the server code page for display. The success of the conversion
depends on the operating system, the characters in the name, and the
server code page. Conversion can be incomplete if the string includes
characters that are not available in the server code page or if the
server cannot access system conversion routines. If the conversion
is incomplete, the name might contain question marks, blanks, unprintable
characters, or ellipses (...).
- Hexadecimal Filespace Name
- Specifies the hexadecimal name of the file space for the client
node in UTF-8 format.
- FSID
- Specifies the file space ID of the file space.
- Collocation Group Name
- The name of the collocation group, if any, to which the file space
belongs.
- Platform
- Specifies the platform for the client node.
- Filespace Type
- Specifies the type of file space.
A file space type that is
appended with "(VFS)" denotes that this file space name is a virtual
file space mapping for a directory path on a NAS device.
- Is Filespace Unicode?
- Indicates whether the file space is Unicode.
- Capacity (MB)
- Specifies the amount of space, in megabytes, assigned to this
file space on the client node.
For a file space that is a virtual
file space mapping for a directory path, this field represents the
capacity of the file space on which the directory path is located.
- Pct Util
- Specifies the percentage of the file space that is occupied.
For
a file space that is a virtual file space mapping for a directory
path, the percentage used is calculated as the percentage of the capacity
of the file space that was occupied by the directory at the time of
the last full backup.
- Last Backup Start Date/Time
- Specifies the start date and time of the last incremental backup
of the file space.
- Days Since Last Backup Started
- Specifies the number of days since the start of the last incremental
backup of the file space.
- Last Backup Completion Date/Time
- Specifies the completion date and time of the last incremental
backup of the file space.
- Days Since Last Backup Completed
- Specifies the number of days since the completion of the last
incremental backup of the file space.
- Last Replication Start Date/Time
- Specifies the date and time that the last replication of file
space data started.
- Days Since Last Replication Started
- Specifies the number of days since the last replication of file
space data started.
- Last Replication End Date/Time
- Specifies the date and time that the last replication of file
space data ended.
- Days Since Last Replication Ended
- Specifies the number of days since the last replication of file
space data ended.
- Last Backup Date/Time From Client (UTC)
- The date and time, in Universal Time Coordinates (UTC), of the
last backup operation for this file space.
- Last Archive Date/Time From Client (UTC)
- The date and time, in Universal Time Coordinates (UTC), of the
last archive operation for this file space.
- Backup Replication Rule
- Specifies the replication rule that applies to backup data in
the file space. 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.
- ALL_DATA_HIGH_PRIORITY
- Replicates active and inactive backup data. The data is replicated
with a high priority.
- ACTIVE_DATA_HIGH_PRIORITY
- Replicates only active backup data. The data is replicated with
a high priority.
- DEFAULT
- Replicates backup data according to the client node rule for backup
data. If the client node rule for backup data is DEFAULT, backup data
is replicated according to the server rule for backup data.
- NONE
- Backup data in the file space is not replicated.
- Backup Data-Type Replication State
- Specifies whether replication of backup data in the file space
is enabled or disabled. If the state is ENABLED, backup files are
eligible for replication. If the state is DISABLED, backup files are
not eligible for replication.
- Archive Replication Rule
- Specifies the replication rule that applies to archive data in
the file space. 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.
- DEFAULT
- Replicates archive data according to the client rule for archive
data. If the client rule for archive data is DEFAULT, archive data
is replicated according to the server rule for archive data.
- NONE
- Archive data in the file space is not replicated.
- Archive Data-Type Replication State
- Specifies whether replication of archive data in the file space
is enabled or disabled. If the state is ENABLED, archive files are
eligible for replication. If the state is DISABLED, archive files
are not eligible for replication.
- Space-Managed Replication Rule
- Specifies the replication rule that applies to space-managed data
in the file space. 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.
- DEFAULT
- Replicates space-managed data according to the client rule for
space-managed data. If the client rule for space-managed data is DEFAULT,
space-managed data is replicated according to the server rule for
space-managed data.
- NONE
- Space-managed data in the file space is not replicated.
- Space-Managed Data-Type Replication State
- Specifies whether replication of space-managed data in the file
space is enabled or disabled. If the state is ENABLED, space-managed
files are eligible for replication. If the state is DISABLED, space-managed
files are not eligible for replication.
- At-risk type
- Specifies the at-risk evaluation type. Values can be Default,
Bypassed, or Custom. Default indicates that the node is evaluated
with the same interval that was specified for the nodes classification
by the SET STATUSATRISKINTERVAL command. Bypassed
indicates that the node is not evaluated for at-risk status by the
status monitor. Custom indicates that the node is evaluated with
the interval that was specified by the SET VMATRISKINTERVAL command,
rather than the interval that was specified by the SET STATUSATRISKINTERVAL command.
- At-risk interval
- Specifies the amount of time, in hours, between client backup
activity before the status monitor considers the client at-risk. This
field applies only when the at-risk type is Custom.
Related commands
Table 1. Commands related to QUERY FILESPACECommand |
Description |
DEFINE VIRTUALFSMAPPING |
Define a virtual file space mapping. |
DELETE FILESPACE |
Deletes data associated with client file spaces.
If a file space is part of a collocation group and you remove the
file space from a node, the file space is removed from the collocation
group. |
REGISTER NODE |
Defines a client node to the server and sets
options for that user. |
REMOVE NODE |
Removes a client from the list of registered
nodes for a specific policy domain. |
RENAME FILESPACE |
Renames a client filespace on the server. |
UPDATE FILESPACE |
Changes file-space node-replication rules. |
UPDATE NODE |
Changes the attributes associated with a client
node. |