host-type list

plan

usage: cli.py plan [-h]
{list,details,source,import,delete,delete-latest,list-components,execute}
...
positional arguments:
{list,details,source,import,delete,delete-latest,list-components,execute}
list lists all latest plans
details shows the details of a plan
source shows the source of a plan
import imports a new plan or plan version and returns the job
ID
delete deletes a plan with all corresponding versions and
returns the job ID
delete-latest deletes the latest plan version and returns the job ID
list-components lists the components which are installable by the plan
execute executes a plan and returns the job ID
optional arguments:
-h, --help show this help message and exit

component

usage: cli.py component [-h]
{list,details,source,import,delete,delete-latest,install}
...
positional arguments:
{list,details,source,import,delete,delete-latest,install}
list lists all latest components
details shows the details of a component
source shows the source of a component
import imports a new component or component version and
returns the job ID
delete deletes a component with all corresponding versions
and returns the job ID
delete-latest deletes the latest component version and returns the
job ID
install install a component version and returns the job ID
optional arguments:
-h, --help show this help message and exit

component-varset

usage: cli.py component-varset [-h] {list,import,export,delete,update} ...
positional arguments:
{list,import,export,delete,update}
list shows the variable sets of a component
import imports all variable sets given in a file for a
component
export exports all variable sets of a component, if only the
component is referenced. Exports a single variable
set, if its name or id is given.
delete deletes variable sets
update updates a variable set
optional arguments:
-h, --help show this help message and exit

component-varset export

usage: cli.py component-varset export [-h] [--id ID | --name NAME]
[--component-id ID | --component-qname QUALIFIED_NAME]
optional arguments:
-h, --help show this help message and exit
--id ID id of the single variable set to export
--name NAME name of the single variable set to export
--component-id ID id of the component the variable sets belong to
--component-qname QUALIFIED_NAME
qualified name of the component the variable sets
belong to

component-varset delete

usage: cli.py component-varset delete [-h]
(--ids ID [ID ...] | --names NAME [NAME ...])
[--component-id ID | --component-qname QUALIFIED_NAME]
optional arguments:
-h, --help show this help message and exit
--ids ID [ID ...] ids of the variable sets to delete
--names NAME [NAME ...]
names of the variable sets to delete
--component-id ID id of the component the variable sets should be
deleted from
--component-qname QUALIFIED_NAME
qualified name of the component the variable sets
should be deleted from

component-varset update

usage: cli.py component-varset update [-h] (--id ID | --name NAME)
[--component-id ID | --component-qname NAME]
[--vars [KEY VALUE [KEY VALUE ...]]]
optional arguments:
-h, --help show this help message and exit
--id ID id of the variable set to update
--name NAME name of the variable set to update
--component-id ID id of the component the variable set should be updated
for
--component-qname NAME
qualified name of the component the variable set
should be updated for
--vars [KEY VALUE [KEY VALUE ...]]
the key value pair of the variable set to update (
key1 value1 ... keyN valueN )

job content

job steps

usage: cli.py job steps [-h] --id JOBID [--simulation-only | --execution-only]
(--host-name NAME | --component-instance QNAME)
[--show-times] [--show-raw] [--suppress-indent]
optional arguments:
-h, --help show this help message and exit
--id JOBID id of the execution job
--simulation-only shows only simulation steps
--execution-only shows only execution steps
--host-name NAME the host name of the execution job
--component-instance QNAME
the component instance of the execution job as full
qualified name
--show-times show additionally start, end and duration of each step
--show-raw show additionally the raw (unsubstituted) expression
for the steps
--suppress-indent suppress the indentation for the steps

job process-output

usage: cli.py job process-output [-h] --id JOBID
(--host-name NAME | --component-instance QNAME)
[--no-stdout | --no-stderr]
optional arguments:
-h, --help show this help message and exit
--id JOBID the job id
--host-name NAME the host name of the execution job
--component-instance QNAME
the component instance of the execution job as full
qualified name
--no-stdout do not output stdout of the process
--no-stderr do not output stderr of the process

user change-password

usage: cli.py user change-password [-h] --name USERNAME --newpassword NEW
[--not-expired]
optional arguments:
-h, --help show this help message and exit
--name USERNAME the user whose password should be changed
--newpassword NEW the new password
--not-expired do not force user to change the password on next login

login

shell

usage: cli.py shell [-h] [--use-session-id] [file [file ...]]
positional arguments:
file Python input file(s) to be executed
optional arguments:
-h, --help show this help message and exit
--use-session-id initially obtain a session ID from the server to be used
throughout the (interactive) shell