Lsctl command reference
lcstl
The license server command line interface
lsctl [global options] command [command options] [arguments...]
Commands
Command | Description |
---|---|
lcstl login | Log into the License Server, preserve configuration |
lcstl info | License server information |
lcstl client | Manage clients |
lcstl license | Manage/Load License server's licenses |
lcstl users | Manage users |
lcstl ha | License server High Availability setup |
lcstl help , h | Shows a list of commands or help for one command |
Options
Option | Description |
---|---|
--help , -h | show help |
--version , -v | print the version |
lcstl info
License server information
lsctl info command [command options] [arguments...]
Commands
Command | Description |
---|---|
lcstl info health | Display Health info |
lcstl info hostids | Display License server's hostIDs |
lcstl info endpoint | Display License server's endpoint |
lcstl info version | Display versions |
Options
Option | Description |
---|---|
--help , -h | show help |
lcstl client
Manage attached Portworx clients
lsctl client command [command options] [arguments...]
Commands
Command | Description |
---|---|
lcstl client ls | Display clients details |
lcstl client usage | Display clients checked-out features |
Options
Option | Description |
---|---|
--help , -h | show help |
lsctl login
Log in to the license server
lsctl login [OPTIONS] <endpoint> [<instance>]
Options
Option | Description |
---|---|
-u value, --username value | Specify username |
-p value, --password value | Specify password |
--allow-unknown-root-ca | Allow 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
Command | Description |
---|---|
lsctl license ls | Display available license features details |
lsctl license activate | Activate licensing codes for license server |
lsctl license add | Adds a binary license file to license server |
Options
Option | Description |
---|---|
--help , -h | show help |
lsctl users
Manage users
lsctl users command [command options] [arguments...]
Commands
Command | Description |
---|---|
lsctl users ls | Lists users |
lsctl users create | Create new user |
lsctl users setrole | Set existing user's roles |
lsctl users passwd | Change existing user's password |
lsctl users delete , lsctl users rm | Delete user by ID |
Options
Option | Description |
---|---|
--help , -h | show help |
lsctl ha
License server High Availability setup
lsctl ha command [command options] [arguments...]
Commands
Command | Description |
---|---|
lsctl ha info | Display instance High Availability details |
lsctl ha conf | Configure License servers HA pair |
Options
Option | Description |
---|---|
--help , -h | show help |