Source:Configuring and Administering HPE Catalyst Data Store by using CLI: Difference between revisions
No edit summary |
(Marked this version for translation) |
||
(21 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
<div class="noprint"><languages /> | <noinclude><div class="noprint"><languages /> | ||
<br /> | |||
<translate>==Overview== <!--T:3--></translate> | <translate>==Overview== <!--T:3--></translate> | ||
</div></noinclude><translate><!--T:97--> | |||
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. | |||
<translate><!--T: | |||
<!--T:145--> | |||
*For details on [[Special:MyLanguage/HPE_StoreOnce_Configuration|StoreOnce configuration]], supported StoreOnce Catalyst extensions ([[Special:MyLanguage/HPE_StoreOnce_Replication|HPE Cloud Bank Storage]] as a replication target and [[Special:MyLanguage/Backup_to_HPE_Cloud_Volumes|HPE Cloud Volumes]] as replication target or backup target), see [[Special:MyLanguage/HPE_StoreOnce_Configuration|HPE StoreOnce Configuration]]. | |||
| | |||
<!--T:146--> | |||
*For system requirements and supported configurations, see [[Special:MyLanguage/SEP_sesam_OS_and_Database_Support_Matrix#StoreOnce|Support Matrix: SEP sesam integration with HPE StoreOnce Catalyst]].</translate> | |||
=={{anchor|CLI}} | =={{anchor|CLI}}<translate><!--T:98--> | ||
Configuring HPE Catalyst data store using CLI== | |||
The <tt>sm_config_drives</tt> command is used to configure | <!--T:99--> | ||
The <tt>sm_config_drives</tt> command is used to configure access to HPE Catalyst store on the HPE StoreOnce server.</translate> | |||
;sm_config_drives | ;<tt>sm_config_drives</tt> | ||
<translate><!--T:24--> The sm_config_drives retrieves the HPE StoreOnce | <translate><!--T:24--> The <tt>sm_config_drives</tt> 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 {{Path|<SESAM_VAR>/ini/stpd_conf}} folder.</translate> | ||
;stpd_conf | ;<tt>stpd_conf</tt> | ||
<translate><!--T:25--> | <translate><!--T:25--> | ||
The HPE StoreOnce | The HPE StoreOnce data store configuration is saved in a <tt>stpd</tt> specific <tt>.ini</tt> file in the {{Path|gv_rw_ini:stpd_conf}} directory. | ||
<!--T:26--> | <!--T:26--> | ||
As with any other data store, the name of the <tt>.ini</tt> file is derived from the data store name <tt>data_stores.name</tt> (''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 <tt>hw_drives</tt> table together with the prefix ''DS@'' and the drive number, e.g., ''hw_drives.device=DS@HPE_Store1_2''. | |||
<!--T:100--> | |||
For example, <tt>bigsrv1:/var/opt/sesam/var/ini/stpd_conf # cat HPE_Store_1_2.ini</tt>:</translate> | |||
[CATALYST] | [CATALYST] | ||
backend=catalyst_store | backend=catalyst_store | ||
Line 59: | Line 48: | ||
hostname=localhost | hostname=localhost | ||
=={{anchor|advanced}}<translate><!--T:35--> | |||
Advanced CLI administration== | |||
< | <!--T:101--> | ||
The <tt>sm_dedup_interface</tt> command is used as a frontend for the HPE Catalyst store on the HPE StoreOnce server. | |||
===sm_dedup_interface === <!--T:37--> | |||
<!--T:38--> | <!--T:38--> | ||
The following list shows the valid commands and their usage:</translate> | |||
<!--T:39--> | <!--T:39--> | ||
<tt>sm_dedup_interface -d < | <tt>sm_dedup_interface -d <<translate><!--T:102--> data_store</translate>> <<translate><!--T:103--> command</translate>></tt> | ||
<!--T:40--> | <!--T:40--> | ||
sm_dedup_interface.exe -d 2 usage | 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 | 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: | <translate><!--T:104--> Common options:</translate> | ||
init -u <uuid> -t <label> initiate upper data store directory structure | init -u <uuid> -t <label> <translate><!--T:105--> initiate upper data store directory structure</translate> | ||
init -t <tape_spec> initiate lower data store directory structure | init -t <tape_spec> <translate><!--T:106--> initiate lower data store directory structure</translate> | ||
status get data store status | status <translate><!--T:107--> get data store status</translate> | ||
df get full summary of available and used disk space usage of file system | df <translate><!--T:108--> get full summary of available and used disk space usage of the file system</translate> | ||
du get used disk space usage of file system | du <translate><!--T:109--> get used disk space usage of the file system</translate> | ||
list|dir [<saveset>*] get saveset information | list|dir [<saveset>*] <translate><!--T:110--> get saveset information</translate> | ||
delete <saveset> [<saveset>*] | delete <saveset> [<saveset>*] | ||
remove saveset from data store | <translate><!--T:111--> remove saveset from the data store</translate> | ||
getlabel get data store label | getlabel <translate><!--T:112--> get data store label</translate> | ||
getpath get data store path | getpath <translate><!--T:113--> get data store path</translate> | ||
getuuid get data store uuid | getuuid <translate><!--T:114--> get data store uuid</translate> | ||
put < | put <<translate><!--T:115--> input_file_name</translate>> <<translate><!--T:116--> dest_file_name</translate>> [over] | ||
upload file into data store | <translate><!--T:117--> upload file into the data store</translate> | ||
get < | get <<translate><!--T:118--> remote_file_name</translate>> <<translate><!--T:119--> dest_file_name</translate>> [<<translate><!--T:120--> bytes skipped then</translate>> [<<translate><!--T:121--> bytes read at beginning</translate>>]] | ||
download file or | <translate><!--T:122--> download file or its part from the data store</translate> | ||
<translate><!--T:58--> | {{note|<translate><!--T:58--> Some of the parameters are for internal use or for the future use only.</translate>}} | ||
;status | ;status | ||
<translate><!--T:68--> Provides information about encryption, used space, saved data and object summary.</translate> | *<translate><!--T:68--> Provides information about the encryption, used space, saved data and object summary.</translate> | ||
bigsrv1:/var/opt/sesam/var/ini/stpd_conf # sm_dedup_interface -d 2 status | bigsrv1:/var/opt/sesam/var/ini/stpd_conf # sm_dedup_interface -d 2 status | ||
Line 118: | Line 109: | ||
Logical Storage Quota: Bytes All: -, Use: 239273889320, Free: -, Used: 0% | Logical Storage Quota: Bytes All: -, Use: 239273889320, Free: -, Used: 0% | ||
Physical Storage Quota: Bytes All: -, Use: 25270237105, Free -, Used: 0% | Physical Storage Quota: Bytes All: -, Use: 25270237105, Free -, Used: 0% | ||
<nowiki></nowiki> | |||
Object information: | Object information: | ||
Objects stored: 102 | Objects stored: 102 | ||
Line 125: | Line 116: | ||
Overall DeDup ratio: 1 / 9.80 | Overall DeDup ratio: 1 / 9.80 | ||
Saved storage space: 89.44 % | Saved storage space: 89.44 % | ||
<nowiki></nowiki> | |||
STATUS=SUCCESS MSG= | STATUS=SUCCESS MSG= | ||
Line 134: | Line 125: | ||
;delete <saveset> [<saveset>*] | ;delete <saveset> [<saveset>*] | ||
* <translate><!--T: | * <translate><!--T:123--> Deletes all given savesets from the HPE Catalyst store.</translate> | ||
;get | ;get | ||
* <translate><!--T: | * <translate><!--T:124--> Reads an object (file, saveset) from the HPE Catalyst store.</translate> | ||
* <translate><!--T:65--> '<tt>-</tt>' can be used to specify <tt> | * <translate><!--T:65--> '<tt>-</tt>' can be used to specify <tt>STDOUT</tt></translate> | ||
;put | ;put | ||
* <translate><!--T:66--> Writes an object (file, saveset) to the HPE Catalyst store.</translate> | * <translate><!--T:66--> Writes an object (file, saveset) to the HPE Catalyst store.</translate> | ||
* <translate><!--T:67--> '<tt>-</tt>' can be used to specify <tt> | * <translate><!--T:67--> | ||
'<tt>-</tt>' can be used to specify <tt>STDIN</tt></translate> | |||
=== | === {{anchor|logging}}<translate><!--T:125--> | ||
Logging === | |||
<!--T: | <!--T:137--> | ||
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 [[Special:MyLanguage/SEP_sesam_Glossary#VFSL|''VFS logging'']] records all VFS mount-related events when performing a single file restore (SFR). | |||
====STPD logging==== <!--T:138--> | |||
<!--T:139--> | |||
HPE Catalyst client library logging is written to the file <tt>gv_rw_sms:stpd_so_<day>.log</tt>, for example, logging file name <tt>/var/opt/sesam/var/log/sms/stpd_so_20190731.log</tt>. | |||
<!--T:127--> | |||
The log settings are defined with the log settings ''Log_Levels'' and ''Log_Size'' (in kilobytes (kB)) from the <tt>gv_rw_ini:stpd.ini</tt>.</translate> | |||
[STPD_Logging] | [STPD_Logging] | ||
Line 155: | Line 154: | ||
Log_Size=1024 | Log_Size=1024 | ||
<translate>====VFS logging==== <!--T:140--> | |||
<!--T:141--> | |||
VFS-related logs are stored in {{path|C:\Program Files\SEPsesam\var\log\lgc}} on Windows and | |||
in {{path|/var/opt/sesam/var/log/lgc}} on Linux. | |||
<!--T:142--> | |||
Logging information for single file restore (VFS mount) is written to the file <tt>gv_rw_sms:sm_vfs_so_<mount_process_ID><date>.log</tt>, for example, <tt>sm_vfs_so_9820_20190914.log</tt>. | |||
The | <!--T:143--> | ||
The log settings are defined with the log setting ''SM_VFS'' in <tt>gv_rw_ini:debug.ini</tt>. | |||
====Logging levels==== <!--T:128--> | |||
<!--T:129--> | |||
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:</translate> | |||
-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 | |||
<translate><!--T:130--> | |||
Autorotation occurs when the log file size reaches the maximum log size defined by ''Log_Size''. | |||
====Additional log settings==== <!--T:131--> | |||
<!--T:132--> | |||
The logging level settings defined in <tt>gv_rw_ini:stpd.ini</tt> can be overridden by specific settings in the HPE StoreOnce data store drive configuration file <tt>gv_rw_ini:stpd_conf/{name}_{drive_num}.ini</tt>. | |||
<!--T:133--> | |||
Example for {{path|/var/opt/sesam/var/ini/stpd_conf/HPE_Store_1_2.ini}} with increased logging level and size.</translate> | |||
[CATALYST] | [CATALYST] | ||
Log_Levels=5 | Log_Levels=5 | ||
Line 175: | Line 198: | ||
access_key="bigsrv1" | access_key="bigsrv1" | ||
secret_key={8494a4b4c4d4e4f4675bfe5226281414d14a58c0f514f524eda63797b8114749} | secret_key={8494a4b4c4d4e4f4675bfe5226281414d14a58c0f514f524eda63797b8114749} | ||
<nowiki></nowiki> | |||
[DISK_STORE] | [DISK_STORE] | ||
Storage_Location=/HPE_Store_1 | Storage_Location=/HPE_Store_1 | ||
Line 182: | Line 205: | ||
hostname=localhost | hostname=localhost | ||
<translate>=== HPE Catalyst store objects === <!--T:90--> | |||
<!--T: | <!--T:134--> | ||
For every SEP sesam saveset, there are two objects stored in the HPE Catalyst store:</translate> | |||
* <tt><ssid>.data</tt> | * <tt><ssid>.data</tt> | ||
* <tt><ssid>.info</tt> | * <tt><ssid>.info</tt> | ||
<translate><!--T:93--> The saveset data is stored in the <tt>.data</tt> file. The SEP sesam saveset attributes are | <translate><!--T:93--> | ||
The saveset data is stored in the <tt>.data</tt> file. The SEP sesam saveset attributes are recorded in the <tt>.info</tt> file. Both objects are identical to those of other data stores, e.g., the ''Path'' data store with the files <tt><ssid>.data</tt> and <tt><ssid>.info</tt>. | |||
<!--T:96--> | |||
After configuring the HPE StoreOnce | ==What is next?== | ||
After configuring the HPE StoreOnce data store, configure the [[Special:MyLanguage/Configuring_a_Media_Pool|media pools]], then set up your [[Special:MyLanguage/Backup_Strategy_Best_Practices|backup strategy]].</translate> | |||
<div class="noprint"> | <div class="noprint"><noinclude> | ||
{{Copyright}}</noinclude></div> | |||
Latest revision as of 13:34, 20 April 2023
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.
- For details on StoreOnce configuration, supported StoreOnce Catalyst extensions (HPE Cloud Bank Storage as a replication target and HPE Cloud Volumes as replication target or backup target), see HPE StoreOnce Configuration.
- For system requirements and supported configurations, see Support Matrix: SEP sesam integration with HPE StoreOnce Catalyst.
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.