Command Line Client

Introduction

Sesam provides a command line client for controlling the service and for working with the data in the datahub.

The command line client works by sending http-requests to the Sesam (Service API). You can therefore in principle use for instance curl to do everything that you can do with the command line client. The purpose of the command line client is to make the api functionality easier accessable from the command line.

Installing the client

If you followed the Getting Started guide, the sesam service will be running on http://localhost:9042/api .

The command line client is distributed as a python package, so you will need python (v3.4 or later) in order to install and run it:

  1. Download and install the latest version of python from https://www.python.org/downloads. Depending on your OS, the installer might ask you if you want to add python to the machine's executable path. You want to answer yes to this. For instance: the MS Windows installer has a checkbox called "Add Python 3.5 to PATH" that you need to check.
  2. Install the sesamclient package with python's package manager "pip". Open a new command line window and run this command
pip3 install -U sesamclient

The sesam client will now be available on the command line as "sesam".

Commands overview

The most important thing to know is the "help" option (-h), which is available for the command line client as a whole, and for individual commands

sesam -h

sesam config -h

sesam get-datasets -h

This will print out detailed usage instructions. This information is also available in the Command Line Client Reference part of this document.

The most important commands are

sesam get-pipes

This returns a list of pipes. For an explanation of what a pipe is, read the Pipes concept definition.

sesam get-datasets

This returns a list of datasets. (For an explanation of what a dataset is, read the Datasets concept definition).

Example usage

In the following section we will go through a few examples of what you can do with the command line client. For a complete description of all the commands and options, have a look at the Command Line Client Reference section.

Setting the API URL endpoint

You can either supply the URL to the API endpoint using the --server_base_url <URL> parameter (usually the last one on the command line), or you can set it permanently for the logged in user using:

sesam config server.base_url <URL>

If none of these options are used, the sesam client will fall back to a default value for the base URL of the API which is http://localhost:9042/api.

Get a list of all the pipes

sesam get-pipes

Get information about one specified pipe

To only get one specific pipe, use the "get-pipe" command with the pipe's "_id". To get the pipe with the _id "Northwind:Products", you would do this:

sesam get-pipe Northwind:Products

Run operations on a pipe

A pipe typically has a number of operations that can be triggered via the api. These are listed in the pipeinfo["runtime"]["supported-operations"] attribute. A typical value looks like this:

"supported-operations": [
            "enable",
            "disable",
            "start",
            "stop"
        ]

These operations are triggered calling the appropriate command with the pipe's "_id" as the argument. For example: to disable the "Northwind:Products" pipe you would do this:

sesam stop-pump Northwind:Products

To manually start the pipe's pump, you would do this:

sesam start-pump Northwind:Products

To stop a running pump, you would do this:

sesam stop-pump Northwind:Products

Get a list of all the datasets

sesam get-datasets

Get information about one specific dataset

To only get one specific dataset, use the "get-dataset" command with the dataset's "_id" as an argument. To get the dataset with the _id "Northwind:Products", you would do this:

sesam get-dataset Northwind:Products

Get the content of a dataset

To see the entities in a dataset, use the "get-dataset-entities" command, like this:

sesam get-dataset-entities --limit 3 Northwind:Products

The "limit" parameter limits the number of returned entities. Without this parameter, all the entities in the dataset would be returned. Depending on the size of the dataset, that could take a while, so it is generally a good idea to include a "limit"-parameter if you just want to have a quick look at what the dataset contains.

Command Line Client Reference

This section contains detailed reference documentation for the command line client. All this information is also available from the command line client itself, via the "-h" option. Examples:

sesam -h

sesam config -h

sesam get-datasets -h

description:

This is a command line tool for connecting to a Sesam installation and performing various operations.

The root address of the Sesam installation rest api can be specified with the --"server_base_url" argument, or by by using the 'config' command to store the address persistently.

To get detailed help for a command, add '-h' after the command, like this:
%(prog)s config -h

(version: 0.2.59)

