DELETE FILESPACE (Delete client node data from the server)

Use this command to delete file spaces from the server. Files that belong to the file space are deleted from primary, active-data, and copy storage pools, and any file space collocation groups.

IBM Spectrum® Protect deletes one or more file spaces as a series of batch database transactions, thus preventing a rollback or commit for an entire file space as a single action. If the process is canceled or if a system failure occurs, a partial deletion can occur. A subsequent DELETE FILESPACE command for the same node or owner can delete the remaining data.

If this command is applied to a WORM (write once, read many) volume, the volume is returned to scratch if it has space on which data can be written. (Data on WORM volumes, including deleted and expired data, cannot be overwritten. Therefore, data can be written only in space that does not contain current, deleted, or expired data.) If a WORM volume does not have any space available on which data can be written, it remains private. To remove the volume from the library, you must use the CHECKOUT LIBVOLUME command.

Tips:
  • If archive retention protection is enabled, the server deletes archive files with expired retention periods. For more information, see the SET ARCHIVERETENTIONPROTECTION command.
  • The server does not delete archive files that are on deletion hold until the hold is released.
  • The server does not delete data that is contained in a retention set. Data in a retention set must remain accessible as long as the retention set exists. When the retention set itself expires or is deleted, then the server can delete the data as normal.
  • Reclamation does not start while the DELETE FILESPACE command is running.
  • 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.
  • If you delete a file space in a deduplicated storage pool, the file space name DELETED is displayed in the output of the QUERY OCCUPANCY command until all deduplication dependencies are removed.
  • When replication is configured for a file space, the DELETE FILESPACE command deletes only the file space on the server where you issued the command. If you issue the REPLICATE NODE command, the file space is not deleted on the other replication server.

Privilege class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy privilege for the policy domain to which the client node is assigned.

Syntax

Read syntax diagramSkip visual syntax diagramDELete FIlespacenode_namefile_space_name Type=ANYType=ANYBackupARchiveSPacemanagedSERverDAta=ANYDAta=ANYFIlesIMages1Wait=NoWait=NoYesOWNer=owner_nameNAMEType=SERVERNAMEType=SERVERUNIcodeFSIDCODEType=BOTHCODEType=UNIcodeNONUNIcodeBOTH
Notes:
  • 1 This parameter can be used only when TYPE=ANY or TYPE=BACKUP is specified.

Parameters

node_name (Required)
Specifies the name of the client node to which the file space belongs.
file_space_name (Required)
Specifies the name of the file space to be deleted. This name is case-sensitive and must be entered exactly as it is known to the server. To determine how to enter the name, use the QUERY FILESPACE command. You can use wildcard characters to specify this name.

For a server that has clients with support for Unicode, you might have the server convert the file space name that you enter. For example, you might want to have the server convert the name that you entered from the server's code page, to Unicode. See the NAMETYPE parameter for details. If you do not specify a file space name, or 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.

Type
Specifies the type of data to be deleted. This parameter is optional. The default value is ANY. You can use the following values:
ANY
Delete only backed-up versions of files and archived copies of files.

If you specify delete filespace node_name * type=any, all backed-up data and archived data in all file spaces for that node are deleted. File spaces are deleted only if they do not contain files that are moved from an IBM Spectrum Protect for Space Management client.

Backup
Delete backup data for the file space.
ARchive
Delete all archived data on the server for the file space.
SPacemanaged
Delete files that are migrated from a user's local file system by an IBM Spectrum Protect for Space Management client. The OWNER parameter is ignored when you specify TYPE=SPACEMANAGED.
SERver
Delete all archived files in all file spaces for a node that is registered as TYPE=SERVER.
DAta
Specifies objects to delete. This parameter is optional. The default value is ANY. You can specify one of the following values:
ANY
Delete files, directories, and images.
FIles
Delete files and directories.
IMages
Delete image objects. You can use this parameter only if you specified TYPE=ANY or TYPE=BACKUP.
Wait
Specifies whether to wait for the server to complete processing this command in the foreground. This parameter is optional. The default value is No. You can specify one of the following values:
No
Specifies that the server processes this command in the background. You can continue with other tasks while the command is being processed.

Messages that are created from the background process are displayed either in the activity log or the server console, depending on where messages are logged.

Yes
Specifies that the server processes this command in the foreground. Wait for the command to complete before you continue with other tasks. The server displays the output messages to the administrative client when the command completes.
Restriction: You cannot specify WAIT=YES from the server console.
OWNer
Restricts the data that is deleted to files that belong to the owner. This parameter is optional; it is ignored when TYPE=SPACEMANAGED. This parameter applies to only multiuser client systems such as AIX®, Linux®, and Solaris OS.
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. A backup-archive client with support for Unicode is available only for the following operating systems: Windows, Macintosh OS X, and NetWare operating systems.

Use this parameter only when you enter a partly 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's code page to interpret the file space names.
UNIcode
The server converts the file space names 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's code page. Conversion can fail if the string includes characters that are not available in the server code page or if the server cannot access 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 file spaces that are in Unicode.
NONUNIcode
Include file spaces that are not in Unicode.
BOTH
Include file spaces regardless of code page type.

Delete a file space

Delete the C_Drive file space that belongs to the client node HTANG.
delete filespace htang C_Drive

Delete all space-managed files for a client node

Delete all files that are migrated from client node APOLLO (that is, all space-managed files).
delete filespace apollo * type=spacemanaged

Related commands

Table 1. Commands related to DELETE FILESPACE
Command Description
CANCEL PROCESS Cancels a background server process.
QUERY ACTLOG Displays messages from the server activity log.
QUERY FILESPACE Displays information about data in file spaces that belong to a client.
QUERY OCCUPANCY Displays file space information by storage pool.
QUERY PROCESS Displays information about background processes.
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.