`license` command group¶

Q: Does license search create, request, or verify a license?

No. license search is read-only. It queries the license-definition catalog and never creates, requests, or verifies a license.

Q: What happens if I run license search without a query term?

The full catalog is returned, paged by --query-page-number and --query-page-size. A blank or omitted -q/--query is treated as match everything.

Q: Do I need a host profile and login to run license search?

Yes. license search is a remote gRPC call, so it needs a host profile created with profile hosts create and an authenticated session from profile authn login.

Q: Which query modes are supported?

The -m/--query-mode option accepts QUERY_MODE_WEB, QUERY_MODE_PLAIN, or QUERY_MODE_ILIKE. The default is QUERY_MODE_ILIKE.

The license command group exposes a read-only, searchable catalog of {{ product_name }} license definitions. Use it to discover which license definitions exist and inspect their metadata. The group is query-only: there is a single leaf, license search, that filters the catalog by term, query mode, and pagination.

Remote command — host profile and login required

license search is a remote gRPC call. Before running it, create a host profile with profile hosts create and authenticate with profile authn login. Select a non-default profile for a single invocation with the global -p/--profile option, placed before the command path.

Commands in this group¶

Command	Purpose
`license search`	Search the read-only license-definition catalog

Group help¶

bin/admin.sh license --help

`license search`¶

Search the available license definitions. With no search term the full catalog is returned, paged according to the pagination options.

Syntax¶

bin/admin.sh license search [options]

Required options¶

This command has no command-specific required options.

Optional options¶

Show optional options

Option	Default	Description
`-q`, `--query`	none	Search string. When omitted or blank, the full catalog is returned
`-m`, `--query-mode`	`QUERY_MODE_ILIKE`	Query mode: `QUERY_MODE_WEB`, `QUERY_MODE_PLAIN`, or `QUERY_MODE_ILIKE`
`-n`, `--query-page-number`	`1`	Start page (the first page is page number 1)
`-s`, `--query-page-size`	`50`	Page size (minimum 1, maximum 250)
`-f`, `--out-format`	`YAML`	Output format: `JSON` or `YAML`

Validation rules

-m/--query-mode accepts only QUERY_MODE_WEB, QUERY_MODE_PLAIN, or QUERY_MODE_ILIKE.
-s/--query-page-size must be between 1 and 250.
-n/--query-page-number is 1-based; the first page is page number 1.
A blank or omitted -q/--query returns the full catalog rather than an empty result.

Example (full catalog, default paging)¶

bin/admin.sh license search

Example (filter by term, JSON output)¶

bin/admin.sh license search \
  -q standard \
  -m QUERY_MODE_ILIKE \
  -n 1 \
  -s 50 \
  -f json

Example (second page, larger page size, explicit profile)¶

bin/admin.sh -p prod-admin license search \
  --query enterprise \
  --query-mode QUERY_MODE_PLAIN \
  --query-page-number 2 \
  --query-page-size 100 \
  --out-format yaml

Standard CLI options are documented in Global options.

FAQ¶

Does license search create, request, or verify a license?

No. license search is read-only. It queries the license-definition catalog and never creates, requests, or verifies a license.

What happens if I run license search without a query term?

The full catalog is returned, paged by --query-page-number and --query-page-size. A blank or omitted -q/--query is treated as "match everything".

Do I need a host profile and login to run license search?

Yes. license search is a remote gRPC call, so it needs a host profile created with profile hosts create and an authenticated session from profile authn login.

Which query modes are supported?

-m/--query-mode accepts QUERY_MODE_WEB, QUERY_MODE_PLAIN, or QUERY_MODE_ILIKE. The default is QUERY_MODE_ILIKE.

license command group¶