usage: sesam [-h] [--loglevel {ERROR,WARNING,INFO,DEBUG}]
             {config,get-pipes,get-pipe,get-pipe-schema-definition,add-pipes,modify-pipe,delete-pipe,get-logs,get-log,get-systems,get-system,add-systems,modify-system,delete-system,get-datasets,get-dataset,delete-dataset,get-dataset-entities,get-dataset-entity,get-pump,stop-pump,start-pump,disable-pump,enable-pump,wait-for-pump-to-finish-running,unset-last-seen,update-last-seen,run-pump-operation,export,import,get-license,put-license,get-secrets,put-secrets,delete-secret,get-env-vars,put-env-vars,post-env-vars,delete-env-var,login,logout}
             ...

Positional Arguments

command Possible choices: config, get-pipes, get-pipe, get-pipe-schema-definition, add-pipes, modify-pipe, delete-pipe, get-logs, get-log, get-systems, get-system, add-systems, modify-system, delete-system, get-datasets, get-dataset, delete-dataset, get-dataset-entities, get-dataset-entity, get-pump, stop-pump, start-pump, disable-pump, enable-pump, wait-for-pump-to-finish-running, unset-last-seen, update-last-seen, run-pump-operation, export, import, get-license, put-license, get-secrets, put-secrets, delete-secret, get-env-vars, put-env-vars, post-env-vars, delete-env-var, login, logout

Named Arguments

--loglevel

Possible choices: ERROR, WARNING, INFO, DEBUG

The loglevel to use. The default is 'WARNING'

Default: "WARNING"

Sub-commands:

config

Gets or sets a config option.

sesam config [-h]
             {server.base_url,server.username,server.password,server.timeout}
             ...
Positional Arguments
optionname

Possible choices: server.base_url, server.username, server.password, server.timeout

The config option to get or set

optionvalue If specified, the config option will be set to this value. If no value is specified, the current value will be displayed.

get-pipes

Display a list of pipes

sesam get-pipes [-h] [--server_base_url <server base url>]
                [--jwt <jwt filename>] [--server_username <username>]
                [--server_password <password>]
                [--server_timeout <timeout in seconds>]
                [--out {json,yaml,plain}] [--ids-only]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

get-pipe

Display detailed information about the specified pipe

sesam get-pipe [-h] [--server_base_url <server base url>]
               [--jwt <jwt filename>] [--server_username <username>]
               [--server_password <password>]
               [--server_timeout <timeout in seconds>]
               [--out {json,yaml,plain}]
               pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-pipe-schema-definition

Generate a schema defintion for the pipe

sesam get-pipe-schema-definition [-h] [--server_base_url <server base url>]
                                 [--jwt <jwt filename>]
                                 [--server_username <username>]
                                 [--server_password <password>]
                                 [--server_timeout <timeout in seconds>]
                                 [--out {json,yaml,plain}] [--keys_only]
                                 pipe_id sample_size
Positional Arguments
pipe_id The id of the pipe.
sample_size

The number of entities to sample for the schema.

Default: 1000

Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--keys_only

If set only returns the keys of the schema as an array.

Default: False

add-pipes

Add one or more new pipes

sesam add-pipes [-h] [--server_base_url <server base url>]
                [--jwt <jwt filename>] [--server_username <username>]
                [--server_password <password>]
                [--server_timeout <timeout in seconds>]
                [--out {json,yaml,plain}] [--ids-only] [--force]
                pipe_configurations
Positional Arguments
pipe_configurations
 A list of the configurations of the new pipes. Each pipe configuration should be a json-encoded dict on the same format as used when defining a pipe in the sesam-node configuration file. Example: '[{"_id": "my_new_pipe", "type": "pipe", "short_config": "sql://Northwind/Customers"}]'
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

--force

Forces the server to accept configuration errors and do a best-effort attempt to apply the new configuration. This is rarely a good idea.

Default: False

modify-pipe

Modify a pipe by uploading a new configuration for the pipe

sesam modify-pipe [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}] [--force]
                  pipe_configuration
