4 4 3 Beefalo:SEP sesam CLI

From SEPsesam
Revision as of 13:00, 20 November 2019 by Sta (talk | contribs) (Update in progress.)
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 is used to install and configure a 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.

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

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 mandatory and optional values, or keyword choices. Mandatory functions are designated by an asterisk (*).

| 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.
Information sign.png Note
The commands are run in the command prompt from <SESAM_ROOT>/bin/sesam/.

You must have administrator privileges to run CLI commands. Set the SEP sesam profile as described in What happens when I set a profile? to be able to execute SEP sesam commands globally.

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 Administer ACLs: Reset a user password and list, check or remove ACLs.
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events
sm_cmd list allevent List all events

Administration 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.

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).

RENDER

Usage
sm_cmd render  [OPTIONS...]
Description
By using the render command you can render the specified template with the given 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.

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).

Configuration commands

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

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.

Monitoring commands

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

LIST ALL EVENTS (allevent)

Usage
sm_cmd list allevent [OPTIONS...]

or

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

Description
By using the list 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.

LIST ALL RESULTS (allresult)

Usage
sm_cmd list allresult [OPTIONS...]

or

sm_cmd list [LIST OPTIONS] allresult [FILTER OPTIONS...]
Description
By using the list command you can list all results or list all resultss 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 show or download 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 or download 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 and list 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.

START REPORT

Usage
sm_cmd start report [OPTIONS...]
Description
By using the start report command you can create a specified report; file name of the template in \skel\templates\rythm\reports.

SAVESET

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

Troubleshooting commands

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