5 1 0:Configuring and Administering HPE Catalyst Data Store by using CLI

From SEPsesam


Welcome to the latest SEP sesam documentation version 5.1.0 Apollon. For previous documentation version(s), check documentation archive.


Overview


Once your HPE StoreOnce appliance is set up and the Catalyst stores are created on the StoreOnce system, you can configure the HPE StoreOnce data store(s). This article describes details about the CLI configuration of HPE StoreOnce data stores on SEP sesam.

Configuring HPE Catalyst data store using CLI

The sm_config_drives command is used to configure access to HPE Catalyst store on the HPE StoreOnce server.

sm_config_drives

The sm_config_drives retrieves the HPE StoreOnce server address and HPE Catalyst store name with optional client and password settings. These parameters are automatically copied to the HPE StoreOnce data store drive configuration file in the <SESAM_VAR>/ini/stpd_conf folder.

stpd_conf

The HPE StoreOnce data store configuration is saved in a stpd specific .ini file in the gv_rw_ini:stpd_conf directory.

As with any other data store, the name of the .ini file is derived from the data store name data_stores.name (HPE_Store1) and the drive number of the first drive for that data_store, e.g., HPE_Store1_2.ini. The data store name is also used as the device name in the hw_drives table together with the prefix DS@ and the drive number, e.g., hw_drives.device=DS@HPE_Store1_2.

For example, bigsrv1:/var/opt/sesam/var/ini/stpd_conf # cat HPE_Store_1_2.ini:

[CATALYST]
backend=catalyst_store
hostname=storeoncevsa.srv.qa.mycompany.com
catalyst_store=HPE_Store_1
command_port=9387
data_port=9388
access_key="bigsrv1"
secret_key={8494a4b4c4d4e4f4675bfe5226281414d14a58c0f514f524eda63797b8114749}

[DISK_STORE]
Storage_Location=/HPE_Store_1
Size=-10GB
backend=catalyst_store
hostname=localhost

Advanced CLI administration

The sm_dedup_interface command is used as a frontend for the HPE Catalyst store on the HPE StoreOnce server.

sm_dedup_interface

The following list shows the valid commands and their usage:

sm_dedup_interface -d <data_store> <command>

sm_dedup_interface.exe -d 2 usage
2019-07-31 13:12:50 gitID: $Id: e89e3e461f (HEAD -> v4_4_3_5, tag: v4_4_3_5_build, origin/v4_4_3_5) 2019-07-19 13:20:59 +0200 $, Si3/Si3-NG & StoreOnce
Common options:
 init -u <uuid> -t <label>    initiate upper data store directory structure
 init -t <tape_spec>          initiate lower data store directory structure
 status                       get data store status
 df                           get full summary of available and used disk space usage of the file system
 du                           get used disk space usage of the file system
 list|dir [<saveset>*]        get saveset information
 delete <saveset> [<saveset>*]
                              remove saveset from the data store
 getlabel                     get data store label
 getpath                      get data store path
 getuuid                      get data store uuid
 put <input_file_name> <dest_file_name> [over]
                              upload file into the data store
 get <remote_file_name> <dest_file_name> [<bytes skipped then> [<bytes read at beginning>]]
                              download file or its part from the data store
Note
Some of the parameters are for internal use or for the future use only.
status
  • Provides information about the encryption, used space, saved data and object summary.
bigsrv1:/var/opt/sesam/var/ini/stpd_conf # sm_dedup_interface -d 2 status
2019-07-31 13:15:38 gitID: $Id: e89e3e461f (HEAD -> v4_4_3_5, tag: v4_4_3_5_build, origin/v4_4_3_5) 2019-07-19 13:20:59 +0200 $, Si3/Si3-NG & StoreOnce
Using HPE StoreOnce Catalyst Client
Ctl_SetCredentials [storeoncevsa-v4.srv.qa.mycompany.com]
Ctl_SetLogDescriptor [C:\ProgramData\SEPsesam\var\log\sms/stpd_so_20190731.log] Log size: [2621440] Log level: [0]
Ctl_GetServerProp [storeoncevsa-v4.srv.qa.mycompany.com]
Server Status:
 Repository information:      2019-07-31 13:15:39
  HPE StoreOnce time:         2019-07-31 11:15:39
  Creation time:              2019-07-09 13:14:07
  Last modified time:         2019-07-18 11:30:29
  Path:                       HPE_Store_1
  Version:                    2 (Server version: 4.1.1-1849.3)
  Encryption:                 Off
  Bytes in repository:          23.5 GiB
  Jobs:                       All: 414 Data jobs: 314 Dest copy jobs: 0 Origin copy jobs: 0
  Status:                     Online (Ok: Online)
  Free data sessions:         13/32
  Object lock resources:      Available
  HPE Storage:                Bytes All: 882079956992, Use: 53624758272, Free: 828455198720, Used: 6%
  Logical  Storage Quota:     Bytes All: -, Use: 239273889320, Free: -, Used: 0%
  Physical Storage Quota:     Bytes All: -, Use: 25270237105, Free -, Used: 0% 

 Object information:
  Objects stored:             102
  Data before deduplication:   222.8 GiB
  Data after  deduplication:    23.5 GiB
  Overall DeDup ratio:        1 / 9.80
  Saved storage space:        89.44 % 

