vRanger 7.8.2 - Integration Guide for NetVault SmartDisk

Configuring NetVault SmartDisk by using the command line

Configuring NetVault SmartDisk by using the command line

You can use the NetVault SmartDisk CLI config command to perform tasks such as:

•	Enabling deduplication.

•	Enabling deduplication compression.

•	Configuring the deduplication window.

•	Configuring Garbage Collection.

•	Extending NetVault SmartDisk Storage Pools by adding additional volumes.

Using the config command options

Using the config command options

Before using the NetVault SmartDisk CLI config command, note the following:

•	All times are displayed in the local time for the machine where the NetVault SmartDisk Instance is installed.

•	With the --volume and --pool options, the <path> and <label> strings are case-sensitive because they identify a specific NetVault SmartDisk Storage Pool or Volume.

•

If a configuration-related command fails and displays a message similar to “Failed to apply configuration,” Quest recommends that you use the config command with the --show option to display the current configuration. After displaying the configuration, double-check the case of the specified NetVault SmartDisk Storage Pool or Volume to ensure that the strings reflect the case-sensitivity.

•	The NetVault SmartDisk Services must be running before you can use the config command and most of the options. To view the options that are available, you can use the --help option while NetVault SmartDisk Services are offline.

The NetVault SmartDisk CLI config command supports the following options:

 

Table 2. Available options

Config option	Description
‑‑help	Displays a list of the config command options and their syntax.
‑‑show	Displays the current values for the NetVault SmartDisk configuration.
‑‑dedupe-enable <TRUE|FALSE>	Enables or disables NetVault SmartDisk Deduplication.
‑‑dedupe-compression <TRUE|FALSE>	Enables or disables compression of NetVault SmartDisk-unique chunks. Disabled by default, compressing unique chunks can reduce their storage footprint up to 50%. Compression is performed on the unique chunks that result from the deduplication process. Compressing the initial Full Backup for a data set might take longer than not compressing the unique data because most of the data is considered unique. Subsequent Full Backups have fewer unique chunks and do not experience an increase in the amount of time it takes to complete the deduplication and compression process.
‑‑add|‑‑delete ‑‑dedupe-window <[Sun|Mon|Tue|Wed|Thu|Fri|Sat-]HH:MM-HH:MM>|<Never|Anytime>	Sets the NetVault SmartDisk Deduplication Window by specifying the times that deduplication can be performed. By default, the default deduplication window is set to Anytime. Available parameters include: • Days of Week: Specifies the days of the week on which the deduplication process runs. You can schedule it to run on multiple days, such as Monday, Wednesday, and Friday. • HH:MM-HH:MM: Using a 24-hour clock, specifies the times of day at which the deduplication process runs. • Never: Disables the deduplication window. Backups enabled for deduplication remain in the Staging Store in a non-deduplicated state until the deduplication window is enabled. • Anytime: Enables the deduplication process to be run at any time. Deduplication for a backup data stream begins after the initial 400 GB has been written to the Staging Store, which can provide nearly inline deduplication performance.
‑‑add|‑‑delete ‑‑gc‑window <[Sun|Mon|Tue|Wed|Thu|Fri|Sat-]HH:MM-HH:MM>|<Never|Anytime>	Sets the Garbage Collection window by specifying the times that NetVault SmartDisk Garbage Collection has priority over deduplication. By default, the Garbage Collection window is set to 13:00 through 19:00 on Mondays through Thursdays. Available parameters include: • Days of Week: Specifies the days of the week on which the Garbage Collection process runs. You can schedule it to run on multiple days, such as Monday, Wednesday, and Friday. • HH:MM-HH:MM: Using a 24-hour clock, specifies the times of day at which the Garbage Collection process runs. • Never: Disables the Garbage Collection window. • Anytime: Enables the Garbage Collection process to be run at any time.
‑‑dedupe-active-limit <Unlimited|limit>	Specifies the maximum number of segments that can be deduplicated simultaneously.
‑‑network-capacity <MBps>	Specifies the capacity, in megabytes per second (MBps), of the network between the NetVault SmartDisk Device and the backup clients.
‑‑stream-limit <limit>	Specifies the number of data streams that can be processed simultaneously.
‑‑add|‑‑update ‑‑volume <path> [Parameters]	Extends NetVault SmartDisk Storage Pools by adding or updating existing volumes in the NetVault SmartDisk Storage Pools. For more information, see Extending NetVault SmartDisk Storage Pools.
‑‑add|‑‑update ‑‑webdav <port> [‑‑block-size <bytes>] [‑‑credentials] [‑‑preferred-address <address>]	Modifies the port that the NetVault SmartDisk Device uses to communicate with vRanger. For more information, see Modifying the data port.
‑‑delete ‑‑webdav <port> [‑‑credentials]	Used with ‑‑add, modifies the port that the NetVault SmartDisk Device uses to communicate with vRanger. For more information, see Modifying the data port.
‑‑update ‑‑remote-port <port>	Modifies the port that the NetVault SmartDisk Device uses to communicate with the backup software. For more information, see Modifying the data port.
--write-md5 <Always|Never| BasedOnHttpHeader>	Indicates when to calculate MD5 checksum for data streams written to NetVault SmartDisk.

