Delivery Management Commands

Execute Delivery

This command runs a delivery in the currently connected runtime.

execute delivery <delivery>
    [mode <memory | standalone>]
    [configuration <configuration>]
    [var <variable_path> <variable_value>]
    [synch]
    [sessionName <session_name>]
    [repository <repository_name>]
    [format <format>]
    [logLevel <log_level>]
    [returnCodePath <variable_name>]

Option Mandatory Description

Option	Mandatory	Description
`mode`	No	The memory mode starts the delivery in the current runtime process and the standalone mode starts the delivery in a separate process.
`configuration`	No	When working with multi-configuration deliveries, this option provides the configuration to use.
`var <variable_path> <variable_value>`	No	Pass variables value to the delivery. This option may be used multiple times.
`synch`	No	Wait for the session to complete before proceeding.
`sessionName`	No	Session name. If no name is provided, the session is named after the delivery.
`repository`	No	If your runtime is configured to use a deliveries repository, you can provide the repository name. The delivery is searched in the specified repository.
`format`	No	Customized format for the command output. The following columns are available: `%name`,`%status`,`%begindate`,`%enddate`,`%configuration`,`%id`,`%executionmode`,`%guesthost`,`%iter`,`%launchmode`,`%runtimehost`,`%runtimeport`,`%returncode`,`%errormessage`,`%exception`,`%parentiter`
`logLevel`	No	Level of logging used for the session. See log level for more details about the various log level values.
`variable_name`	No	Path of a session variable that contains the return code of the delivery when the execution completes.

mode

The memory mode starts the delivery in the current runtime process and the standalone mode starts the delivery in a separate process.

configuration

When working with multi-configuration deliveries, this option provides the configuration to use.

var <variable_path> <variable_value>

Pass variables value to the delivery. This option may be used multiple times.

synch

Wait for the session to complete before proceeding.

sessionName

Session name. If no name is provided, the session is named after the delivery.

repository

If your runtime is configured to use a deliveries repository, you can provide the repository name. The delivery is searched in the specified repository.

format

Customized format for the command output. The following columns are available: %name,%status,%begindate,%enddate,%configuration,%id,%executionmode,%guesthost,%iter,%launchmode,%runtimehost,%runtimeport,%returncode,%errormessage,%exception,%parentiter

logLevel

Level of logging used for the session. See log level for more details about the various log level values.

variable_name

Path of a session variable that contains the return code of the delivery when the execution completes.

Example 1. Execute delivery

execute delivery myDeliv var ~/myVar1 value1 var "~/my var 2" "value 2"
execute delivery myDeliv repository MyRepo
execute delivery myDeliv format "%name, %id, %returncode"
execute delivery myDeliv format "%name | %id | %begindate | %enddate | %status | %returncode | %errormessage"

Schedule Delivery

This command schedules a delivery on the currently connected Runtime.

schedule delivery <delivery>
    [scheduleName <schedule_name>]
    [sessionName <session_name>]
    [jobName <job_name>]
    [with command]
    [on host <host_name>]
    [port <host_port>]
    [start <start_date>]
    [end <end_date>]
    [var <path> <value>]
    [var ...]
    [configuration <configuration>]
    [logLevel <log_level>]
    cron <cron_expression>

Option Mandatory Description

Option	Mandatory	Description
`scheduleName <schedule_name>`	No	Name that identifies this schedule. It is automatically generated if not set.
`sessionName <session_name>`	No	Session name. If no name is provided, the session is named after the delivery.
`jobName <job_name>`	No	Internal name for the scheduled job. This is by default the delivery name. See below for more information.
`with command`	No	Executes the delivery with the command-line tool. If no set, the delivery is started in memory in the currently connected runtime.
`on host <host_name>`	No	Hostname or address of the runtime host. If not set the currently connected runtime is used.
`port <host_port>`	No	Runtime port.
`start <start_date>`	No	Start date of the schedule.
`end <end_date>`	No	End date of the schedule.
`configuration`	No	When working with multi-configuration deliveries, this option provides the configuration to use.
`var <variable_path> <variable_value>`	No	Pass variables value to the delivery. This option may be used multiple times.
`logLevel`	No	Level of logging used for the sessions. See log level for more details about the various log level values.
`cron <cron_expression>`	Yes	Cron expression to run the schedule.

scheduleName <schedule_name>

