Show / Hide Table of Contents

ILSCli - ILS Command Line Interface

pre-condition: your device has the ILSCli installed

If not, see How to download and install ILSCli for more details.

ILS makes all necessary commands available to you via the command line through ILSCli. You can use this for convenient control of your licenses and devices via shell scripts or an interactive shell. Be aware that ILSCli uses the settings from the IlsConfig.json file if you don't supply any options.

Usage

ILSCli is organized hierarchically. Calling ILSCli without any arguments will give you an overview of the usage and the primary commands or better "topics" you can work on. At the time of writing these are

ILSCli device
ILSCli license
ILSCli service

In general, you can append the option "-h", "-?" or "--help" to any of the above calls to get an information about the "subcommands" that are available for the topic, e.g.:

ILSCli device -?

will show you all available subcommands for the topic "device".

The same applies when you go further down the hierarchy by using subcommands such as

ILSCli device info -?

This will display all arguments, options or sub-subcommands (currently none) to the "device info" command.

Overview

Use this as a quick overview of what kind of commands are supported at the time of writing, but stick to the above rules and investigate the commands and options interactively with on of the help-options "-?", "-h", "--help". Not all changes or additions might be documented here.

Working with devices

The device commands look for the settings of the actual device (the device you're working on!) if you don't supply any other options. To query this information, you should first call

ILSCli device determine

This will setup the data for the actual device that will be used as a default from then on.

Determine device identifiers

ILSCli device determine [options]

Used to get all device identifiers for a certain device.

Try

ILSCli device determine -?

for a list of options and their meaning.

Get information about a device

ILSCli device info [-i <path of device file>] 

This command will extract information from the actual device you're working on or from the given device file if you use the option "-i".

Add a device

ILSCli device add [-u localhost:5000 -s -i c:\hostinfo.json]

Adds the actual device to the ILS server. If you supply the example options, the device that is defined in c:\hostinfo.json will be added to the ILSServer running https (-s) at "localhost:5000" (-u) with data given in file c:\hostinfo.json (-i).

Get a device list from server

ILSCli device list [-u localhost:5000 -s]

Gets a device list from an ILS server running https (-s) at localhost:5000. If you don't use any options, the server that is setup in the configuration of your actual device will be used.

Working with licenses

See

ILSCli license <command> -?

for a list of arguments and options.

Get information about a license

ILSCli license info -i <path of device file> 

This command will extract information from the given license file.

Download a license

ILSCli license download licenskey [options]

Downloads a single license with the given licensekey for the actual device from the server. Use the according options to override the default settings for the actual device.

Download all licenses for a given device

ILSCli license downloadall [options]

Downloads all licenses for the actual device. See the options to override the default behaviour.

Backup a license to local conputer

ILSCli license backup licensekey [options]

A backup license can be restored via "publishing" via ILSCli license publish.

Publishing a license

ILSCli license publish -u localhost:5000 -s -i c:\licinfo.json

Adds a license to an ILS service running https (-s) at localhost:5000 with data given in file c:\licinfo.json.

Working with service

Get all licenses for an account

ILSCli service licenses -u localhost:5000 -s -i c:\licinfo.json

Get all licenses from an ILS service running https (-s) at localhost:5000 with data given in file c:\licinfo.json.

Back to top Copyright © 2017-2019 insite Ingenieurgesellschaft für Steuerungs- und Informationstechnik mbH