Skip to main content

License Manager CLI Client

Project description

The License Manager CLI is a client to interact with the License Manager API.

The resources that can be interacted with are:

  • Configurations: information about the license, its features and the location of the license server.

  • Licenses: Information about license usage and availability.

  • Bookings: Information about licenses booked for future use.

The Bookings and Licenses information are read only. The Configurations can be edited by users with permission to do so.

Usage

Command

Description

lm-cli login

Generate a URL for logging in via browser

lm-cli show-token

Print your access token (created after logging in)

lm-cli logout

Logout and remove your access token

lm-cli licenses list

List all licenses

lm-cli licenses list –search <search string>

Search licenses with the specified string

lm-cli licenses list –sort-field <sort field>

Sort licenses by the specified field

lm-cli licenses list –sort-field <sort field> –sort-order ascending

Sort licenses by the specified order

lm-cli bookings list

List all bookings

lm-cli bookings list –search <search string>

Search bookings with the specified string

lm-cli bookings list –sort-field <sort field>

Sort bookings by the specified field

lm-cli bookings list –sort-field <sort field> –sort-order ascending

Sort bookings by the specified order

lm-cli configurations list

List all configurations

lm-cli configurations get-one – id <configuration id>

List the configuration with the specified id

lm-cli configurations list –search <search string>

Search configurations with the specified string

lm-cli configurations list –sort-field <sort field>

Sort configurations by the specified field

lm-cli configurations list –sort-field <sort field> –sort-order ascending

Sort configurations by the specified order

lm-cli configurations create –name <config name> –product <product name> –features <features as a string serialized JSON object> –license-servers <license servers list> –license-server-type <license server type> –grace-time <grace time in seconds> –client-id <cluster identification where the license is configured>

Create a new configuration

lm-cli configurations delete –id <id to delete>

Delete the configuration with the specified id

Development Setup

To create a development setup, use Poetry to create the virtualenv with the dependencies:

$ cd lm-cli
$ poetry install

Also create a .env file with the needed values needed to run the project. These include the License Manager API endpoint and the OIDC provider information to retrieve the access token.

$ cat <<EOF > .env
LM_API_ENDPOINT="<API endpoint>"
OIDC_DOMAIN="<OIDC domain>"
OIDC_AUDIENCE="<OIDC audience>"
OIDC_CLIENT_ID="<OIDC client id>"
EOF

To run the tests, use the Makefile:

$ make test

To lint and format the code, use the Makefile:

$ make format

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

license_manager_cli-3.0.8.tar.gz (18.7 kB view hashes)

Uploaded Source

Built Distribution

license_manager_cli-3.0.8-py3-none-any.whl (26.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page