STATUS=SUCCESS MSG=

The value Overall DeDup ratio shows by what percentage the stored data has been reduced.

list|dir [<saveset>*]
  • List all objects or the given savesets in the HPE Catalyst store.
delete <saveset> [<saveset>*]
  • Deletes all given savesets from the HPE Catalyst store.
get
  • Reads an object (file, saveset) from the HPE Catalyst store.
  • '-' can be used to specify STDOUT
put
  • Writes an object (file, saveset) to the HPE Catalyst store.
  • '-' can be used to specify STDIN

Logging

There are two different HPE StoreOnce store-related logging processes, depending on the SEP sesam operation: STPD logging records the backup and restore process, while VFS logging records all VFS mount-related events when performing a single file restore (SFR).

STPD logging

HPE Catalyst client library logging is written to the file gv_rw_sms:stpd_so_<day>.log, for example, logging file name /var/opt/sesam/var/log/sms/stpd_so_20190731.log.

The log settings are defined with the log settings Log_Levels and Log_Size (in kilobytes (kB)) from the gv_rw_ini:stpd.ini.

[STPD_Logging]
Log_Levels=2
Log_Size=1024

VFS logging

VFS-related logs are stored in C:\Program Files\SEPsesam\var\log\lgc on Windows and in /var/opt/sesam/var/log/lgc on Linux.

Logging information for single file restore (VFS mount) is written to the file gv_rw_sms:sm_vfs_so_<mount_process_ID><date>.log, for example, sm_vfs_so_9820_20190914.log.

The log settings are defined with the log setting SM_VFS in gv_rw_ini:debug.ini.

Logging levels

The available Log_Levels are -1=NO_LOG, 0=ERROR, 1=EMERGENCY, 2=WARNING, 3=NOTICE, 4=INFO, 5=DEBUG, 6=TRACE. These logging levels are mapped to the corresponding HPE StoreOnce Catalyst client library logging levels:

-1|0|1 -> OSCLT_LOG_LEVEL_ERROR
2 -> OSCLT_LOG_LEVEL_QUIET 
3 -> OSCLT_LOG_LEVEL_INFO 
4 -> OSCLT_LOG_LEVEL_TRACE 
5 -> OSCLT_LOG_LEVEL_DEBUG
6 -> OSCLT_LOG_LEVEL_EXTENDED_DEBUG

Autorotation occurs when the log file size reaches the maximum log size defined by Log_Size.

Additional log settings

The logging level settings defined in gv_rw_ini:stpd.ini can be overridden by specific settings in the HPE StoreOnce data store drive configuration file gv_rw_ini:stpd_conf/{name}_{drive_num}.ini.

Example for /var/opt/sesam/var/ini/stpd_conf/HPE_Store_1_2.ini with increased logging level and size.

[CATALYST]
Log_Levels=5
Log_Size=20480
backend=catalyst_store
hostname=storeoncevsa.srv.qa.mycompany.com
catalyst_store=HPE_Store_1
command_port=9387
data_port=9388
access_key="bigsrv1"
secret_key={8494a4b4c4d4e4f4675bfe5226281414d14a58c0f514f524eda63797b8114749}

[DISK_STORE]
Storage_Location=/HPE_Store_1
Size=-10GB
backend=catalyst_store
hostname=localhost

HPE Catalyst store objects

For every SEP sesam saveset, there are two objects stored in the HPE Catalyst store:

  • <ssid>.data
  • <ssid>.info

The saveset data is stored in the .data file. The SEP sesam saveset attributes are recorded in the .info file. Both objects are identical to those of other data stores, e.g., the Path data store with the files <ssid>.data and <ssid>.info.

What is next?

After configuring the HPE StoreOnce data store, configure the media pools, then set up your backup strategy.

See also

HPE StoreOnce ConfigurationSEP sesam HPE StoreOnce ConfigurationHPE StoreOnce BackupHPE StoreOnce ReplicationBackup to HPE Cloud VolumesHPE StoreOnce RestoreSupport Matrix: SEP sesam integration with HPE StoreOnce Catalyst

Copyright © SEP AG 1999-2024. All rights reserved.
Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.