create-event

Syntax

tadm create-event common_options [--no-enabled] --config=config_name 
--command=restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline ((--time=hh:mm [--month=1-12] 
[--day-of-week=sun|mon|tue|wed|thu|fri|sat] [--day-of-month=1-31]) | --interval=number_of_seconds))

Description

Use this command to create a new event. Additionally, you can set a specific time and interval for scheduling automatic instance reconfiguration. You can also create an event to restart and reconfigure all running instances, rotate access and error logs, and update the certificate revocation list. Also, you can provide the absolute path to a file to be executed.

Options

For information about common_options, run the help command.

--no-enabled|-n: Specify this option to disable the event at runtime.
--config|-c: Specify the name of the configuration for which you want to create the event.
--command|-C: Specify the command that the event executes. The value can be restart, reconfig, rotate-log, rotate-access-log, and update-crl, or any executable command.
--time|-t: Specify the time, for example, 12:30, when you want this event to start. The format of the time is hh:mm.
--month|-m: Specify the month when you want this event to occur. The range of values is 1 to 12.
--day-of-week|-k: Specify the day of the week when you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri, or Sat.
--day-of-month|-d: Specify the day of the month when you want this event to occur. The range of values is 1 to 31.
--interval|-r: Specify the time interval at which you want this event to occur. The range of values is 60 to 86400 seconds.

Example

tadm create-event --user=admin --password-file=./admin.passwd 
--host=admin.example.com --port=8989 --no-prompt 
--no-enabled=true --config=www.example.org --command=rotate-log 
--interval=120

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.