4 4 3 Beefalo:SEP sesam CLI: Difference between revisions

From SEPsesam
(In progress.)
(In progress.)
Line 17: Line 17:
The SEP sesam ''command line interface'' (CLI) is a utility that provides an alternate way of executing SEP sesam commands in UNIX and Windows environments. SEP sesam command line interface provides two CLI components: administration utility ''SEP sesam CLI'' and client utility ''[[SBC CLI]]''. The latter is used to back up and restore data '''locally on the host'''.  
The SEP sesam ''command line interface'' (CLI) is a utility that provides an alternate way of executing SEP sesam commands in UNIX and Windows environments. SEP sesam command line interface provides two CLI components: administration utility ''SEP sesam CLI'' and client utility ''[[SBC CLI]]''. The latter is used to back up and restore data '''locally on the host'''.  


SEP sesam CLI administration utility is used to install and configure a [[Special:MyLanguage/SEP_sesam_Glossary#SEP_sesam_environment|SEP sesam environment]] automatically without a GUI. CLI commands enables administrators to access '''SEP sesam database''' and '''manage the whole SEP sesam environment''', for example, to install, configure and manage SEP sesam servers and clients centrally without a GUI. Every CLI command (except a native SQL statement) checks and follows the internal structure and dependencies of the SEP sesam database.
SEP sesam CLI administration utility provides all of the functions available via SEP sesam graphical management interface and also additional CLI commands that are not available in the GUI. Note that different commands can be available depending on your SEP sesam license.
 
SEP sesam CLI commands can be used to install and configure a [[Special:MyLanguage/SEP_sesam_Glossary#SEP_sesam_environment|SEP sesam environment]] automatically without a GUI. They enable administrators to access SEP sesam database and manage the whole SEP sesam environment, for example, to install, configure and manage SEP sesam Servers and Clients centrally without a GUI. Every CLI command (except a native SQL statement) checks and follows the internal structure and dependencies of the SEP sesam database.


=== Features ===
=== Features ===
Line 26: Line 28:
* Get SEP sesam status, log and version information
* Get SEP sesam status, log and version information
* Determine SEP sesam object information for further use in other programs
* Determine SEP sesam object information for further use in other programs
===Running CLI commands===
You must have SEP sesam administrator privileges to run SEP sesam CLI commands and use the command prompt as an administrator. All commands are run from the {{Sesamroot|/bin/sesam/}} directory. If you want to execute SEP sesam commands globally (and not from the actual ''run directory''), set the SEP sesam profile as described in [[Special:MyLanguage/FAQ#profile_setting|What happens when I set a profile?]].


==Understanding the command structure==
==Understanding the command structure==
Line 39: Line 44:


===Command conventions===
===Command conventions===
The parameters for a command are order-dependent and might include mandatory and optional values, or keyword choices. Mandatory functions are designated by an asterisk (*).
 
The parameters for a command are order-dependent and might include required and optional values or keyword choices, depending on how the information is bracketed. Required parameters are marked with an asterisk (*). An example is provided below.
;| vertical bar:Separates the choices between two or more options or arguments.
;| vertical bar:Separates the choices between two or more options or arguments.
;[ ] square brackets:Indicate optional values.
;[ ] square brackets:Indicate optional values.
;< > angle brackets:Indicate that the enclosed element is mandatory.
;< > angle brackets:Indicate that the enclosed element is mandatory.
{{note|The commands are run in the command prompt from {{Sesamroot|/bin/sesam/}}.}} You must have administrator privileges to run CLI commands. Set the SEP sesam profile as described in [[Special:MyLanguage/FAQ#profile_setting|What happens when I set a profile?]] to be able to execute SEP sesam commands globally.
 
;Example:
 
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent [OPTIONS...]
One of the actions bracketed with < > symbols, in this case <tt><get|list|add|modify|backup|remove|restart></tt>, is required, while the [OPTIONS...] are enclosed with [ ] symbols, therefore the information requested is optional. The following options are available for our sample <tt>taskevent</tt> command.
 
OPTIONS:
    -@ [param]    follow up (command to be run after the event completes)
    -G [ID]        task group
    -S [ID]        name of the interface
    -Z [number]    stop task if it runs longer than (e.g. 8:00 means that the task is automatically stopped after 8 hours)
    -d [ID]        drive number
    -j [ID]        backup task
    -l [param]    backup level (C = Copy, F = Full, D = Differential, I = Incremental)
    -m [ID]     * media pool
    -s [0|1]       source-side deduplication
 
Let's say that we want to run a backup event for a backup task named ''win-cli_c_drive'' and use the target media pool (to which the data will be backed up) ''MP_disk_week''. The command would look like this:
 
sm_cmd backup taskevent -j win-cli_c_drive -m MP_disk_week
===Getting help===
 
To find out which parameters are available for a command, enter <tt>help</tt> after the command name. To list all available options, use the main help <tt>sm_cmd help</tt>. To show help for specific object, use <tt>sm_cmd help <object></tt>, for example, <tt>sm_cmd help client</tt>.


==={{anchor|action_commands}}Common action commands===
==={{anchor|action_commands}}Common action commands===
Line 74: Line 104:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#account|sm_cmd ''<nowiki><get|list|add|modify|remove|send></nowiki>'' account]]|| ||Create and administer email accounts. ||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#account|sm_cmd ''<nowiki><get|list|add|modify|remove|send></nowiki>'' account]]|| ||Create and administer email accounts. ||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#acl|sm_cmd ''<nowiki><get|list|remove|check></nowiki>'' acl]]|| ||Administer ACLs: List, check or remove ACLs.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#acl|sm_cmd ''<nowiki><get|list|remove|check></nowiki>'' acl]]|| ||List or delete access control list (ACL).||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#allevent|sm_cmd list allevent]]|| ||List all events.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#allevent|sm_cmd list allevent]]|| ||List all SEP sesam events.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#allresult|sm_cmd list allresult]]|| ||List all results.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#allresult|sm_cmd list allresult]]|| ||List all results within the specified time period.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#backup|sm_cmd backup]]||  || Start or stop the backup task or task group. ||
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#backup|sm_cmd backup]]||  || Start or stop the backup task or task group. ||
Line 94: Line 124:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#command|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' command]]|| ||Create and administer commands. ||  
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#command|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' command]]|| ||Create and administer commands. ||  
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#commandevent|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' commandevent]]|| ||Create and administer command events. ||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#commandevent|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' commandevent]]|| ||Create and administer command events. ||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#credential|sm_cmd ''<nowiki><get|list|add|modify|enable|disable|link|unlink|remove></nowiki>'' credential]]|| ||Configure and administer credentials.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#credential|sm_cmd ''<nowiki><get|list|add|modify|enable|disable|link|unlink|remove></nowiki>'' credential]]|| ||Configure and administer credentials.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#current|sm_cmd ''<nowiki><download|show></nowiki>'' current]]|| ||Display or download current drive information.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#current|sm_cmd ''<nowiki><download|show></nowiki>'' current]]|| ||Display or download the current drive information.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#datastore|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' datastore]]|| ||Create and administer data stores.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#datastore|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' datastore]]|| ||Create and administer data stores.||   
Line 104: Line 134:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#default|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' default]]|| ||Configure and administer default keys.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#default|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' default]]|| ||Configure and administer default keys.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#dir|sm_cmd ''<nowiki><argument></nowiki>'' dir]]|| ||List relevant clients, elements, VMs, etc.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#dir|sm_cmd dir ''<nowiki><argument></nowiki>'']]|| ||List all specified clients, elements, VMs, etc.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#drive|sm_cmd ''<nowiki><get|list|add|modify|remove|start|mount|dismount|unload></nowiki>'' drive]]|| ||Create and administer drives.||  
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#drive|sm_cmd ''<nowiki><get|list|add|modify|remove|start|mount|dismount|unload></nowiki>'' drive]]|| ||Create and administer drives.||  
Line 112: Line 142:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#group|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' group]]|| ||Create and administer user groups.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#group|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' group]]|| ||Create and administer user groups.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#interface|sm_cmd ''<nowiki><get|list|add|remove></nowiki>'' interface]]|| ||Create and administer interfaces.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#interface|sm_cmd ''<nowiki><get|list|add|remove></nowiki>'' interface]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#interfaces#|interfaces]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start_inventory|sm_cmd start inventory]]|| ||Start [[Special:MyLanguage/SEP_sesam_Glossary#archive_adjustment|archive adjustment]].||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start_inventory|sm_cmd start inventory]]|| ||Start [[Special:MyLanguage/SEP_sesam_Glossary#archive_adjustment|archive adjustment]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#license|sm_cmd ''<nowiki><show|update|report></nowiki>'' license]]|| ||Administer and monitor a license.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#license|sm_cmd ''<nowiki><show|update|report></nowiki>'' license]]|| ||Check the SEP sesam license information and update the license.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#loader|sm_cmd ''<nowiki><get|list|add|modify|remove|load|unload|import|export></nowiki>'' loader]]|| ||Create and administer loaders.||  
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#loader|sm_cmd ''<nowiki><get|list|add|modify|remove|load|unload|import|export></nowiki>'' loader]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#loader|loaders]].||  
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#loaderdevice|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' loaderdevice]]|| ||Create and administer loader devices.||  
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#loaderdevice|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' loaderdevice]]|| ||Create and administer loader devices.||  
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#location|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' location]]|| ||Create and administer locations.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#location|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' location]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#location|locations]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#log|sm_cmd ''<nowiki><download|show|list></nowiki>'' log]]|| ||Monitor and download log files or other information from the server.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#log|sm_cmd ''<nowiki><download|show|list></nowiki>'' log]]|| ||Monitor and download [[Special:MyLanguage/SEP_sesam_Glossary#logging|log files]] from the server.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#media|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' media]]|| ||Create and administer media.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#media|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' media]]|| ||Create and administer storage [[Special:MyLanguage/SEP_sesam_Glossary#medium|media]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#mediapool|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' mediapool]]|| ||Create and administer media pools.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#mediapool|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' mediapool]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#media_pool|media pools]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#mediapoolevent|sm_cmd ''<nowiki><get|list|add|modify|start|init|remove></nowiki>'' mediapoolevent]]|| ||Create and administer media pool events.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#mediapoolevent|sm_cmd ''<nowiki><get|list|add|modify|start|init|remove></nowiki>'' mediapoolevent]]|| ||Create and administer [[Special:MyLanguage/Creating_a_Media_Event|media events]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#migrate|sm_cmd migrate]]|| ||Start a migration immediately.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#migrate|sm_cmd migrate]]|| ||Start a migration immediately.||   
Line 138: Line 168:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#migrationtask|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' migrationtask]]|| ||Create and administer migration tasks.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#migrationtask|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' migrationtask]]|| ||Create and administer migration tasks.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#newdayevent|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' newdayevent]]|| ||Create and administer NEWDAY events.||  
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#newdayevent|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' newdayevent]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#NEWDAY|NEWDAY events]].||  
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#notification|sm_cmd ''<nowiki><get|list|add|modify></nowiki>'' notification]]|| ||Create and administer notifications.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#notification|sm_cmd ''<nowiki><get|list|add|modify></nowiki>'' notification]]|| ||Create and modify [[Special:MyLanguage/SEP_sesam_Glossary#notification|notifications]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#opersystem|sm_cmd ''<nowiki><get|list></nowiki>'' opersystem]]|| ||Monitor operating systems.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#opersystem|sm_cmd ''<nowiki><get|list></nowiki>'' opersystem]]||os||List a specific OS or all operating systems.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#render|sm_cmd render]]|| ||Render the template.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#render|sm_cmd render]]|| ||Renders the specified template.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#list_restart|sm_cmd ''<nowiki><list|restart></nowiki>'']]|| ||Check or restart backups/migrations.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#list_restart|sm_cmd ''<nowiki><list|restart></nowiki>'']]|| ||Check and restart backups/migrations.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#restoreevent|sm_cmd ''<nowiki><get|list|add|modify|restore|start|remove></nowiki>'' restoreevent]]|| ||Create and administer restore events.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#restoreevent|sm_cmd ''<nowiki><get|list|add|modify|restore|start|remove></nowiki>'' restoreevent]]|| ||Create and administer restore events.||   
Line 152: Line 182:
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#restoretask|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' restoretask]]|| ||Create and administer restore tasks.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#restoretask|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' restoretask]]|| ||Create and administer restore tasks.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#result|sm_cmd ''<nowiki><get|list></nowiki>'' result]]|| ||Monitor results.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#result|sm_cmd ''<nowiki><get|list></nowiki>'' result]]|| ||Monitor the results according to set filters (e.g., clients, tasks).||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start_report|sm_cmd start report]]|| ||Create a customized report.|| 
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#saveset|sm_cmd <dir> saveset]]|| ||Browse for the saveset ID.||   
|-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#saveset|sm_cmd dir saveset]]|| ||Browse for the saveset ID.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#schedule|sm_cmd ''<nowiki><get|list|add|modify|rename|remove|start></nowiki>'' schedule]]|| ||Configure and administer schedules. ||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#schedule|sm_cmd ''<nowiki><get|list|add|modify|rename|remove|start></nowiki>'' schedule]]|| ||Configure and administer schedules. ||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#services|sm_cmd ''<nowiki><download|show></nowiki>'' services]]|| ||Monitor or download different files or logs.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#services|sm_cmd ''<nowiki><download|show></nowiki>'' services]]|| ||Monitor and download different files or logs.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#session|sm_cmd list session]]|| ||List all sessions.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#session|sm_cmd list session]]|| ||List all active sessions.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#sql|sm_cmd sql]]|| ||      ||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#sql|sm_cmd sql]]|| ||      ||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start|sm_cmd start ''<nowiki><task|restore|migration|command></nowiki>'']]|| || Start an event.   ||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start|sm_cmd start ''<nowiki><task|restore|migration|command></nowiki>'']]|| ||Start an [[Special:MyLanguage/SEP_sesam_Glossary#event|event]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#task|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' task]]|| ||Create and administer tasks.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#start_report|sm_cmd start report]]|| ||Create a customized report.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskevent|sm_cmd ''<nowiki><get|list|add|modify|backup|remove|restart></nowiki>'' taskevent]]|| ||Create and administer task events.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#task|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' task]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#task|tasks]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgen|sm_cmd add taskgen]]|| ||Generate tasks.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskevent|sm_cmd ''<nowiki><get|list|add|modify|backup|remove|restart></nowiki>'' taskevent]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#event|task events]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgroup|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' taskgroup]]|| ||Create and administer task groups.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgen|sm_cmd add taskgen]]|| ||Generate tasks according to the specified [[Special:MyLanguage/SEP_sesam_Glossary#task_type|task type]].|| 
|-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgroup|sm_cmd ''<nowiki><get|list|add|modify|start|remove></nowiki>'' taskgroup]]|| ||Create and administer [[Special:MyLanguage/SEP_sesam_Glossary#task_group|task groups]].||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgrouprelation|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' taskgrouprelation]]|| ||Create and administer task group relations.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#taskgrouprelation|sm_cmd ''<nowiki><get|list|add|modify|remove></nowiki>'' taskgrouprelation]]|| ||Create and administer task group relations.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#update|sm_cmd ''<nowiki><download|list></nowiki>'' update]]|| ||Monitor and download JRE updates.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#update|sm_cmd ''<nowiki><download|list></nowiki>'' update]]|| ||Monitor and download JAR (<tt>.jar</tt>) updates.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#user|sm_cmd ''<nowiki><get|list|add|modify|remove|reset></nowiki>'' user]]|| ||Administer users: Reset a user password and list, create, modify or remove users.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#user|sm_cmd ''<nowiki><get|list|add|modify|remove|reset></nowiki>'' user]]|| ||Create and administer users.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#version|sm_cmd show version]]|| ||Display SEP sesam Server and Client package version.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#version|sm_cmd show version]]|| ||Display SEP sesam Server and Client package version.||   
  |-
  |-
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#vsphere|sm_cmd ''<nowiki><resetcbt|check|generate|list></nowiki>'' vsphere]]|| ||Reset CBT and administer vSphere.||   
|[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#vsphere|sm_cmd ''<nowiki><resetcbt|check|generate|list></nowiki>'' vsphere]]|| ||Reset CBT, monitor vSphere environment and generate vSphere task group.||   
  |-
  |-
  |}
  |}
Line 553: Line 583:


;Description: By using [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#action_commands|action commands]] – <tt>get, list</tt> – you can get a single result and list all results (listed in main help <tt>sm_cmd help</tt>).
;Description: By using [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#action_commands|action commands]] – <tt>get, list</tt> – you can get a single result and list all results (listed in main help <tt>sm_cmd help</tt>).
==={{anchor|start_report}}(START) REPORT===
;Usage:
sm_cmd start report [OPTIONS...]
;Description: By using the <tt>start report</tt> command you can create a customized report. Templates are installed in the <tt><SESAM_BIN>/skel/templates/rythm</tt> directory.


==={{anchor|saveset}}SAVESET===
==={{anchor|saveset}}SAVESET===
Line 581: Line 604:


;Description: By using the [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#action_commands|<tt>list session</tt> command]] you can list all sessions (listed in main help <tt>sm_cmd help</tt>).
;Description: By using the [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_CLI#action_commands|<tt>list session</tt> command]] you can list all sessions (listed in main help <tt>sm_cmd help</tt>).
==={{anchor|start_report}}START REPORT===
;Usage:
sm_cmd start report [OPTIONS...]
;Description: By using the <tt>start report</tt> command you can create a customized report. Templates are installed in the <tt><SESAM_BIN>/skel/templates/rythm</tt> directory.


==={{anchor|update}}UPDATE JAR===
==={{anchor|update}}UPDATE JAR===

Revision as of 17:56, 21 November 2019

Draft.png WORK IN PROGRESS
This is a draft document for the SEP sesam upcoming 4.4.3 Beefalo V2 release. Note that the article is in the initial stage and may be updated, replaced or deleted at any time. It is inappropriate to use this document as reference material as it is a work in progress and should be treated as such.

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.

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3/4.4.3 Beefalo. For previous documentation version(s), check documentation archive.


Overview

The SEP sesam command line interface (CLI) is a utility that provides an alternate way of executing SEP sesam commands in UNIX and Windows environments. SEP sesam command line interface provides two CLI components: administration utility SEP sesam CLI and client utility SBC CLI. The latter is used to back up and restore data locally on the host.

SEP sesam CLI administration utility provides all of the functions available via SEP sesam graphical management interface and also additional CLI commands that are not available in the GUI. Note that different commands can be available depending on your SEP sesam license.

SEP sesam CLI commands can be used to install and configure a SEP sesam environment automatically without a GUI. They enable administrators to access SEP sesam database and manage the whole SEP sesam environment, for example, to install, configure and manage SEP sesam Servers and Clients centrally without a GUI. Every CLI command (except a native SQL statement) checks and follows the internal structure and dependencies of the SEP sesam database.

Features

  • Automatic configuration of SEP sesam environments after installation (e.g., on implementation)
  • Change the SEP sesam configuration without using the SEP sesam GUI
  • Script-based mass installation and configuration (e.g., provider environment)
  • Operate tests for installation and configuration in SEP sesam environments
  • Get SEP sesam status, log and version information
  • Determine SEP sesam object information for further use in other programs

Running CLI commands

You must have SEP sesam administrator privileges to run SEP sesam CLI commands and use the command prompt as an administrator. All commands are run from the <SESAM_ROOT>/bin/sesam/ directory. If you want to execute SEP sesam commands globally (and not from the actual run directory), set the SEP sesam profile as described in What happens when I set a profile?.

Understanding the command structure

The SEP sesam general syntax for a CLI command is:

sm_cmd <command> [–option] [<object>] [[–<parameter>] <value>]

where the following information is provided for each command

  • sm_cmd: A command line tool that invokes the command line interface.
  • Usage: The actual syntax of the command, including the arguments.
  • Description: A brief summary of what the command does.
  • Arguments: The definition of options used in the command.
  • Example: Example of the command usage of the specified command and its options.

Command conventions

The parameters for a command are order-dependent and might include required and optional values or keyword choices, depending on how the information is bracketed. Required parameters are marked with an asterisk (*). An example is provided below.

| vertical bar
Separates the choices between two or more options or arguments.
[ ] square brackets
Indicate optional values.
< > angle brackets
Indicate that the enclosed element is mandatory.
Example
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent [OPTIONS...]

One of the actions bracketed with < > symbols, in this case <get|list|add|modify|backup|remove|restart>, is required, while the [OPTIONS...] are enclosed with [ ] symbols, therefore the information requested is optional. The following options are available for our sample taskevent command.

OPTIONS:
    -@ [param]     follow up (command to be run after the event completes)
    -G [ID]        task group
    -S [ID]        name of the interface
    -Z [number]    stop task if it runs longer than (e.g. 8:00 means that the task is automatically stopped after 8 hours)
    -d [ID]        drive number
    -j [ID]        backup task
    -l [param]     backup level (C = Copy, F = Full, D = Differential, I = Incremental)
    -m [ID]      * media pool
    -s [0|1]       source-side deduplication

Let's say that we want to run a backup event for a backup task named win-cli_c_drive and use the target media pool (to which the data will be backed up) MP_disk_week. The command would look like this:

sm_cmd backup taskevent -j win-cli_c_drive -m MP_disk_week

Getting help

To find out which parameters are available for a command, enter help after the command name. To list all available options, use the main help sm_cmd help. To show help for specific object, use sm_cmd help <object>, for example, sm_cmd help client.

Common action commands

The action command is used to perform an action or retrieve information/status about the resource. Most SEP sesam CLI resources have the following action commands:

get
The get command retrieves information about the resource or the operation that is currently defined.
list
The list command returns a list of objects for the specified resource. If the optional <object_name_or_id> is also specified, then the results are filtered by that value.
add
The add command creates a new object or event. If the optional <object_name_or_id> is also specified, then the objects are created according to the specified value.
modify
The modify command changes an existing resource based on the specified object options.
remove
The remove command deletes the specified object.

Before you begin

SEP sesam CLI is a very powerful command-line tool. You should be aware of its implications on your entire environment before you start using it.

Recommendations for using the SEP sesam CLI

  • SEP sesam's optional command line commands are written directly to the SEP sesam database. Therefore all command line entries should be checked and verified!
  • SEP sesam executes the commands immediately the <Enter>/<Return> key is pressed, which means that entries cannot be corrected, as is the case with the SEP Sesam GUI. It is extremely important that you are familiar with CLI and use it cautiously in order not to cause a system failure of the backup environment. Note that an erroneous entry can lead to complete data loss or other damage to the database. Such mistakes can void the warranty of your SEP sesam licensing agreement.
  • Have a look at a CLI configuration example for the creation of a new SEP sesam environment by SEP sesam CLI. Only after becoming familiar with SEP sesam should you attempt to use the CLI and write your first scripts.
Information sign.png Note
Before you start scripting with the SEP sesam CLI, you should familiarize yourself with the SEP sesam environment. Read the SEP sesam documentation carefully and work on the SEP sesam installation to understand how the SEP sesam objects work together.

SEP sesam CLI usage

Command Alias Description Note
sm_cmd CLI main call Each command is preceded by sm_cmd that invokes the command line interface.
sm_cmd <get|list|add|modify|remove|send> account Create and administer email accounts.
sm_cmd <get|list|remove|check> acl List or delete access control list (ACL).
sm_cmd list allevent List all SEP sesam events.
sm_cmd list allresult List all results within the specified time period.
sm_cmd backup Start or stop the backup task or task group.
sm_cmd clear cache Clear the entire server cach.
sm_cmd <get|list|add|modify|remove> calendar Create and administer calendars.
sm_cmd <get|list|add|modify|remove> calendarevent Create and administer calendar events.
sm_cmd <download|show> calendarsheet Display or download calendar information.
sm_cmd <get|list|add|modify|remove|dir> client Create and administer clients.
sm_cmd <get|list|add|modify|start|remove> command Create and administer commands.
sm_cmd <get|list|add|modify|remove> commandevent Create and administer command events.
sm_cmd <get|list|add|modify|enable|disable|link|unlink|remove> credential Configure and administer credentials.
sm_cmd <download|show> current Display or download the current drive information.
sm_cmd <get|list|add|modify|remove> datastore Create and administer data stores.
sm_cmd <get|list|add|modify|remove> default Configure and administer default keys.
sm_cmd dir <argument> List all specified clients, elements, VMs, etc.
sm_cmd <get|list|add|modify|remove|start|mount|dismount|unload> drive Create and administer drives.
sm_cmd <get|list|add|modify|remove> drivegroup Create and administer drive groups.
sm_cmd <get|list|add|modify|remove> group Create and administer user groups.
sm_cmd <get|list|add|remove> interface Create and administer interfaces.
sm_cmd start inventory Start archive adjustment.
sm_cmd <show|update|report> license Check the SEP sesam license information and update the license.
sm_cmd <get|list|add|modify|remove|load|unload|import|export> loader Create and administer loaders.
sm_cmd <get|list|add|modify|remove> loaderdevice Create and administer loader devices.
sm_cmd <get|list|add|modify|remove> location Create and administer locations.
sm_cmd <download|show|list> log Monitor and download log files from the server.
sm_cmd <get|list|add|modify|remove> media Create and administer storage media.
sm_cmd <get|list|add|modify|remove> mediapool Create and administer media pools.
sm_cmd <get|list|add|modify|start|init|remove> mediapoolevent Create and administer media events.
sm_cmd migrate Start a migration immediately.
sm_cmd <get|list|add|modify|remove|start> migration Create and administer migration events.
sm_cmd <get|list|add|modify|remove> migrationtask Create and administer migration tasks.
sm_cmd <get|list|add|modify|start|remove> newdayevent Create and administer NEWDAY events.
sm_cmd <get|list|add|modify> notification Create and modify notifications.
sm_cmd <get|list> opersystem os List a specific OS or all operating systems.
sm_cmd render Renders the specified template.
sm_cmd <list|restart> Check and restart backups/migrations.
sm_cmd <get|list|add|modify|restore|start|remove> restoreevent Create and administer restore events.
sm_cmd <get|list|add|modify|start|remove> restoretask Create and administer restore tasks.
sm_cmd <get|list> result Monitor the results according to set filters (e.g., clients, tasks).
sm_cmd <dir> saveset Browse for the saveset ID.
sm_cmd <get|list|add|modify|rename|remove|start> schedule Configure and administer schedules.
sm_cmd <download|show> services Monitor and download different files or logs.
sm_cmd list session List all active sessions.
sm_cmd sql
sm_cmd start <task|restore|migration|command> Start an event.
sm_cmd start report Create a customized report.
sm_cmd <get|list|add|modify|start|remove> task Create and administer tasks.
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent Create and administer task events.
sm_cmd add taskgen Generate tasks according to the specified task type.
sm_cmd <get|list|add|modify|start|remove> taskgroup Create and administer task groups.
sm_cmd <get|list|add|modify|remove> taskgrouprelation Create and administer task group relations.
sm_cmd <download|list> update Monitor and download JAR (.jar) updates.
sm_cmd <get|list|add|modify|remove|reset> user Create and administer users.
sm_cmd show version Display SEP sesam Server and Client package version.
sm_cmd <resetcbt|check|generate|list> vsphere Reset CBT, monitor vSphere environment and generate vSphere task group.

Administration and configuration commands

The following are the commands that allow you to execute the administrator’s tasks for SEP sesam.

(EMAIL) ACCOUNT (account)

Usage
sm_cmd <get|list|add|modify|remove|send> account [OPTIONS...] 
Description
By using action commandsget, list, add, modify, remove – you can get a single email account, list all email accounts depending on list options (listed in main help sm_cmd help), create a new email account, modify an existing account, and delete the specified account. Additionally, you can send a message to the given email account and attach multiple local files by using send mail [OPTIONS...] ID.

ACL

Usage
sm_cmd <get|list|remove|check> acl [OPTIONS...] 
Description
By using action commandsget, list, remove – you can get a single access control list (acl), list all ACL entries depending on list options (listed in main help sm_cmd help) or list all ACL entries of a given user and/or object, and delete the specified ACL (ID=all will delete all configured ACLs).

BACKUP

Usage
sm_cmd backup  [OPTIONS...]
Description
By using the backup command you can start or stop the task or task group backup according to the specified parameters.

CLEAR CACHE

Usage
sm_cmd clear cache [OPTIONS...]

or

sm_cmd clear cache -t
Description
By using the clear cache command you can clear the entire server cache according to the specified parameters; the '-t' parameter sets table filter for clear cache.

CALENDAR

Usage
sm_cmd <get|list|add|modify|remove> calendar [OPTIONS...] 
Description
By using action commandsget, list, add, modify, remove – you can get a single calendar, list all calendars depending on list options (listed in main help sm_cmd help), create a new calendar with an automatically generated ID, modify a calendar and delete a calendar; ID can be a character string ID or a numeric ID value.

CALENDAR EVENT (calendarevent)

Usage
sm_cmd <get|list|add|modify|remove> calendarevent [OPTIONS...] 
Description
By using action commandsget, list, add, modify, remove – you can get a single calendar event, list all calendar events depending on list options (listed in main help sm_cmd help), create a new calendar event, modify a calendar event and delete a calendar event.

CLIENT

Usage
sm_cmd <get|list|add|modify|remove|dir> client [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove, dir – you can get a single client, list all clients depending on list options (listed in main help sm_cmd help), create a new client, modify a client, delete a client and browse directory of the client.

COMMAND

Usage
sm_cmd <get|list|add|modify|start|remove> command [OPTIONS...]
      
Description
By using action commandsget, list, add, modify, start, remove – you can get a single command, list all commands depending on list options (listed in main help sm_cmd help), create a new command, modify a command, execute a command and delete a command.

COMMAND EVENT (commandevent)

Usage
sm_cmd <get|list|add|modify|remove> commandevent [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single command event, list all events depending on list options (listed in main help sm_cmd help), create a new command event with an automatically generated ID, modify a command event, and remove a command event.

CREDENTIAL

Usage
sm_cmd <get|list|add|modify|enable|disable|link|unlink|remove> credential [OPTIONS...]
Description
By using action commandsget, list, add, modify, enable, disable, link, unlink, remove – you can get an existing credential set by ID or name, list all credential sets depending on list options (listed in main help sm_cmd help), add a new credential set, modify an existing credential set by ID or name, and link/unlink a credential set to/from a SEP sesam object, i.e., data store. You can also delete a credential set by ID or name if there are no more references. In case of LDAP or AD credential sets, you can enable or disable a credential set by ID or name.

DATA STORE (datastore)

Usage
sm_cmd <get|list|add|modify|remove> datastore [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single data store, list all data stores depending on list options (listed in main help sm_cmd help), create a new data store, modify a data store, and remove a data store with all dependencies.

DEFAULT KEY (default)

Usage
sm_cmd <get|list|add|modify|remove> default [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a value of the default key, list all default keys (listed in main help sm_cmd help), add a new default key and its value, modify a value of the default key, and delete a given default key.

DRIVE

Usage
sm_cmd <get|list|add|modify|remove|start|mount|dismount|unload> drive [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove, start, mount, dismount, unload – you can get a single drive, list all drives (listed in main help sm_cmd help), create a new drive with an automatically generated ID, and modify, delete, configure and mount/dismount a drive. You can also release and eject the tape in the drive.

DRIVE GROUP (drivegroup)

Usage
sm_cmd <get|list|add|modify|remove> drivegroup [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single drive group, list all drive groups (listed in main help sm_cmd help), create a new drive group, modify a drive group, and delete a drive group.

(USER) GROUP (group)

Usage
sm_cmd <get|list|add|modify|remove> group [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single user group, list all user groups (listed in main help sm_cmd help), create a new user group, modify a user group, and delete a user group.

INTERFACE

Usage
sm_cmd <get|list|add|remove> interface [OPTIONS...]
Description
By using action commandsget, list, add, remove – you can get a single interface, list all interfaces (listed in main help sm_cmd help), create a new interface, and delete selected interface.

INVENTORY (start inventory)

Usage
sm_cmd start inventory [OPTIONS...]
Description
By using the start inventory command you can start archive adjustment to make a comparison between media in the loader carousel or magazine and the SEP sesam media archive database.

LICENSE

Usage
sm_cmd <show|update|report> license [OPTIONS...]
Description
By using update, show and report commands you can update the current license, however, you first have to back up an old license. You can also display the current license information and generate a report of the license.

LOADER

Usage
sm_cmd <get|list|add|modify|remove|load|unload|import|export> loader [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove, load, unload, import, export – you can get a single loader, list all loaders (listed in main help sm_cmd help), create a new loader with a specified ID or an automatically generated ID, and modify, delete, load/unload and import/export a loader.

LOADER DEVICE (loaderdevice)

Usage
sm_cmd <get|list|add|modify|remove> loaderdevice [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single loader device, list all loader devices (listed in main help sm_cmd help) and create a new loader device if a loader already exists by specifying a loader ID and a slot. You can also modify or delete an existing loader.

LOCATION

Usage
sm_cmd <get|list|add|modify|remove> location [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single location where an ID can be a character string or a numeric ID value, list all locations (listed in main help sm_cmd help), create a new location with an automatically generated ID, modify a location, and delete a location.

MEDIA

Usage
sm_cmd <get|list|add|modify|remove> media [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single medium, list all media (listed in main help sm_cmd help), add a new medium to the media archive (a media label is set automatically), modify a medium, and remove a medium data set from the archive if a drive/EOL is not active.

MEDIA POOL (mediapool)

Usage
sm_cmd <get|list|add|modify|remove> mediapool [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single media pool, list all media pools (listed in main help sm_cmd help), create a new media pool, modify an existing media pool, and delete a media pool.

MEDIA POOL EVENT (mediapoolevent)

Usage
sm_cmd <get|list|add|modify|start|init|remove> mediapoolevent [OPTIONS...]
Description
By using action commandsget, list, add, modify, start, init, remove – you can get a single media pool event, list all media pool events (listed in main help sm_cmd help), create a new media pool event, modify an existing media pool event, start a media pool event, initialize a media pool immediately, and remove a single media pool event by ID or remove all media pool events of the specified schedule.

MIGRATION (migrate)

Usage
sm_cmd migrate  [OPTIONS...]
Description
By using migrate command you can start a migration immediately.

MIGRATION EVENT (migration)

Usage
sm_cmd <get|list|add|modify|remove|start> migration [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove, start – you can get a single migration event, list all migration events (listed in main help sm_cmd help), create a new migration event with an automatically generated ID, modify an existing migration event, start a migration event immediately, and remove a single migration event by ID or remove all migration events of the specified schedule.

MIGRATION TASK (migrationtask)

Usage
sm_cmd <get|list|add|modify|remove> migrationtask [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get a single migration task, list all migration tasks (listed in main help sm_cmd help), create a new migration task, modify an existing migration task, and delete a migration task.

NEWDAY EVENT (newdayevent)

Usage
sm_cmd <get|list|add|modify|start|remove> newdayevent [OPTIONS...]
Description
By using action commandsget, list, add, modify, start, remove – you can get a single NEWDAY event, list all NEWDAY events (listed in main help sm_cmd help), create a new NEWDAY event with an automatically generated ID, modify a NEWDAY event, start a NEWDAY event immediately, and delete a NEWDAY event.

NOTIFICATION

Usage
sm_cmd <get|list|add|modify> notification [OPTIONS...]
Description
By using action commandsget, list, add, modify – you can get a selected notification, list all notifications (listed in main help sm_cmd help), create a new notification, and modify a single notification or all notifications for one object.

RENDER

Usage
sm_cmd render  [OPTIONS...]
Description
By using the render command you can render the template with the specified input data.

RESTART BACKUPS/MIGRATIONS (<list|restart>)

Usage
sm_cmd <list|restart>  [OPTIONS...]
Description
By using the list and restart commands you can list all results where the backups/migrations can be restarted and then restart selected backup/migration.

RESTORE EVENT (restoreevent)

Usage
sm_cmd <get|list|add|modify|restore|start|remove> restoreevent [OPTIONS...]
Description
By using action commandsget, list, add, modify, restore, start, remove – you can get a single restore event, list all restore events (listed in main help sm_cmd help), create a new restore event with an automatically generated ID, modify an existing restore event, add and start a restore job by creating a new restore task and a restore event, start a restore immediately, and remove a single restore event by ID or remove all restore events of the specified schedule.

RESTORE TASK (restoretask)

Usage
sm_cmd <get|list|add|modify|start|remove> restoretask [OPTIONS...]
Description
By using action commandsget, list, add, modify, start, remove – you can get a single restore task, list all restore tasks (listed in main help sm_cmd help), create a new restore task, modify an existing restore task, add and start a restore job by creating a new restore task and restore event, start a restore of the selected restore task immediately, and delete a restore task.

SCHEDULE

Usage
sm_cmd <get|list|add|modify|rename|remove|start> schedule [OPTIONS...]
Description
By using action commandsget, list, add, modify, rename, remove, start – you can get a single schedule, list all schedules (listed in main help sm_cmd help), create a new schedule, modify or rename an existing schedule, delete a schedule, and start all events of the specified schedule immediately.

SQL

Usage
sm_cmd sql  [OPTIONS...]
Description

START

Usage
sm_cmd  start <task|restore|migration|command> [OPTIONS...]
Description

By using the start command you can start an event, e.g., backup, restore, migration, etc.

TASK

Usage
sm_cmd <get|list|add|modify|start|remove> task [OPTIONS...]
Description
By using action commandsget, list, add, modify, start, remove – you can get a single task, list all tasks (listed in main help sm_cmd help), create a new task, modify existing task, delete a task, and start a task or all tasks in the task group immediately.

TASK EVENT (taskevent)

Usage
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent [OPTIONS...]
Description
By using action commandsget, list, add, modify, backup, remove, restart – you can get a single task event, list all task events (listed in main help sm_cmd help), create a new task event with an automatically generated ID, modify an existing task event, start a backup task or task group immediately, remove a single task event by ID or remove all task events of the specified schedule, and restart a backup/migration of given results by saveset or by single SEP sesam day. If a single SEP sesam day is specified, only failed backups will be restarted.

(GENERATE) TASKS (taskgen)

Usage
sm_cmd add taskgen [OPTIONS...]
Description
By using add taskgen command you can generate tasks of the specified task type.

TASK GROUP (taskgroup)

Usage
sm_cmd <get|list|add|modify|start|remove> taskgroup [OPTIONS...]
Description
By using action commandsget, list, modify, start, remove – you can get a single task group, list all task groups (listed in main help sm_cmd help), create a new task group, modify an existing task event, start all backup tasks of the specified task group immediately, and remove the specified task group with all relations to the tasks.

TASK GROUP RELATIONS (taskgrouprelation)

Usage
sm_cmd <get|list|add|modify|remove> taskgrouprelation [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove – you can get task group relations for the specified task group (listed in main help sm_cmd help), list all task group relations, create a new task group relation, modify an existing task group relation, and delete a specified task group relation.

USER

Usage
sm_cmd <get|list|add|modify|remove|reset> user [OPTIONS...]
Description
By using action commandsget, list, add, modify, remove, reset – you can get a single user, list all users (listed in main help sm_cmd help), create a new user, modify an existing user, delete a user, and reset a password of the specified user if you are logged in to SEP sesam Server console.

vSPHERE

Usage
sm_cmd <resetcbt|check|generate|list> vsphere [OPTIONS...]
Description
By using action commandsresetcbt, check, generate, list – you can reset CBT via task name or directly via VM name and vSphere server input, check the details about vSphere client, generate vSphere, and list license information or VM snapshots.

Monitoring commands

The following are the commands that display information about SEP sesam environment.

ALL EVENTS (allevent)

Usage
sm_cmd list allevent [OPTIONS...]

or

sm_cmd list [LIST OPTIONS] allevent [FILTER OPTIONS...]

Description
By using the list allevent command you can list all events or list all events depending on list options (listed in main help sm_cmd help) in a table format.

ALL RESULTS (allresult)

Usage
sm_cmd list allresult [OPTIONS...]

or

sm_cmd list [LIST OPTIONS] allresult [FILTER OPTIONS...]
Description
By using the list allresult command you can list all results or list all results depending on list options (listed in main help sm_cmd help).

CALENDAR SHEET (calendarsheet)

Usage
sm_cmd <download|show> calendarsheet [OPTIONS...]
Description
By using the download/show calendarsheet command you can display or download calendar information for the specified time frame.

CURRENT DRIVE (current)

Usage
sm_cmd <download|show> current [OPTIONS...]
Description
By using the show/download current command you can display or download the current drive information from the server.

DIR

Usage
sm_cmd dir <argument> [OPTIONS...]
Description
By using the dir command you can list all configured clients, list all elements with task type Path for a client, list root directory of the client, list VMware content of the client, list all VMs, and list VMs of the vCenter.

LOG

Usage
sm_cmd <download|show|list> log 
Description
By using the download/show/list log command you can download log files or other information from the server to the local file system, display the content of log files or other information from the server, and list available log files or other files.

OPERATING SYSTEM (opersystem)

Usage
sm_cmd <get|list> opersystem [OPTIONS...]
Description
By using action commandsget, list – you can get a single operating system and list all operating systems (listed in main help sm_cmd help).

RESULT

Usage
sm_cmd <get|list> result [OPTIONS...]
Description
By using action commandsget, list – you can get a single result and list all results (listed in main help sm_cmd help).

SAVESET

Usage
sm_cmd dir saveset [OPTIONS...]
Description
By using the dir saveset command you can browse for the relevant saveset ID.

SERVICES

Usage
sm_cmd <download|show> services [OPTIONS...]
Description
By using the download/show services command you can display or download different files or logs, e.g., restore log, backup log, etc.

SESSION

Usage
sm_cmd list session [OPTIONS...]
Description
By using the list session command you can list all sessions (listed in main help sm_cmd help).

START REPORT

Usage
sm_cmd start report [OPTIONS...]
Description
By using the start report command you can create a customized report. Templates are installed in the <SESAM_BIN>/skel/templates/rythm directory.

UPDATE JAR

Usage
sm_cmd <download|list> update [OPTIONS...]
Description
By using the download/list update command you can list available JAR updates and download one or more JAR updates from the server.

VERSION

Usage
sm_cmd show version [OPTIONS...]
Description
By using the show version command you can display version of the SEP sesam Server and Client package.

Troubleshooting commands

The following are the commands that allow you to troubleshoot the SEP sesam environment.