Extending NetVault SmartDisk Storage Pools

Extending NetVault SmartDisk Storage Pools

You can extend NetVault SmartDisk physical capacity by adding or updating the volumes specified for the NetVault SmartDisk Storage Pools. Use the config ‑‑add|‑‑update ‑‑volume <path> command to extend the NetVault SmartDisk physical capacity. You can also use the following additional parameters:

 

NOTE: The NetVault SmartDisk Non-privileged User must have access to any volumes that are added to ensure that configuration changes are successfully applied.

 

Table 3. Available parameters

Config volume parameters	Description
‑‑volume <path>	Specifies the path for the file-system path of the volume to be used as a NetVault SmartDisk Storage Pool. You can specify local drives or Universal Naming Convention (UNC) paths for CIFS, NFS, and Storage Area Network (SAN). If the volume is on a mounted file system, verify that the specified path is a valid subdirectory on the mounted file system, and not the mounted directory itself. This step ensures that data is not written to the local directory if the mounted location is unavailable.
[‑‑volume-size <%>]	Specifies the percentage of the volume that NetVault SmartDisk can use; the remainder cannot be used by NetVault SmartDisk. The value of ((100 - X) / 100) * (total volume size) is added to the Last Resort Threshold (LRT). In addition, a small amount of storage is reserved to complete Garbage Collection. These three components of reserved storage determine the total storage set aside that cannot be directly used by NetVault SmartDisk. For example, if volume-size is set to 30 and the volume’s size is 100 GB, 70 GB is set aside — in addition to the LRT and Garbage Collection reserve space — and cannot be used by NetVault SmartDisk.
[‑‑dedupe-cap <Unlimited|cap>]	Specifies the maximum number of backup segments for the specific volume that can be deduplicated simultaneously. Defaults to 4.
[‑‑pool <label>]	Specifies the Label assigned to the Storage Pool. Defaults to a system-generated numeric label. Specify an existing Storage Pool label to add the volume to an existing Storage Pool, or specify a new name to create a Storage Pool.
[‑‑reservation-size <bytes>]	Specifies the number of bytes reserved by the processes streaming data into NetVault SmartDisk. A smaller size results in NetVault SmartDisk having to reserve space more frequently; a larger size renders more disk space temporarily unavailable. If the Space.Available — reported through the show option — is less than the reservation-size, the volume is considered FULL.
[‑‑favour <Staging|Storage|"Chunk Index"|"Disk Index"|All|None>]…	Specifies which Storage Pool Roles the volume is available to perform. To specify multiple roles, list the ‑‑favour parameter multiple times. For example: ‑‑favour Staging ‑‑favour "Disk Index" Use with ‑‑deny to dedicate a volume to one or more roles.
[‑‑deny <Staging|Storage|"Chunk Index"|"Disk Index"|All|None>]…	Specifies which Storage Pool Roles the volume is not available to perform. To specify multiple roles, list the ‑‑deny parameter multiple times. For example: ‑‑deny Storage ‑‑favour "Chunk Index" Use with ‑‑favour to dedicate a volume to one or more roles. NOTE: After NetVault SmartDisk uses a volume as a Chunk Index or Content Index, that is, data has been staged or stored, NetVault SmartDisk continues to use the volume for this purpose, even if this parameter is used to deny it.
[‑‑balancing <Space|Activity|None>]	Instructs NetVault SmartDisk to use the volume with either the most space available or the least activity occurring. If used with ‑‑favour and ‑‑deny, ‑‑balancing is applied last. NOTE: The --balancing parameter provides guidance to NetVault SmartDisk; the NetVault SmartDisk Disk Manager and Deduplicator make the final decision about how to allocate space.
[‑‑account <UNC-path-account>]	Required for Windows® platform when specifying UNC paths. Specifies the user account with read and write permissions to the UNC path.
[‑‑password <UNC-path-password>]	Required for Windows platform when specifying UNC paths. Specifies the password for the user account with read and write permissions to the UNC path. This password is case-sensitive.