Positional Arguments
pipe_configuration
 The new configuration of the pipe. This should be a json object on the same format as used when defining a pipe in the sesam-node configuration file. The pipe to modify is specified by the '_id' attribute of the configuration. Example: '{"_id": "my_existing_pipe", "type": "pipe", "short_config": "sql://Northwind/Customers"}'"
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--force

Forces the server to accept configuration errors and do a best-effort attempt to apply the new configuration. This is rarely a good idea.

Default: False

delete-pipe

Deletes the specified pipe from the sesam-node

sesam delete-pipe [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
                  pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-logs

Display a list of logs

sesam get-logs [-h] [--server_base_url <server base url>]
               [--jwt <jwt filename>] [--server_username <username>]
               [--server_password <password>]
               [--server_timeout <timeout in seconds>]
               [--out {json,yaml,plain}] [--ids-only]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

get-log

Display the content of the specified log

sesam get-log [-h] [--server_base_url <server base url>]
              [--jwt <jwt filename>] [--server_username <username>]
              [--server_password <password>]
              [--server_timeout <timeout in seconds>]
              [--out {json,yaml,plain}]
              log_id
Positional Arguments
log_id The id of the log.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-systems

Display a list of systems

sesam get-systems [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}] [--ids-only]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

get-system

Display detailed information about the specified system

sesam get-system [-h] [--server_base_url <server base url>]
                 [--jwt <jwt filename>] [--server_username <username>]
                 [--server_password <password>]
                 [--server_timeout <timeout in seconds>]
                 [--out {json,yaml,plain}]
                 system_id
Positional Arguments
system_id The id of the system.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

add-systems

Add one or more new systems

sesam add-systems [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}] [--ids-only] [--force]
                  system_configurations
Positional Arguments
system_configurations
 A list of the configurations of the new systems. Each system configuration should be a json-encoded dict on the same format as used when defining a system in the sesam-node configuration file. Example: '[{"_id": "my_new_system", "type": "system", "short_config": "sql://Northwind/Customers"}]'
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

--force

Forces the server to accept configuration errors and do a best-effort attempt to apply the new configuration. This is rarely a good idea.

Default: False

modify-system

Modify a system by uploading a new configuration for the system

sesam modify-system [-h] [--server_base_url <server base url>]
                    [--jwt <jwt filename>] [--server_username <username>]
                    [--server_password <password>]
                    [--server_timeout <timeout in seconds>]
                    [--out {json,yaml,plain}] [--force]
                    system_configuration
Positional Arguments
system_configuration
 The new configuration of the system. This should be a json object on the same format as used when defining a system in the sesam-node configuration file. The system to modify is specified by the '_id' attribute of the configuration. Example: '{"_id": "my_existing_system", "type": "system", "short_config": "sql://Northwind/Customers"}'"
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--force

Forces the server to accept configuration errors and do a best-effort attempt to apply the new configuration. This is rarely a good idea.

Default: False

delete-system

Deletes the specified system from the sesam-node

sesam delete-system [-h] [--server_base_url <server base url>]
                    [--jwt <jwt filename>] [--server_username <username>]
                    [--server_password <password>]
                    [--server_timeout <timeout in seconds>]
                    [--out {json,yaml,plain}]
                    system_id
Positional Arguments
system_id The id of the system.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-datasets

Display a list of datasets

sesam get-datasets [-h] [--server_base_url <server base url>]
                   [--jwt <jwt filename>] [--server_username <username>]
                   [--server_password <password>]
                   [--server_timeout <timeout in seconds>]
                   [--out {json,yaml,plain}] [--ids-only]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--ids-only

If this is specified, only the id's of the items will be displayed.

Default: False

get-dataset

Display detailed information about the specified dataset

