scanner

scanner create

scanner create <NAME> <URL> [OPTIONS]

Create a new scanner.

Arguments

NAME
The name of this registration
Type: text
Required: ✅

URL
A base URL of the scanner adapter.
Type: text
Required: ✅

Options

--description <DESCRIPTION>
An optional description of this registration.
Type: text

--auth <AUTH>
Specify what authentication approach is adopted for the HTTP communications. Supported types Basic", "Bearer" and api key header "X-ScannerAdapter-API-Key"
Type: text

--access-credential <ACCESS_CREDENTIAL>
An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.
Type: text

--skip-cert-verify <SKIP_CERT_VERIFY>
Indicate if skip the certificate verification when sending HTTP requests
Type: boolean

--use-internal-addr <USE_INTERNAL_ADDR>
Indicate whether use internal registry addr for the scanner to pull content or not
Type: boolean

--disabled <DISABLED>
Indicate whether the registration is enabled or not
Type: boolean

---

scanner default

scanner default <SCANNER_ID> [OPTIONS]

Set/unset default scanner.

Arguments

SCANNER_ID
ID of the scanner to set as default.
Type: text
Required: ✅

Options

--unset
Unset the given scanner as default.
Type: boolean (flag)
Default: False

---

scanner delete

scanner delete <SCANNER_ID> [OPTIONS]

Delete a scanner.

Arguments

SCANNER_ID
ID of the scanner to delete.
Type: text
Required: ✅

Options

--force
Force deletion without confirmation.
Type: boolean (flag)
Default: False

---

scanner get

scanner get <SCANNER_ID>

Get a specific scanner.

Arguments

SCANNER_ID
ID of the scanner to retrieve.
Type: text
Required: ✅

---

scanner list

scanner list [OPTIONS]

List scanners.

Options

--query <QUERY>
Query parameters to filter the results.
See harborapi docs for more information.
Type: text

--sort <SORT>
Sorting order of the results. Example: 'name,-id' to sort by name ascending and id descending.
Type: text

--page <PAGE>
(Advanced) Page to begin fetching from.
Type: integer
Default: 1

--page-size <PAGE_SIZE>
(Advanced) Results to fetch per API call.
Type: integer
Default: 10

--limit <LIMIT>
Maximum number of results to fetch.
Type: integer

---

scanner update

scanner update <SCANNER_ID> [OPTIONS]

Update a scanner.

Arguments

SCANNER_ID
ID of the scanner to update.
Type: text
Required: ✅

Options

--name <NAME>
The name of this registration
Type: text

--url <URL>
A base URL of the scanner adapter.
Type: text

--description <DESCRIPTION>
An optional description of this registration.
Type: text

--auth <AUTH>
Specify what authentication approach is adopted for the HTTP communications. Supported types Basic", "Bearer" and api key header "X-ScannerAdapter-API-Key"
Type: text

--access-credential <ACCESS_CREDENTIAL>
An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.
Type: text

--skip-cert-verify <SKIP_CERT_VERIFY>
Indicate if skip the certificate verification when sending HTTP requests
Type: boolean

--use-internal-addr <USE_INTERNAL_ADDR>
Indicate whether use internal registry addr for the scanner to pull content or not
Type: boolean

--disabled <DISABLED>
Indicate whether the registration is enabled or not
Type: boolean
Default: False

---