4 4 3 Beefalo:SEP sesam CLI

From SEPsesam
Revision as of 12:10, 19 November 2019 by Sta (talk | contribs)
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.

ACCOUNT (email)

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...] ('*' denotes a required parameter)
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).

Configuration commands

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



Monitoring commands

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

List all events

Usage
sm_cmd list allevent [OPTIONS...]

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

  List all events depending on list options in a table format.
LIST OPTIONS:
  Listed in main help ("sm_cmd help")
FILTER OPTIONS:


Example:

       > sm_cmd list allevent
       > sm_cmd list -C "object,task,schedule" allevent

List all results

Troubleshooting commands

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