License Manager CLI Reference
Global Commands
Entry point for the License Manager CLI App.
Log in to the lm-cli by storing the supplied token argument in the cache.
main(ctx: typer.Context, verbose: bool = typer.Option(False, help='Enable verbose logging to the terminal'), version: bool = typer.Option(False, help='Print the version of lm-cli and exit'))
Welcome to the License Manager CLI!
More information can be shown for each command listed below by running it with the --help option.
show_token(plain: bool = typer.Option(False, help='Show the token in plain text.'), refresh: bool = typer.Option(False, help='Show the refresh token instead of the access token.'), show_prefix: bool = typer.Option(False, '--prefix', help="Include the 'Bearer' prefix in the output."), show_header: bool = typer.Option(False, '--header', help='Show the token as it would appear in a request header.'), decode: bool = typer.Option(False, '--decode', help='Show the content of the decoded access token.'))
Show the token for the logged in user.
Token output is automatically copied to your clipboard.
Configurations
A typer app that can interact with Configurations data in a cruddy manner.
create(ctx: typer.Context, name: str = typer.Option(..., help='The name of configuration to create.'), cluster_client_id: str = typer.Option(..., help='The cluster OIDC client_id of the cluster where the configuration is being added.'), grace_time: int = typer.Option(..., help='The grace time for jobs using the license. Must be in seconds.'), license_server_type: LicenseServerType = typer.Option(..., help='The license server type.'))
Create a new configuration.
delete(ctx: typer.Context, id: int = typer.Option(..., help='The id of the configuration to delete.'))
Delete an existing configuration.
get_one(ctx: typer.Context, id: int = typer.Option(int, help='The specific id of the configuration.'))
Get a single configuration by id.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show configuration information.
License Servers
A typer app that can interact with License Servers data in a cruddy manner.
create(ctx: typer.Context, config_id: int = typer.Option(..., help='The config_id of the license server.'), host: str = typer.Option(..., help='The hostname of the license server.'), port: int = typer.Option(..., help='The port of the license server.'))
Create a new license server.
delete(ctx: typer.Context, id: int = typer.Option(..., help='The id of the license server to delete.'))
Delete an existing license server.
get_one(ctx: typer.Context, id: int = typer.Option(int, help='The specific id of the license server.'))
Get a single license server by id.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show license server information.
Products
A typer app that can interact with Products data in a cruddy manner.
create(ctx: typer.Context, name: str = typer.Option(..., help='The name of product to create. Must match the product name in the license.'))
Create a new product.
Delete an existing product.
Get a single product by id.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show product information.
Features
A typer app that can interact with Features data in a cruddy manner.
create(ctx: typer.Context, name: str = typer.Option(..., help='The name of feature to create. Must match the feature name in the license.'), product_id: int = typer.Option(..., help='The product_id of the feature.'), config_id: int = typer.Option(..., help='The config_id of the feature.'), reserved: int = typer.Option(..., help='How many licenses should be reserved for usage in desktop enviroments.'))
Create a new feature.
Delete an existing feature.
Get a single feature by id.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show feature information.
Jobs
A typer app that can interact with Jobs endpoint to list data.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show job information.
Bookings
A typer app that can interact with Bookings endpoint to list data.
list_all(ctx: typer.Context, search: Optional[str] = typer.Option(None, help='Apply a search term to results.'), sort_order: SortOrder = typer.Option(SortOrder.UNSORTED, help='Specify sort order.'), sort_field: Optional[str] = typer.Option(None, help='The field by which results should be sorted.'))
Show booking information.