Child pages
  • CLI Reference

This is the documentation of the release 2.2 of automaIT. The documentation of the latest stable release can be found at AUTOMAIT.

Skip to end of metadata
Go to start of metadata

This is the complete reference of the CLI. For an introduction see the CLI Manual.

General arguments

usage: cli.py [-h] [--config-file FILE] [--config-section SECTION]
              [--server-url URL] [--proxy-host HOST] [--proxy-port PORT]
              [--user USER | --session-id ID] [--format-xml]
              [--suppress-version-check]
              {host,host-type,plan,component,component-varset,component-instance,plugin,job,profile,user,login,version,shell,shell-completion}
              ...

positional arguments:
  {host,host-type,plan,component,component-varset,component-instance,plugin,job,profile,user,login,version,shell,shell-completion}
    host                host related actions
    host-type           host-type related actions
    plan                plan related actions
    component           component related actions
    component-varset    component variable set related actions
    component-instance  component instance related actions
    plugin              plug-in related actions
    job                 job related actions
    profile             current user related actions
    user                user administration related actions
    login               logs in and retrieves a session id
    version             prints CLI version information
    shell               starts an interpreter shell, either interactively or
                        file based
    shell-completion    generates shell completion for commands, subcommands,
                        arguments, hosts, plans, and components

optional arguments:
  -h, --help            show this help message and exit
  --config-file FILE    configuration file to be used for server URL and/or
                        credentials (default: ~/.automait/clirc)
  --config-section SECTION
                        configuration section within file (default: DEFAULT)
  --server-url URL      base URL of the server instance to connect to
                        (default: None)
  --proxy-host HOST     host of the proxy instance to connect to (default:
                        None)
  --proxy-port PORT     port of the proxy instance to connect to (default:
                        None)
  --user USER
  --session-id ID
  --format-xml          outputs the result as xml instead of human readable
                        text (default: False)
  --suppress-version-check
                        suppresses the version check which compares the
                        expected version of the server with that of the
                        script. (default: False)

Copyright(C) 2014 NovaTec Solutions GmbH

host

usage: cli.py host [-h]
                   {list,create-physical,create-virtual,update-physical,update-virtual,delete,initialize,reinitialize}
                   ...

positional arguments:
  {list,create-physical,create-virtual,update-physical,update-virtual,delete,initialize,reinitialize}
    list                lists all hosts
    create-physical     creates a new physical host and returns the job ID
    create-virtual      creates a new virtual host and returns the job ID
    update-physical     updates a physical host and returns the job ID
    update-virtual      updates a virtual host and returns the job ID
    delete              deletes hosts and returns the job ID
    initialize          initializes physical hosts and returns the job ID
    reinitialize        re-initializes physical hosts and returns the job ID

optional arguments:
  -h, --help            show this help message and exit

host list

usage: cli.py host list [-h] [--match PARTIALNAME]

optional arguments:
  -h, --help           show this help message and exit
  --match PARTIALNAME  the host name containing the input (case sensitive).

host create-physical

usage: cli.py host create-physical [-h] [--function FUNCTION]
                                   (--http HOST PORT | --https HOST PORT | --ssh HOST PORT)
                                   [--description DESCRIPTION] [--strict-lock]
                                   [--ssh-remote-port PORT]
                                   [--ssh-remote-keep-alive-port PORT]
                                   [--ssh-user NAME]
                                   [--ssh-agent-command COMMAND]
                                   [--gateway-id ID | --gateway-name NAME]
                                   [--os-name OS_NAME]
                                   [--os-version OS_VERSION]
                                   [--os-arch OS_ARCH] [--host-type QNAME]
                                   [--vars [KEY VALUE [KEY VALUE ...]]]
                                   hostname

positional arguments:
  hostname              name of physical host