sesam get-dataset [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
                  dataset_id
Positional Arguments
dataset_id The id of the dataset.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

delete-dataset

Deletes the specified dataset from the sesam-node

sesam delete-dataset [-h] [--server_base_url <server base url>]
                     [--jwt <jwt filename>] [--server_username <username>]
                     [--server_password <password>]
                     [--server_timeout <timeout in seconds>]
                     [--out {json,yaml,plain}]
                     dataset_id
Positional Arguments
dataset_id The id of the dataset.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-dataset-entities

Returns the entities of the specified dataset

sesam get-dataset-entities [-h] [--server_base_url <server base url>]
                           [--jwt <jwt filename>]
                           [--server_username <username>]
                           [--server_password <password>]
                           [--server_timeout <timeout in seconds>]
                           [--out {json,yaml,plain}] [--since SINCE]
                           [--limit LIMIT] [--start START] [--history HISTORY]
                           [--deleted DELETED]
                           dataset_id
Positional Arguments
dataset_id The id of the dataset.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--since The "since" parameter is the opaque value that can be used to efficiently skip already seen entities.
--limit The "limit" parameter specifies the maximum number of entities to return. If this is not specified, all available entities are returned.
--start

The "start" parameter is a positive integer that specified how many entities to skip from the start of where the "since"-parameters starts. This is far less efficient than using the "since"-parameter, but it can be manually set in a gui to explore the dataset. NOTE: Clients should use the "since"-parameter whenever possible.

Default: 0

--history

If this is true (the default) all entities, including replaced ones, will be returned. If this is false, only the latest version of the entities will be returned

Default: True

--deleted

If this is True (the default) deleted entities will also be returned. If this is False, only the non-deleted entities will be returned.

Default: True

get-dataset-entity

Returns the specified entity of the specified dataset

sesam get-dataset-entity [-h] [--server_base_url <server base url>]
                         [--jwt <jwt filename>] [--server_username <username>]
                         [--server_password <password>]
                         [--server_timeout <timeout in seconds>]
                         [--out {json,yaml,plain}]
                         dataset_id entity_id
Positional Arguments
dataset_id The id of the dataset.
entity_id The id of the entity.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-pump

Display detailed information about the pump in the specified pipe

sesam get-pump [-h] [--server_base_url <server base url>]
               [--jwt <jwt filename>] [--server_username <username>]
               [--server_password <password>]
               [--server_timeout <timeout in seconds>]
               [--out {json,yaml,plain}]
               pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

stop-pump

Stop the pump in the specified pipe

sesam stop-pump [-h] [--server_base_url <server base url>]
                [--jwt <jwt filename>] [--server_username <username>]
                [--server_password <password>]
                [--server_timeout <timeout in seconds>]
                [--out {json,yaml,plain}]
                pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

start-pump

Run the pump in the speficied pipe

sesam start-pump [-h] [--server_base_url <server base url>]
                 [--jwt <jwt filename>] [--server_username <username>]
                 [--server_password <password>]
                 [--server_timeout <timeout in seconds>]
                 [--out {json,yaml,plain}] [--allow-already-running-pump]
                 [--dont-wait-for-pump-to-start] [--wait-timeout WAIT_TIMEOUT]
                 pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--allow-already-running-pump
 

This option will make the command ignore an already running pump. Normally, that is treated as an error.

Default: False

--dont-wait-for-pump-to-start
 

This option will prevent the command from waiting for the pump to start before returning. This is useful for batch-operations where you want to schedule lots of pumps to run, but don't wait for the server to actually start them all.

Default: False

--wait-timeout

If this is not zero (the default), the command will wait for the pump to finish running. If the pump hasn't stopped within the specified number of seconds, an error is raised.

Default: 0

disable-pump

Disable the pump in the specified pipe

sesam disable-pump [-h] [--server_base_url <server base url>]
                   [--jwt <jwt filename>] [--server_username <username>]
                   [--server_password <password>]
                   [--server_timeout <timeout in seconds>]
                   [--out {json,yaml,plain}]
                   pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

enable-pump

Enable the pump in the specified pipe

sesam enable-pump [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
                  pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

wait-for-pump-to-finish-running

Wait for the pump in the specified pipe to finish running

sesam wait-for-pump-to-finish-running [-h]
                                      [--server_base_url <server base url>]
                                      [--jwt <jwt filename>]
                                      [--server_username <username>]
                                      [--server_password <password>]
                                      [--server_timeout <timeout in seconds>]
                                      [--out {json,yaml,plain}]
                                      pipe_id timeout
Positional Arguments
pipe_id The id of the pipe.
timeout

The maximum number of seconds to wait.

Default: 60

Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

unset-last-seen

Unset 'last seen' token on the specified pipe

sesam unset-last-seen [-h] [--server_base_url <server base url>]
                      [--jwt <jwt filename>] [--server_username <username>]
                      [--server_password <password>]
                      [--server_timeout <timeout in seconds>]
                      [--out {json,yaml,plain}]
                      pipe_id
Positional Arguments
pipe_id The id of the pipe.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

update-last-seen

Update the 'last seen' token on the specified pipe

sesam update-last-seen [-h] [--server_base_url <server base url>]
                       [--jwt <jwt filename>] [--server_username <username>]
                       [--server_password <password>]
                       [--server_timeout <timeout in seconds>]
                       [--out {json,yaml,plain}]
                       pipe_id last_seen
Positional Arguments
pipe_id The id of the pipe.
last_seen The new last change token. For sdshare-clients, this should be on the form: '2015-07-20T10:00:15Z'
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

run-pump-operation

This is a special generic command that runs the specified operation on the specified pipe. The usecase is pipes that support operations that aren't part of the 'official'sesam-api, and operations that hasn't yet gotten their own dedicated command in the command-line client.

sesam run-pump-operation [-h] [--server_base_url <server base url>]
                         [--jwt <jwt filename>] [--server_username <username>]
                         [--server_password <password>]
                         [--server_timeout <timeout in seconds>]
                         [--out {json,yaml,plain}]
                         [-d <parametername>=<parametervalue>]
                         pipe_id operation
Positional Arguments
pipe_id The id of the pipe.
operation The operation to run.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

-d A <parametername>=<parametervalue> pair. This option can be specified zero or more times. Example: -d last-seen="2015-07-20T10:00:15Z".

export

Exports the complete configuration to a file called "sesam.conf.json" in the given "exportdir" directory. If no directory is given then it will be written to the current directory.

sesam export [-h] [--server_base_url <server base url>] [--jwt <jwt filename>]
             [--server_username <username>] [--server_password <password>]
             [--server_timeout <timeout in seconds>] [--out {json,yaml,plain}]
             [--export-filename EXPORT_FILENAME] [--expand] [--force]
             [--dry-run]
             [exportdir]
Positional Arguments
exportdir

The directory to put the configuration file(s) in. Defaults to the current directory.

Default: "."

Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--export-filename
 The filename to use when storing the configuration. Defaults to 'sesam.conf.json'. This option is mutually exclusive with the '--expand' option.
--expand

Instead of writing the configuration to a JSON file, write it to multiple files. This option is mutually exclusive with the '--export_filename' option.

Default: False

--force

Force a "yes" response to all interactive questions.

Default: False

--dry-run

Show which files would be overwritten, deleted or created if the export had run.

Default: False

import

Imports the complete configuration from one or more files and or directories containing "*.conf.json" files.

sesam import [-h] [--server_base_url <server base url>] [--jwt <jwt filename>]
             [--server_username <username>] [--server_password <password>]
             [--server_timeout <timeout in seconds>] [--out {json,yaml,plain}]
             [--dry-run] [--force] [--verbose]
             config-file-or-folder [config-file-or-folder ...]
Positional Arguments
config-file-or-folder
 One or more configfiles and/or directories containing one or more *.conf.json files.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--dry-run

Show which files would be used if the import had been run, and which errors (if any) would have resulted.

Default: False

--force

Forces the server to accept configuration errors and do a best-effort attempt to apply the new configuration. This is rarely a good idea.

Default: False

--verbose

If specified then the full details of any errors will be displayed. (By default only a short summary of the errors is shown)

Default: False

get-license

Returns the current license info for the node

sesam get-license [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

put-license

Replaces the license for the node with the specified license key

sesam put-license [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
                  path-to-license-key
Positional Arguments
path-to-license-key
 The file containing the license key.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-secrets

Returns the current secret for the node

sesam get-secrets [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

put-secrets

Updates the node secret manager with the contents of a key:secret JSON file

sesam put-secrets [-h] [--server_base_url <server base url>]
                  [--jwt <jwt filename>] [--server_username <username>]
                  [--server_password <password>]
                  [--server_timeout <timeout in seconds>]
                  [--out {json,yaml,plain}] [--dont_encrypt]
                  path-to-secrets-file
Positional Arguments
path-to-secrets-file
 The file containing the secrets in JSON format.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

--dont_encrypt

Don't encrypt the secrets (for testing purposes).

Default: False

delete-secret

Deletes the given secret from the node

sesam delete-secret [-h] [--server_base_url <server base url>]
                    [--jwt <jwt filename>] [--server_username <username>]
                    [--server_password <password>]
                    [--server_timeout <timeout in seconds>]
                    [--out {json,yaml,plain}]
                    secret-key
Positional Arguments
secret-key The secret key to delete.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

get-env-vars

Returns the current environment variables for the node

sesam get-env-vars [-h] [--server_base_url <server base url>]
                   [--jwt <jwt filename>] [--server_username <username>]
                   [--server_password <password>]
                   [--server_timeout <timeout in seconds>]
                   [--out {json,yaml,plain}]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

put-env-vars

Replaces the contents of the node environment variable manager with the contents of a environment-var:value JSON file

sesam put-env-vars [-h] [--server_base_url <server base url>]
                   [--jwt <jwt filename>] [--server_username <username>]
                   [--server_password <password>]
                   [--server_timeout <timeout in seconds>]
                   [--out {json,yaml,plain}]
                   path-to-env-vars-file
Positional Arguments
path-to-env-vars-file
 The file containing the environment variables in JSON format.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

post-env-vars

Updates the node environment variable manager with the contents of a environment-var:value JSON file

sesam post-env-vars [-h] [--server_base_url <server base url>]
                    [--jwt <jwt filename>] [--server_username <username>]
                    [--server_password <password>]
                    [--server_timeout <timeout in seconds>]
                    [--out {json,yaml,plain}]
                    path-to-env-vars-file
Positional Arguments
path-to-env-vars-file
 The file containing the environment variables in JSON format.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

delete-env-var

Deletes the given environment variable from the node

sesam delete-env-var [-h] [--server_base_url <server base url>]
                     [--jwt <jwt filename>] [--server_username <username>]
                     [--server_password <password>]
                     [--server_timeout <timeout in seconds>]
                     [--out {json,yaml,plain}]
                     env-var
Positional Arguments
env-var The environment variable to delete.
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60
--out

Possible choices: json, yaml, plain

The output format to use. The default format is 'json'.

Default: "json"

login

Log in to a sesam installation

sesam login [-h] [--server_base_url <server base url>] [--jwt <jwt filename>]
            [--server_username <username>] [--server_password <password>]
            [--server_timeout <timeout in seconds>]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60

logout

Log out from a sesam installation

sesam logout [-h] [--server_base_url <server base url>] [--jwt <jwt filename>]
             [--server_username <username>] [--server_password <password>]
             [--server_timeout <timeout in seconds>]
Named Arguments
--server_base_url
 
The server base url to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_base_url http://localhost:10001/api
--jwt
Specify a file containg a JWT authorization token to use when talking to the server. If
specified, this overrides any JWT-token that has been stored as a result of a 'sesam login' command. Example usage: --jwt ~/my_jwt_tokens/prodserver1.jwt
--server_username
 
The username to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_username olanorman
--server_password
 
The password to use when authenticating to the server. If specified, this overrides any default value
that has been set with the 'config' command. Example usage: --server_password verysecret
--server_timeout
 
The server timeout to use. If specified, this overrides any default value that has been set with the
'config' command. Example usage: --server_timeout 60