Situate™ Command-Line Interface

The Situate command-line interface allows you to perform many of the things you can do from the GUI from the command line.

Usage

    sit -domain  [-host ] [-port
]
        [-login ]  []*

sit must be given a domain. An optional -host, -port or -login may also be supplied. If no -host is supplied, sit-domain will be used. If no -port is supplied, port 14000 will be used. If no -login switch is used the current user is used.

The sit command will prompt for a password. This should be your situate password. Alternatively a -password switch may be used to pass the password to the command.

After the -domain (and possibly -host, -port, -login or -password) switches, a command followed by the commands switches and arguments may be supplied. The switches and arguments are command dependent.

Interactive Mode

If no command is given, sit enters interactive mode. On most UNIX computers, the EDITOR variable is supported. Command-line history is also maintained.

Commands

asset add <asset> <hostname> [-port <port> [-ftport <ftport> [-al <assetLogin> [-ap <assetPassword> [-description <description>]

Add an asset and assign it to the given hostname. The port switches may be used to assign non-default ports. The asset login and password arguments may be used when a login and password are required.

asset delete <asset>

Delete the specified asset.

asset update <asset> [-port <port>] [-ftport <ftport>] [-hostname <hostname>] [-description <description>]

Updates the give asset. If one or more switches are given, the associated item will be modified.

cd <path>

Sets the logical working directory from which all relative directory operations are performed.

ls <path> | <query>

Lists all directory objects that match the supplied query.

help <command>

Return help about one or more commands.

version

Return version and copyright information.

wf approve [<workflowName> | -id <id>

Approve the workflow described by its name or, using the -id, switch, from its unique id.

wf cancel <iid>

Cancel the running workflow specified by the instance id (iid).

wf confirm <iid>

Confirm the workflow specified by the instance id (iid).

wf delete [-submitted] [<workflowName> | -id <id>]

Deletes the workflow indicated by name or by id (with the -id switch. By default the approved workflow is deleted. You can deleted the submitted version by applying the -submitted switch.

wf disable [ <workflowName> | -id <id> ] [-trigger <trigger>]

Disables a workflow or a specific trigger within a workflow if -trigger is specified. The workflow is identified by name or by unique id, using the -id switch.

wf enable [ <workflowName> | -id <id> ] [-trigger <trigger>]

Enables a workflow or a specific trigger within a workflow if -trigger is specified. The workflow is identified by name or by unique id, using the -id switch.

wf exec <workflowName> <trigger> [-wait] [-var <name> <value> [-no-prompt]

Execute the approved workflow <workflowName> using manual trigger <trigger> If "-wait" is applied, the command will wait for the workflow to complete and exit with the following:

• 0: Successful
• 1: Failed
• 2: Canceled

If the manual trigger has prompt variables defined, this command will prompt the user for input. Alternatively, the "-var" switch may be used to provide the answers for the prompts. if "-no-prompt" is specified, the command will fail if there are prompts not satisified by "-var" arguments. On successful start, the instance ID of the workflow is printed.

wf get [-submitted] [<workflowName> | -id <id> <file>]

Retrieves the workflow indicated by name or by id (with the -id switch. By default the approved workflow is retrieved. You can retrieved the submitted version by applying the -submitted switch. The workflow is stored in <file> as an XML document.

wf list [-fmt <format>] [-fieldSeparator <fs>] [-keyword <keypat>] [-useId] [-running] [-l] [-state <statemask>] [<namepat>]

Lists submitted and approved workflows. If <namepat> is supplied, only the workflows matching the <namepat> regular expression will be returned. If -useId is used, <namepat> will be matched against the workflow id or instance iid instead of the name. If -keyword is supplied, <keypat> is a comma-separated list of regular expressions that must match one or more keywords associated with the workflow. If <fs> is supplied, the <fs> becomes the field separator and no extra spaces or lines are emitted. <fs> can also be the words 'tab' or 'colon'. If -fmt is supplied, <format> is a comma-separated list of fields. the following fields are available:

• id, name, nextRun, state, lastRun, timeSubmitted, timeApproved
• approvedBy, submittedBy, runBy, hasSchedule, containsChanges
• queue, keywords

If no -fmt is supplied, the following format is used: "-fmt name,state,lastRun,nextRun,runBy" If -l is supplied and no -fmt is supplied, the following format is used: "-fmt id,name,state,lastRun,nextRun,runBy". If -running is supplied, workflow instances (running or unconfirmed) will be shown. If -state is supplied, only workflows matching <statemask> are returned. <statemask> may be a string of characters, each matching a workflow state. States are:

• A - Approved
• S - Submitted
• R - Running
• X - Canceled
• F - Failed
• C - Complete (successful, but unconfirmed)

 

wf submit [-approve] <file>

This command submits a the workflow stored the given XML file. if "-approve" is applied. The submit attempts to also approve the workflow.

wf wait <iid>

Wait for the running workflow specified by the instance id (iid) to exit. The command will exit with one of the following:

• 0: Successful
• 1: Failed
• 2: Canceled