Examples

Examples

•	To add a volume that is used for all roles, enter the following command:

…\foundation\bin\smartdisk.bat config ‑‑add ‑‑volume \mnt
\<newNetVaultSmartDiskVolume>

The NetVault SmartDisk configuration is updated.

Configuration applied

•	To add a volume dedicated to the Chunk Store, enter the following command:

…\foundation\bin\smartdisk.bat config ‑‑add ‑‑volume
c:\SDStoragePools2\Store ‑‑favour Storage ‑‑deny Staging
‑‑deny "Chunk Index" ‑‑deny "Disk Index"

The NetVault SmartDisk configuration is updated.

Configuration applied

•	To add a CIFS share, enter the following command:

…\foundation\bin\smartdisk.bat config ‑‑add ‑‑volume
\\<IPaddress>\<NetVaultSmartDiskVolume> --account <nonpriviledgedUser>
--password <nonprivilegedUserPassword>

The NetVault SmartDisk configuration is updated.

•	To review the NetVault SmartDisk configuration, enter the following command:

…\foundation\bin\smartdisk.bat config --show

The NetVault SmartDisk configuration is displayed, including the following details on the Storage Pool volumes:

[SmartDisk:Volume]

Storage Pool = Store

Location = c:\SDStoragePools2\Store

Disk Manager Index = TRUE

Space.Limit = 100, %

Space.Reservation Size = 1073741824, B

Favour = Storage, Chunk Index, Disk Index

Deny = Staging

Balancing = Activity

Space.OS.Available = 17928032256, B

Space.Available = 15175759872, B

Space.Staging.Status = Not Configured

Space.Staging.Available = 0, B

Space.Staging.Reserved = 0, B

Space.Last Resort = 2752272384, B

Data.Staged = 0, B

Deduplication Activity Cap = 4

Active Operations = 0

[SmartDisk:Volume]

Storage Pool = Staging Pool

Location = c:\SDStoragePools2\Stage

Disk Manager Index = FALSE

Space.Limit = 100, %

Space.Reservation Size = 1073741824, B

Favour = Staging

Deny = Storage, Chunk Index, Disk Index

Balancing = Activity

Space.OS.Available = 3681370112, B

Space.Available = 2607628288, B

Space.Staging.Status = Available

Space.Staging.Available = 2607628288, B

Space.Staging.Reserved = 0, B

Space.Last Resort = 1073741824, B

Data.Staged = 0, B

Deduplication Activity Cap = 4

Active Operations = 0