optional arguments:
  -h, --help            show this help message and exit
  --function FUNCTION   function of physical host (RA=remote agent,
                        GW=gateway, BOTH= RA and GW), default=RA
  --http HOST PORT      http communication type parameters
  --https HOST PORT     https communication type parameters
  --ssh HOST PORT       ssh communication type parameters
  --description DESCRIPTION
                        description of physical host
  --strict-lock         enforce physical host locking for all executions
                        performed against any of the virtual child hosts.
  --ssh-remote-port PORT
                        ssh remote http port
  --ssh-remote-keep-alive-port PORT
                        ssh remote keep alive port
  --ssh-user NAME       ssh user name
  --ssh-agent-command COMMAND
                        agent start command
  --gateway-id ID       ID of parent gateway host
  --gateway-name NAME   name of parent gateway host
  --os-name OS_NAME     script to determine the name of the operating system
  --os-version OS_VERSION
                        script to determine the version of the operating
                        system
  --os-arch OS_ARCH     script to determine the achitecture of the operating
                        system
  --host-type QNAME     full qualified name of the host type to be set
  --vars [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the host type variables ( key1
                        value1 ... keyN valueN )

host create-virtual

usage: cli.py host create-virtual [-h] [--description DESCRIPTION]
                                  (--parent-id ID | --parent-name NAME)
                                  [--host-type QNAME]
                                  [--vars [KEY VALUE [KEY VALUE ...]]]
                                  hostname

positional arguments:
  hostname              name of virtual host

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        description of virtual host
  --parent-id ID        parent host ID
  --parent-name NAME    parent host name
  --host-type QNAME     full qualified name of the host type to be set
  --vars [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the host type variables ( key1
                        value1 ... keyN valueN )

host update-physical

usage: cli.py host update-physical [-h] (--id ID | --name NAME)
                                   [--host-name HOST_NAME]
                                   [--function FUNCTION]
                                   [--http HOST PORT | --https HOST PORT | --ssh HOST PORT]
                                   [--description DESCRIPTION]
                                   [--strict-lock | --remove-strict-lock]
                                   [--ssh-remote-port PORT]
                                   [--ssh-remote-keep-alive-port PORT]
                                   [--ssh-user NAME]
                                   [--ssh-agent-command COMMAND]
                                   [--gateway-id ID | --gateway-name NAME | --remove-gateway]
                                   [--host-type QNAME | --remove-host-type]
                                   [--vars [KEY VALUE [KEY VALUE ...]]]
                                   [--os-name OS_NAME]
                                   [--os-version OS_VERSION]
                                   [--os-arch OS_ARCH]

optional arguments:
  -h, --help            show this help message and exit
  --id ID               ID of physical host to be updated
  --name NAME           name of physical host to be updated
  --host-name HOST_NAME
                        new name of the physical host
  --function FUNCTION   function of physical host (RA=remote agent,
                        GW=gateway, BOTH= RA and GW)
  --http HOST PORT      http communication type parameters
  --https HOST PORT     https communication type parameters
  --ssh HOST PORT       ssh communication type parameters
  --description DESCRIPTION
                        description of physical host
  --strict-lock         strict host locking
  --remove-strict-lock  remove the strict host locking
  --ssh-remote-port PORT
                        ssh remote http port
  --ssh-remote-keep-alive-port PORT
                        ssh remote keep alive port
  --ssh-user NAME       ssh user name
  --ssh-agent-command COMMAND
                        agent start command
  --gateway-id ID       ID of parent gateway host
  --gateway-name NAME   name of parent gateway host
  --remove-gateway      if the parent gateway host should be removed
  --host-type QNAME     full qualified name of the host type to be set
  --remove-host-type    removes host type (and host type variables) from host
  --vars [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the host type variables ( key1
                        value1 ... keyN valueN ). Value "-" removes the
                        variable from host
  --os-name OS_NAME     script to determine the name of the operating system
  --os-version OS_VERSION
                        script to determine the version of the operating
                        system
  --os-arch OS_ARCH     script to determine the achitecture of the operating
                        system

host update-virtual

usage: cli.py host update-virtual [-h] (--id ID | --name NAME)
                                  [--host-name NAME]
                                  [--description DESCRIPTION]
                                  [--host-type QNAME | --remove-host-type]
                                  [--vars [KEY VALUE [KEY VALUE ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --id ID               ID of virtual host to be updated
  --name NAME           name of virtual host to be updated
  --host-name NAME      updated name of virtual host
  --description DESCRIPTION
                        updated description of virtual host
  --host-type QNAME     full qualified name of the host type to be set
  --remove-host-type    removes host type (and host type variables) from host
  --vars [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the host type variables ( key1
                        value1 ... keyN valueN ). Value "-" removes the
                        variable from host

host delete

usage: cli.py host delete [-h] (--names NAME [NAME ...] | --ids ID [ID ...])

optional arguments:
  -h, --help            show this help message and exit
  --names NAME [NAME ...]
                        names of the hosts to delete
  --ids ID [ID ...]     IDs of the hosts to delete

host initialize

usage: cli.py host initialize [-h]
                              (--names NAME [NAME ...] | --ids ID [ID ...] | --host-set QNAME)

optional arguments:
  -h, --help            show this help message and exit
  --names NAME [NAME ...]
                        names of the hosts to initialize
  --ids ID [ID ...]     IDs of the hosts to initialize
  --host-set QNAME      the fully qualified host set name

host reinitialize

usage: cli.py host reinitialize [-h]
                                (--names NAME [NAME ...] | --ids ID [ID ...] | --host-set QNAME)

optional arguments:
  -h, --help            show this help message and exit
  --names NAME [NAME ...]
                        names of the hosts to re-initialize
  --ids ID [ID ...]     IDs of the hosts to re-initialize
  --host-set QNAME      the fully qualified host set name

host-type

usage: cli.py host-type [-h] {list} ...

positional arguments:
  {list}
    list      lists all host-types

optional arguments:
  -h, --help  show this help message and exit

host-type list

usage: cli.py host-type list [-h] [--match PARTIALNAME]

optional arguments:
  -h, --help           show this help message and exit
  --match PARTIALNAME  the host-type name containing the input (case
                       sensitive).

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

plan list

usage: cli.py plan list [-h] [--match PARTIALPATH] [--show-all]

optional arguments:
  -h, --help           show this help message and exit
  --match PARTIALPATH  the qualified plan name containing the input (case
                       sensitive).
  --show-all           shows all versions of plans

plan details

usage: cli.py plan details [-h] (--id ID | --qname QUALIFIED_NAME)

optional arguments:
  -h, --help            show this help message and exit
  --id ID               id of the specific plan
  --qname QUALIFIED_NAME
                        qualified name of the specific plan

plan source

usage: cli.py plan source [-h] (--id ID | --qname QUALIFIED_NAME)

optional arguments:
  -h, --help            show this help message and exit
  --id ID               id of the specific plan
  --qname QUALIFIED_NAME
                        qualified name of the specific plan

plan import

usage: cli.py plan import [-h] [--major-version] infile

positional arguments:
  infile           XML input file containing the plan to be imported

optional arguments:
  -h, --help       show this help message and exit
  --major-version  create major version

plan delete

usage: cli.py plan delete [-h] (--qname QUALIFIED_NAME | --id ID)

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified plan name
  --id ID               a plan ID

plan delete-latest

usage: cli.py plan delete-latest [-h] (--qname QUALIFIED_NAME | --id ID)

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified plan name
  --id ID               a plan ID

plan list-components

usage: cli.py plan list-components [-h] (--qname QUALIFIED_NAME | --id ID)
                                   [--show-ids]

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified plan name
  --id ID               a plan ID
  --show-ids            show component IDs instead of fully qualified
                        component names

plan execute

usage: cli.py plan execute [-h] (--qname QUALIFIED_NAME | --id ID)
                           (--host-names NAME [NAME ...] | --host-ids ID [ID ...])
                           [--simulation-only | --execution-only]
                           [--job-timeout TIMEOUT] [--process-timeout TIMEOUT]
                           [--max-parallel NUM]
                           [--params [KEY VALUE [KEY VALUE ...]]]
                           [--var-sets NAME [NAME ...]]

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified plan name
  --id ID               a plan ID
  --host-names NAME [NAME ...]
                        target host names
  --host-ids ID [ID ...]
                        target host IDs
  --simulation-only     Simulate only
  --execution-only      Execute only
  --job-timeout TIMEOUT
                        the job timeout in seconds (0 is mapped to the
                        maximum)
  --process-timeout TIMEOUT
                        the process timeout in seconds (0 is mapped to the
                        maximum)
  --max-parallel NUM    the maximum parallel job execution (0 is mapped to the
                        maximum)
  --params [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the execution parameters ( key1
                        value1 ... keyN valueN )
  --var-sets NAME [NAME ...]
                        the variable sets of the components to install for the
                        plan execution. Use '-' for default

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 list

usage: cli.py component list [-h] [--match PARTIALPATH] [--show-all]

optional arguments:
  -h, --help           show this help message and exit
  --match PARTIALPATH  the qualified component name containing the input (case
                       sensitive).
  --show-all           shows all versions of components

component details

usage: cli.py component details [-h] (--id ID | --qname QUALIFIED_NAME)

optional arguments:
  -h, --help            show this help message and exit
  --id ID               id of the specific component
  --qname QUALIFIED_NAME
                        qualified name of the specific component

component source

usage: cli.py component source [-h] (--id ID | --qname QUALIFIED_NAME)

optional arguments:
  -h, --help            show this help message and exit
  --id ID               id of the specific component
  --qname QUALIFIED_NAME
                        qualified name of the specific component

component import

usage: cli.py component import [-h] [--major-version]
                               [--file-resources NAME FILE [NAME FILE ...]]
                               [--config-resources NAME FILE [NAME FILE ...]]
                               [--directory-resources NAME DIRECTORY [NAME DIRECTORY ...]]
                               [--resource-descriptors NAME FILE [NAME FILE ...]]
                               infile

positional arguments:
  infile                XML input file containing the component to be imported

optional arguments:
  -h, --help            show this help message and exit
  --major-version       create major version
  --file-resources NAME FILE [NAME FILE ...]
                        Tuple of resource name and file resource to be
                        imported
  --config-resources NAME FILE [NAME FILE ...]
                        Tuple of resource name and configuration resource to
                        be imported
  --directory-resources NAME DIRECTORY [NAME DIRECTORY ...]
                        Tuple of resource name and directory resource to be
                        imported recursively
  --resource-descriptors NAME FILE [NAME FILE ...]
                        Tuple of resource name and directory resource
                        descriptor to be imported

component delete

usage: cli.py component delete [-h] (--qname QUALIFIED_NAME | --id ID)

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the fully qualified component name
  --id ID               a component ID

component delete-latest

usage: cli.py component delete-latest [-h] (--qname QUALIFIED_NAME | --id ID)

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified component name
  --id ID               a component ID

component install

usage: cli.py component install [-h] (--qname QUALIFIED_NAME | --id ID)
                                (--host-names NAME [NAME ...] | --host-ids ID [ID ...])
                                --constructor NAME [--variable-set NAME]
                                [--simulation-only | --execution-only]
                                [--job-timeout TIMEOUT]
                                [--process-timeout TIMEOUT]
                                [--max-parallel NUM]
                                [--params [KEY VALUE [KEY VALUE ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the qualified component name
  --id ID               a component ID
  --host-names NAME [NAME ...]
                        target host names
  --host-ids ID [ID ...]
                        target host IDs
  --constructor NAME    the constructor name
  --variable-set NAME   the variable set name
  --simulation-only     Simulate only
  --execution-only      Execute only
  --job-timeout TIMEOUT
                        the job timeout in seconds
  --process-timeout TIMEOUT
                        the process timeout in seconds
  --max-parallel NUM    the maximum parallel job execution
  --params [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the execution parameters ( key1
                        value1 ... keyN valueN )

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 list

usage: cli.py component-varset list [-h] (--qname QUALIFIED_NAME | --id ID)
                                    [--show-ids]

optional arguments:
  -h, --help            show this help message and exit
  --qname QUALIFIED_NAME
                        the fully qualified component name
  --id ID               a component ID
  --show-ids            show only the variable sets ids

component-varset import

usage: cli.py component-varset import [-h] [--overwrite]
                                      (--component-id ID | --component-qname QUALIFIED_NAME)
                                      infile

positional arguments:
  infile                XML input file containing the component variable sets
                        to be imported

optional arguments:
  -h, --help            show this help message and exit
  --overwrite           true, if existing variable sets should be overwritten
                        by the imported ones.
  --component-id ID     id of the specific component the variable sets belong
                        to
  --component-qname QUALIFIED_NAME
                        qualified name of the specific component the variable
                        sets belong to

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 )

component-instance

usage: cli.py component-instance [-h] {execute,uninstall} ...

positional arguments:
  {execute,uninstall}
    execute            executes method on componentinstance
    uninstall          uninstalls componentinstance

optional arguments:
  -h, --help           show this help message and exit

component-instance execute

usage: cli.py component-instance execute [-h]
                                         (--ids INSTANCE_ID [INSTANCE_ID ...] | --qname QUALIFIED_NAME)
                                         [--instances HOST INSTANCE_NAME [HOST INSTANCE_NAME ...]]
                                         --method NAME
                                         [--simulation-only | --execution-only]
                                         [--job-timeout TIMEOUT]
                                         [--process-timeout TIMEOUT]
                                         [--max-parallel NUM]
                                         [--params [KEY VALUE [KEY VALUE ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --ids INSTANCE_ID [INSTANCE_ID ...]
                        a component instance ID
  --qname QUALIFIED_NAME
                        the qualified component name
  --instances HOST INSTANCE_NAME [HOST INSTANCE_NAME ...]
                        Tuple of host and instance qualified name
  --method NAME         name of the method to execute
  --simulation-only     Simulate only
  --execution-only      Execute only
  --job-timeout TIMEOUT
                        the job timeout in seconds
  --process-timeout TIMEOUT
                        the process timeout in seconds
  --max-parallel NUM    the maximum parallel job execution
  --params [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the execution parameters ( key1
                        value1 ... keyN valueN )

component-instance uninstall

usage: cli.py component-instance uninstall [-h]
                                           (--ids INSTANCE_ID [INSTANCE_ID ...] | --qname QUALIFIED_NAME)
                                           [--instances [HOST INSTANCE_NAME [HOST INSTANCE_NAME ...]]]
                                           --destructor NAME
                                           [--simulation-only | --execution-only]
                                           [--job-timeout TIMEOUT]
                                           [--process-timeout TIMEOUT]
                                           [--max-parallel NUM]
                                           [--params [KEY VALUE [KEY VALUE ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --ids INSTANCE_ID [INSTANCE_ID ...]
                        a component instance ID
  --qname QUALIFIED_NAME
                        the qualified component name
  --instances [HOST INSTANCE_NAME [HOST INSTANCE_NAME ...]]
                        Tuple of host and instance qualified name
  --destructor NAME     the destructor name
  --simulation-only     Simulate only
  --execution-only      Execute only
  --job-timeout TIMEOUT
                        the job timeout in seconds
  --process-timeout TIMEOUT
                        the process timeout in seconds
  --max-parallel NUM    the maximum parallel job execution
  --params [KEY VALUE [KEY VALUE ...]]
                        the key value pair of the execution parameters ( key1
                        value1 ... keyN valueN )

plugin

usage: cli.py plugin [-h] {import} ...

positional arguments:
  {import}
    import    imports a new plug-in and returns the job ID

optional arguments:
  -h, --help  show this help message and exit

plugin import

usage: cli.py plugin import [-h] infile

positional arguments:
  infile      Plug-in JAR to be imported

optional arguments:
  -h, --help  show this help message and exit

job

usage: cli.py job [-h] {status,content,steps,process-output,cancel} ...

positional arguments:
  {status,content,steps,process-output,cancel}
    status              shows job information (i.e. status, type)
    content             shows the host or component instance specific
                        execution jobs
    steps               shows the host or component instance specific steps of
                        an execution job
    process-output      outputs all process output of the given execution job
                        to stdout
    cancel              cancels a queued or already running job. Already
                        terminated jobs will ignore the cancellation silently.

optional arguments:
  -h, --help            show this help message and exit

job status

usage: cli.py job status [-h] --id JOBID

optional arguments:
  -h, --help  show this help message and exit
  --id JOBID  id of the job

job content

usage: cli.py job content [-h] --id JOBID [--show-times]

optional arguments:
  -h, --help    show this help message and exit
  --id JOBID    id of the job
  --show-times  show additionally start, end and duration

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

job cancel

usage: cli.py job cancel [-h] --id JOBID

optional arguments:
  -h, --help  show this help message and exit
  --id JOBID  id of the job

profile

usage: cli.py profile [-h] {change-password} ...

positional arguments:
  {change-password}
    change-password  changes the internal user's password

optional arguments:
  -h, --help         show this help message and exit

profile change-password

usage: cli.py profile change-password [-h]

optional arguments:
  -h, --help  show this help message and exit

user

usage: cli.py user [-h] {change-password,deactivate} ...

positional arguments:
  {change-password,deactivate}
    change-password     change internal user's password
    deactivate          disables login by deactivating the user

optional arguments:
  -h, --help            show this help message and exit

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

user deactivate

usage: cli.py user deactivate [-h] --name USERNAME

optional arguments:
  -h, --help       show this help message and exit
  --name USERNAME  user to deactivate

login

usage: cli.py login [-h]

optional arguments:
  -h, --help  show this help message and exit

version

usage: cli.py version [-h]

optional arguments:
  -h, --help  show this help message and exit

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

shell-completion

usage: cli.py shell-completion [-h] {register,unregister,list-commands} ...

positional arguments:
  {register,unregister,list-commands}
    register            registers shell completion
    unregister          unregisters shell completion

optional arguments:
  -h, --help            show this help message and exit

shell-completion register

usage: cli.py shell-completion register [-h]

optional arguments:
  -h, --help  show this help message and exit

shell-completion unregister

usage: cli.py shell-completion unregister [-h]

optional arguments:
  -h, --help  show this help message and exit
  • No labels