Veritas NetBackup™ Commands Reference Guide

Removes an attribute from the specified storage server or the specified disk pool for restore or duplication operations. It is used only with the -changests and -changedp options. You can specify more than one -clearattribute attribute on the command line. Refer to the -setattribute description for a list of attributes used by -ch angests and a list used by -changedp.

Adds a comment for the disk pool. Quotation marks (" ") are required if the comment contains any spaces.

For Amazon cloud storage region support, specifies the region in which to create the bucket. The region-url must be one of the following:

If the region-url string does not exactly match the notation, the bucket is created in the US Standard region. If this option is omitted, the bucket is created in the US Standard region.

Captures the configuration parameter information and sends it to the specified file or to the appropriate disk pool.

Deletes the specified storage servers.

Specifies the name of the disk pool that nbdevconfig previews, inventories, or creates. The disk pool name cannot exceed 256 characters.

The name of the disk volume.

For cloud storage, the characters that each vendor allows may vary. Also, the terminology for volumes may differ (for example, Amazon uses buckets to describe volumes). Consult your cloud vendor documentation for naming conventions.

The file name that contains a list of the disk volumes. Specify one volume only for cloud disk pools and media server deduplication pools.

The unique name of the enclosure. When it is used with the previewenclr option, it displays details about the enclosure. This option runs successfully only if the vendor CLI is installed on the master server and its name in the disk array's host map.

When it is used with the importenclr option, it creates the disk pool from the specified enclosure.

Limits the command output to the disk volumes that are not capable of the specified target retention type (snapshot, primary, independent, mirror, replication source, or replication target).

To exclude more than one flag, list the -exclude option more than once (for example, -exclude primary -exclude ReplicationTarget).

Forces the deletion of a disk pool that has an associated AIR target lifecycle policy when deletion of that disk pool results in an error. This option can be used only with the -deletedp operation.

The percentage of used capacity at which the storage (disk volume) is considered full. No new jobs can be assigned to the volume, and staging expiration operations can be triggered.

Limits the command output to the disk volumes that are capable of the specified target retention type (snapshot, primary, independent, mirror, replication source, or replication target).

To include more than one flag, list the modifier more than once (for example, -include Snapshot -include ReplicationTarget).

Sets the list type to the short output. It produces parsable, raw output with all fields on one line with no headers. The first field indicates the version of the output as an aid to the script operation.

The percentage of used capacity to which staging and expiration operations drain each volume in the disk pool upon reaching the high water mark.

The name of the master server.

Limits the number of jobs that are allowed for each volume in the disk pool to the specified number n. This number is the sum of the jobs that read backup images and the jobs that write backup images. When the limit is reached, NetBackup chooses another available volume for write operations. If none is available, NetBackup queues jobs until a volume becomes available. Factors that affect the optimal number of streams include disk speed, CPU speed, and the amount of memory.

This parameter is not supported for BasicDisk. NetBackup does not limit the number of streams for BasicDisk storage units.

The media server that executes the operation.

Suppresses all stdout messages, including successful confirmation output such as "Disk pool disk_pool_name was successfully inventoried."

Indicates the reason for performing this command action. The reason text string that you enter is captured and appears in the audit report. Enclose the string with double quotes ("...") and the string cannot exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').

Applies an attribute to the storage server or data pool for the read side of restore or duplication operations. It is used only with the -changests and -changedp options. The attributes help you manage the restore traffic and duplication traffic. You can specify more than one -setattribute attribute on the command line.

The following attributes are used with storage servers:

OpenStorage               : managed as OpenStorage storage server
DiskGroups                : aware of disk pools / enclosures
ActiveDiskGroups          : allow active management of disk groups
ActiveServers             : allow active management of storage srvrs
RovingVolumes             : active mount/unmounts for disk volumes
CopyExtents               : allow optimized duplication
AdminUp/Down              : administrative state is UP/DOWN
InternalUp/Down           : internal state is UP/DOWN
SpanImages                : allow images to span disk volumes
BasicStaging              : allow basic image staging
LifeCycle                 : allow image life cycle management
CapacityMgmt              : allow capacity management
FragmentImages            : allow image fragmentation
CatalogBackup             : allow catalog backups
Cpr                       : allow checkpoint / restart
RandomWrites              : allow random write access
FT-Transfer               : allow access through FT channel
PrefRestore               : preferred use for restores
ReqRestore                : required use for restores
ReqDuplicate              : required use for duplications
CapacityManagedRetention  : allow capacity managed retention
CapacityManagedJobQueuing : allow capacity managed job queuing
OptimizedImage            : allow virtual image construction
MetaData                  : describe client data during backup
QueueOnDown               : queue jobs when server status is down

The following attributes are used with data pools:

Patchwork                 : associated with enclosure
Visible                   : visible and managed through UI
OpenStorage               : managed as OpenStorage disk pool
RovingVolumes             : active mount/unmounts for disk volumes
SingleStorageServer       : limited to single storage server
CopyExtents               : allow optimized duplication
AdminUp/Down              : administrative state is UP/DOWN
InternalUp/Down           : internal state is UP/DOWN
SpanImages                : allow images to span disk volumes
BasicStaging              : allow basic image staging
LifeCycle                 : allow image life cycle management
CapacityMgmt              : allow capacity management
FragmentImages            : allow image fragmentation
CatalogBackup             : allow catalog backups
Cpr                       : allow checkpoint / restart
RandomWrites              : allow random write access
FT-Transfer               : allow access through FT channel
CapacityManagedRetention  : allow capacity managed retention
CapacityManagedJobQueuing : allow capacity managed job queuing
OptimizedImage            : allow virtual image construction
MetaData                  : describe client data during backup
Snapshot                  : disk pool holds Snapshots
Primary                   : disk pool is capable of Snapshots from  
                            sources mounted on a client
ReplicationSource         : disk pool can be a source for Image or  
                            Snapshot replication
ReplicationTarget         : disk pool can be a target for Image or  
                            Snapshot replication
Mirror                    : this replication target disk pool can use
                            a mirrored replication method
Independent               : this replication target can use a non- 
                            mirrored replication method

The following are additional descriptions of attributes related to restore and duplication operations:

The type of storage being used:

1 -- Formatted disk (default) OR 2 -- Raw disk

4 -- Direct attached OR 8 -- Network attached (default)

The two values are added together. For example a storage_type of 10 indicates a raw disk (2) that is network attached (8).

Selects the state of the disk pool or disk volume. Specify UP to up the disk pool or disk volume and DOWN to down the disk pool or disk volume.

The list of storage server names for creating a disk pool. Separate the items in this list with spaces, not commas.

Specifies a string that identifies the storage server type. The server_type value can originate from one of the following sources:

The storage server type is case sensitive.

Lists the configuration attributes in a user-readable, formatted listing with one attribute per line and more attributes than a listing in raw output mode (-l). See Example 1.