Skip to main content
Version: 3.1

Lsctl command reference

lcstl

The license server command line interface

lsctl [global options] command [command options] [arguments...]

Commands

CommandDescription
lcstl loginLog into the License Server, preserve configuration
lcstl infoLicense server information
lcstl clientManage clients
lcstl licenseManage/Load License server's licenses
lcstl usersManage users
lcstl haLicense server High Availability setup
lcstl help, hShows a list of commands or help for one command

Options

OptionDescription
--help, -hshow help
--version, -vprint the version

lcstl info

License server information

lsctl info command [command options] [arguments...]

Commands

CommandDescription
lcstl info healthDisplay Health info
lcstl info hostidsDisplay License server's hostIDs
lcstl info endpointDisplay License server's endpoint
lcstl info versionDisplay versions

Options

OptionDescription
--help, -hshow help

lcstl client

Manage attached Portworx clients

lsctl client command [command options] [arguments...]

Commands

CommandDescription
lcstl client lsDisplay clients details
lcstl client usageDisplay clients checked-out features

Options

OptionDescription
--help, -hshow help

lsctl login

Log in to the license server

lsctl login [OPTIONS] <endpoint> [<instance>]

Options

OptionDescription
-u value, --username valueSpecify username
-p value, --password valueSpecify password
--allow-unknown-root-caAllow the license server to import an unknown SSL Root certificate authority

lsctl license

Manage and load license server's licenses

lsctl license command [command options] [arguments...]

Commands

CommandDescription
lsctl license lsDisplay available license features details
lsctl license activateActivate licensing codes for license server
lsctl license addAdds a binary license file to license server

Options

OptionDescription
--help, -hshow help

lsctl users

Manage users

lsctl users command [command options] [arguments...]

Commands

CommandDescription
lsctl users lsLists users
lsctl users createCreate new user
lsctl users setroleSet existing user's roles
lsctl users passwdChange existing user's password
lsctl users delete, lsctl users rmDelete user by ID

Options

OptionDescription
--help, -hshow help

lsctl ha

License server High Availability setup

lsctl ha command [command options] [arguments...]

Commands

CommandDescription
lsctl ha infoDisplay instance High Availability details
lsctl ha confConfigure License servers HA pair

Options

OptionDescription
--help, -hshow help
Was this page helpful?