Creating a Command Event

From SEPsesam
Jump to: navigation, search

Copyright © SEP AG 1999-2017. 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.

Draft.png WORK IN PROGRESS
This page is a draft. Treat the information on this page with caution as it may be incomplete.
Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3. For previous documentation version(s), check Documentation archive.


Overview

A command event allows the execution of an arbitrary program on a SEP sesam Client. As of SEP sesam version 4.4.2, new command events can be scheduled to run automatically.

Steps

  1. In the Main Selection -> Scheduling -> Schedules, select the schedule to which you would like to add a command event. Right-click it and select New command event. (If you have not configured a schedule yet, you have to configure it first by clicking the New schedule button in the Schedules window. For details, see Creating a Schedule.)
  2. New command event.png


  3. The New command event window is displayed. You can review the selected schedule parameters by clicking the Parameter tab where the following options can be defined:
    • Priority: optionally define a priority for the command event. SEPuler always executes schedules with the highest priority first. The default priority level is 1, which is the lowest priority. The highest priority level is 99. The only exceptions are schedules with priority 0, which override all other priorities and are always executed. For details, see SEPuler.
    • Blocking date: optionally this is used together with high priority for special events. If checked, it will block events of the same type of a lower priority, ensuring that the command event is processed when other command events are also scheduled at the same time.
    • Name: enter a name for the new event or search for and select an already existing command event. Searching for command opens a new window, where you can add a new command event, copy an already existing command event, select which existing command event you want to use again by clicking the Choose button, and delete an existing command event.
    • Select command.png


    • Client: select the client on which the command will be executed.
    • User: enter the user name of a user with sufficient access to execute the command on the client.
    • Command: enter the complete command and parameters if necessary, e.g., eventlog.ps.
  4. Click OK to add your command task to a schedule. You can review your schedules and assigned events, trigger immediate start of events or delete them by right-clicking the selected schedule.
SEP Tip.png Tip

You can also access the configured commands from the Menu Bar -> Configuration -> Command.

Setting permission to execute commands

Not every user on a specific client is authorized to execute all commands. Without additional entries authorizing selected users to run specific commands, the commands can only be run from the <SESAM_ROOT>/bin/sesam system directory. For a command to be executed from another directory before the regular backup starts, permissions must be granted by the target client.

UNIX

Copy the file sesam_cmdusers.allow from the <SESAM_ROOT>/skel directory to /etc on the client and modify the file. You will now be able to enter a line for the user and command using the {User} {command} format. If you use a wildcard (*), all commands will be executed.

No explicit permissions are required to execute SEP sesam commands such as sm_loader.

Windows

To set access rights for the user and command, use the following key: HKEY_LOCAL_MACHINE\SOFTWARE\SEP Elektronik GmbH\sesam\CommandEvents\{user}\{command}. Also, the entry CTRLD_Path=ID/bin/sesam;ID/bin/sms of the file ID/var/ini/sm.ini must be extended to include the directories where the desired programs reside.

  1. Open the Regedit editor.
  2. Go to HKEY_LOCAL_MACHINE\SOFTWARE\SEP Elektronik GmbH\sesam\ and create a new key called CommandEvents. If it does not already exist, right click and select "New Key" .
  3. Enter {user} and then {command} with the full path information as the key.

The available commands are:

*                 all commands
specific command  this command only
cmd /c            all DOS commands ( dir, etc. )
DOS-Command       this command only

If there are any other commands present, the last command will be executed. If you use a wildcard (*), all commands will be executed.

Registryentry.JPG

Below is an example of a registry file (*.reg) that allows all command events for the administrator and sesam user:

Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\SEP Elektronik GmbH\sesam\CommandEvents\sesam\*]
[HKEY_LOCAL_MACHINE\SOFTWARE\SEP Elektronik GmbH\sesam\CommandEvents\Administrator\*]

Information sign.png Note

The most common errors when setting up the desired user permissions and allowed commands are:

  • The necessary entries are not entered in the target client directories, not entered on the server or are entered incorrectly.
  • Instead of entering a command as a key, it is entered as a character string.

See also

Creating Follow-up EventsCreating a ScheduleAbout Scheduling