Name that identifies this schedule. It is automatically generated if not set.

sessionName <session_name>

Session name. If no name is provided, the session is named after the delivery.

jobName <job_name>

Internal name for the scheduled job. This is by default the delivery name. See below for more information.

with command

Executes the delivery with the command-line tool. If no set, the delivery is started in memory in the currently connected runtime.

on host <host_name>

Hostname or address of the runtime host. If not set the currently connected runtime is used.

port <host_port>

Runtime port.

start <start_date>

Start date of the schedule.

end <end_date>

End date of the schedule.

configuration

When working with multi-configuration deliveries, this option provides the configuration to use.

var <variable_path> <variable_value>

Pass variables value to the delivery. This option may be used multiple times.

logLevel

Level of logging used for the sessions. See log level for more details about the various log level values.

cron <cron_expression>

Yes

Cron expression to run the schedule.

Example 2. Schedule delivery

schedule delivery myDeliv
    start "2015/12/10 12:55:22"
    end "2015/12/25 12:55:22"
    var ~/myvar myValue
    cron "0 15 10 * * ? *"

About the Job Name

The jobName option uniquely identifies schedules and is used as a semaphore. You cannot run multiple schedules with the same job name at the same time. If this happens, only one is started.

This avoids starting multiple scheduled deliveries at the same time if they do not make functional sense. Since the job name defaults to the delivery name, this behavior is the default one when you have multiple schedules for the same delivery.

If you want to run simultaneously multiple instances of a delivery on parallel schedules, make sure to specify a different job name for the simultaneous schedules.

Example 3. These two schedules cannot run myDeliv at the same time.

schedule delivery myDeliv var ~/myvar myValue01 cron "0 15 10 * * ? *"
schedule delivery myDeliv var ~/myvar myValue02 cron "0 15 10 * * ? *"

Example 4. These two schedules can run myDeliv at the same time with different job names.

schedule delivery myDeliv jobName job01 var ~/myvar myValue01 cron "0 15 10 * * ? *"
schedule delivery myDeliv jobName job02 var ~/myvar myValue02 cron "0 15 10 * * ? *"

Get Repositories

This command return the list of a deliveries repositories configured for the runtime.

get repositories

Get Deliveries

This command return information about deliveries available to the currently connected runtime.

get deliveries [id <id1,id2,idn>]
    [format <format>]
    [repository <repository>]

Option Mandatory Description

Option	Mandatory	Description
`id <id1,id2,idn>`	No	Comma-separated list of delivery IDs.
`format <format>`	No	Comma-separated list of columns to return in the output. The available columns are `%name`, `%builduser`, `%configuration`, `%id`, `%packageid`, `%processid`, `%username`, `%version`, `%builddate`, and `%exportdate`.
`repository <repository>`	No	If your runtime is configured to use a deliveries repository, you can provide the repository name. The deliveries are searched in the specified repository.

id <id1,id2,idn>

Comma-separated list of delivery IDs.

format <format>

Comma-separated list of columns to return in the output. The available columns are %name, %builduser, %configuration, %id, %packageid, %processid, %username, %version, %builddate, and %exportdate.

repository <repository>

If your runtime is configured to use a deliveries repository, you can provide the repository name. The deliveries are searched in the specified repository.

Example 5. Get deliveries

get deliveries format %name,%configuration,%builddate,%exportdate

List Deliveries

This command returns a list of deliveries available to the currently connected runtime.

get list deliveries [to <file>]

Option

Mandatory

Description

to <file>

Exports the output to a file.

List Delivery Schedules

This command returns information about delivery schedules, and optionally exports it in a file. Job names do not appear in the list.

get delivery schedules <deliveryName> [to <file>]

Option

Mandatory

Description

to <file>

Exports the result to a file.

Remove Delivery

This command removes a delivery from the runtime. This operation deletes the delivery file from the runtime deliveries folder.

remove delivery <name> [repository <repository>]

Option Mandatory Description

Option	Mandatory	Description
`name`	Yes	Name of the Delivery to remove.
`repository <repository>`	No	If your runtime is configured to use a deliveries repository, you can provide the repository name. The deliveries are searched and removed from the specified repository.

name

Yes

Name of the Delivery to remove.

repository <repository>

If your runtime is configured to use a deliveries repository, you can provide the repository name. The deliveries are searched and removed from the specified repository.