anchorectl system
System related operations.
Every command on this page also accepts the global flags.
Subcommands
- system artifact-lifecycle-policy — Global artifact lifecycle policy operations
- system delete — Delete service
- system integration — Product Integration Operations
- system role — RBAC Role Operations
- system smoke-tests — Smoke test related operations
- system status — Get the system status
- system wait — Wait for configured Anchore system to be running based upon set of filters
system artifact-lifecycle-policy
Global artifact lifecycle policy operations.
anchorectl system artifact-lifecycle-policy [command]
Subcommands
- system artifact-lifecycle-policy add — Creates an artifact lifecycle policy.
- system artifact-lifecycle-policy delete — Delete artifact lifecycle policy
- system artifact-lifecycle-policy get — Get single artifact lifecycle policy with latest conditions
- system artifact-lifecycle-policy list — List all artifact lifecycle policies
- system artifact-lifecycle-policy update — Updates an artifact lifecycle policy.
system artifact-lifecycle-policy add
Creates an artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy add [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
--action | string | — | "" | Yes | The artifact policy action. Allowable values: delete. |
--artifact-type | string | — | "" | Yes | The artifact type the policy will act on. Allowable values: image. |
--days-since-analyzed | string | — | "" | Yes | The number of days elapsed since the artifact was analyzed for it to be selected for action. |
--even-if-exists-in-runtime | string | — | "" | Yes | When true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false. |
--include-base-images | string | — | "" | Yes | When true, images matching all criteria and with known children can be selected for action. Allowable values: true, false. |
--include-failed-analysis | string | — | "" | Yes | When true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false. |
--name | string | — | "" | Yes | A unique name for the artifact policy. |
--description | string | — | "" | No | A description for the policy. |
--enable | string | — | false | No | When true, the policy will be enabled. Allowable values: true, false. |
-o, --output | string | — | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system artifact-lifecycle-policy delete
Delete artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy delete POLICY_UUID [flags]
Aliases: del
Arguments
| Argument | Description |
|---|---|
POLICY_UUID | The uuid of the artifact lifecycle policy. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system artifact-lifecycle-policy get
Get single artifact lifecycle policy with latest conditions.
anchorectl system artifact-lifecycle-policy get POLICY_UUID [flags]
Arguments
| Argument | Description |
|---|---|
POLICY_UUID | The uuid of the artifact lifecycle policy. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system artifact-lifecycle-policy list
List all artifact lifecycle policies.
anchorectl system artifact-lifecycle-policy list [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system artifact-lifecycle-policy update
Updates an artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy update POLICY_UUID [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
--action | string | — | "" | Yes | The artifact policy action. Allowable values: delete. |
--artifact-type | string | — | "" | Yes | The artifact type the policy will act on. Allowable values: image. |
--days-since-analyzed | string | — | "" | Yes | The number of days elapsed since the artifact was analyzed for it to be selected for action. |
--enable | string | — | "" | Yes | When true, the policy will be enabled. Allowable values: true, false. |
--even-if-exists-in-runtime | string | — | "" | Yes | When true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false. |
--include-base-images | string | — | "" | Yes | When true, images matching all criteria and with known children can be selected for action. Allowable values: true, false. |
--include-failed-analysis | string | — | "" | Yes | When true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false. |
--name | string | — | "" | Yes | A unique name for the artifact policy. |
--description | string | — | "" | No | A description for the policy. |
-o, --output | string | — | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system delete
Delete service.
anchorectl system delete SERVICE_NAME HOST_ID [flags]
Aliases: del
Arguments
| Argument | Description |
|---|---|
SERVICE_NAME | The service to delete, as shown in the SERVICE column of anchorectl system status. |
HOST_ID | The host ID of the service instance, as shown in the HOST ID column of anchorectl system status. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system integration
Product Integration Operations.
anchorectl system integration [command]
Subcommands
- system integration delete — Delete the health data for an integration instance
- system integration get — Get information about an integration instance
- system integration list — Lists all integrations that have been created (explicitly or indirectly via registration).
system integration delete
Delete the health data for an integration instance.
anchorectl system integration delete INTEGRATION_UUID [flags]
Aliases: del
Arguments
| Argument | Description |
|---|---|
INTEGRATION_UUID | The integration UUID. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
--force | bool | ANCHORECTL_FORCE | false | No | Force deletion of the integration instance regardless of its state. |
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system integration get
Get information about an integration instance.
anchorectl system integration get INTEGRATION [flags]
Arguments
| Argument | Description |
|---|---|
INTEGRATION | The integration UUID. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system integration list
Lists all integrations that have been created (explicitly or indirectly via registration).
anchorectl system integration list [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system role
RBAC Role Operations.
anchorectl system role [command]
Subcommands
- system role get — Get detailed information about a specific role
- system role list — List roles available in the system
system role get
Get detailed information about a specific role.
anchorectl system role get ROLE_NAME [flags]
Arguments
| Argument | Description |
|---|---|
ROLE_NAME | Name of the RBAC Role. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system role list
List roles available in the system.
anchorectl system role list [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system smoke-tests
Smoke test related operations.
anchorectl system smoke-tests [command]
Subcommands
- system smoke-tests run — Run smoke tests
system smoke-tests run
Run smoke tests.
anchorectl system smoke-tests run [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-i, --image | string | — | "" | No | The image to run the smoke tests against. |
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system status
Get the system status.
anchorectl system status [flags]
Examples
anchorectl system status
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
system wait
Wait for configured Anchore system to be running based upon set of filters.
anchorectl system wait [flags]
Examples
# Block until the API is up and feeds have synced, giving up after 5 minutes
anchorectl system wait --timeout 300
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-i, --interval | int | ANCHORECTL_SYSTEM_INTERVAL | 5 | No | Interval in which to query the system, in seconds. Default = 5. |
--services | string (repeatable) | ANCHORECTL_SYSTEM_SERVICES | [apiext] | No | Service(s) to wait for. Options are [apiext,catalog,component_catalog,policy_engine,simplequeue,analyzer,notifications,reports,reports_worker]. |
-t, --timeout | int | ANCHORECTL_SYSTEM_TIMEOUT | -1 | No | Number of seconds to wait until error out. < 0 waits forever. Default = -1. |
--wait-for-feeds | bool | ANCHORECTL_SYSTEM_WAIT_FOR_FEEDS | true | No | Wait until feeds are synced. Defaults to true. |