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.

anchorectl system artifact-lifecycle-policy [command]

Subcommands

system artifact-lifecycle-policy add

Creates an artifact lifecycle policy.

anchorectl system artifact-lifecycle-policy add [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--artifact-typestring—""YesThe artifact type the policy will act on. Allowable values: image.
--days-since-analyzedstring—""YesThe number of days elapsed since the artifact was analyzed for it to be selected for action.
--even-if-exists-in-runtimestring—""YesWhen true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-imagesstring—""YesWhen true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysisstring—""YesWhen true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy.
--enablestring—falseNoWhen true, the policy will be enabled. Allowable values: true, false.
-o, --outputstring—textNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy app-versions

Application version artifact lifecycle policy operations.

anchorectl system artifact-lifecycle-policy app-versions [command]

Subcommands

system artifact-lifecycle-policy app-versions add

Creates an artifact lifecycle policy that deletes application versions which have been EOL for longer than the configured threshold. Deletion is immediate and cannot be undone.

anchorectl system artifact-lifecycle-policy app-versions add [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--days-since-eolstring—""YesThe number of days a version must have been EOL before it is deleted.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy.
--enablestring—falseNoWhen true, the policy will be enabled. Allowable values: true, false.
-o, --outputstring—textNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy app-versions delete

Delete an application version artifact lifecycle policy.

anchorectl system artifact-lifecycle-policy app-versions delete POLICY_UUID [flags]

Aliases: del

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy app-versions get

Get a single application version artifact lifecycle policy with its current rule set.

anchorectl system artifact-lifecycle-policy app-versions get POLICY_UUID [flags]

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy app-versions list

List the artifact lifecycle policies for application versions.

anchorectl system artifact-lifecycle-policy app-versions list [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy app-versions update

Updates an application version artifact lifecycle policy. Changing the rule set records a new immutable rule-set version; the previous versions remain readable.

anchorectl system artifact-lifecycle-policy app-versions update POLICY_UUID [flags]

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--days-since-eolstring—""YesThe number of days a version must have been EOL before it is deleted.
--enablestring—""YesWhen true, the policy will be enabled. Allowable values: true, false.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy; pass an empty string to clear it.
-o, --outputstring—textNoThe 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

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy images

Image artifact lifecycle policy operations.

anchorectl system artifact-lifecycle-policy images [command]

Subcommands

system artifact-lifecycle-policy images add

Creates an artifact lifecycle policy that deletes images not associated with any application version, a configured number of days after their latest analysis. Images associated with an application version are never selected.

anchorectl system artifact-lifecycle-policy images add [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--days-since-analyzedstring—""YesThe number of days elapsed since the image was analyzed for it to be selected for action.
--even-if-exists-in-runtimestring—""YesWhen true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-imagesstring—""YesWhen true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysisstring—""YesWhen true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy.
--enablestring—falseNoWhen true, the policy will be enabled. Allowable values: true, false.
-o, --outputstring—textNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy images delete

Delete an image artifact lifecycle policy.

anchorectl system artifact-lifecycle-policy images delete POLICY_UUID [flags]

Aliases: del

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy images get

Get a single image artifact lifecycle policy with its current rule set.

anchorectl system artifact-lifecycle-policy images get POLICY_UUID [flags]

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy images list

List the artifact lifecycle policies for images.

anchorectl system artifact-lifecycle-policy images list [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.

system artifact-lifecycle-policy images update

Updates an image artifact lifecycle policy. Changing the rule set records a new immutable rule-set version; the previous versions remain readable.

anchorectl system artifact-lifecycle-policy images update POLICY_UUID [flags]

Arguments

ArgumentDescription
POLICY_UUIDThe uuid of the artifact lifecycle policy.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--days-since-analyzedstring—""YesThe number of days elapsed since the image was analyzed for it to be selected for action.
--enablestring—""YesWhen true, the policy will be enabled. Allowable values: true, false.
--even-if-exists-in-runtimestring—""YesWhen true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-imagesstring—""YesWhen true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysisstring—""YesWhen true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy; pass an empty string to clear it.
-o, --outputstring—textNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
--actionstring—""YesThe artifact policy action. Allowable values: delete.
--artifact-typestring—""YesThe artifact type the policy will act on. Allowable values: image.
--days-since-analyzedstring—""YesThe number of days elapsed since the artifact was analyzed for it to be selected for action.
--enablestring—""YesWhen true, the policy will be enabled. Allowable values: true, false.
--even-if-exists-in-runtimestring—""YesWhen true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-imagesstring—""YesWhen true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysisstring—""YesWhen true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--namestring—""YesA unique name for the artifact policy.
--descriptionstring—""NoA description for the policy.
-o, --outputstring—textNoThe 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

ArgumentDescription
SERVICE_NAMEThe service to delete, as shown in the SERVICE column of anchorectl system status.
HOST_IDThe host ID of the service instance, as shown in the HOST ID column of anchorectl system status.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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.

anchorectl system integration delete INTEGRATION_UUID [flags]

Aliases: del

Arguments

ArgumentDescription
INTEGRATION_UUIDThe integration UUID.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
--forceboolANCHORECTL_FORCEfalseNoForce deletion of the integration instance regardless of its state.
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

ArgumentDescription
INTEGRATIONThe integration UUID.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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.

anchorectl system role get ROLE_NAME [flags]

Arguments

ArgumentDescription
ROLE_NAMEName of the RBAC Role.

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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.

anchorectl system smoke-tests run [flags]

Flags

FlagTypeEnvironment variableDefaultRequiredDescription
-i, --imagestring—""NoThe image to run the smoke tests against.
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
-o, --outputstringANCHORECTL_FORMATtextNoThe 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

FlagTypeEnvironment variableDefaultRequiredDescription
-i, --intervalintANCHORECTL_SYSTEM_INTERVAL5NoInterval in which to query the system, in seconds. Default = 5.
--servicesstring (repeatable)ANCHORECTL_SYSTEM_SERVICES[apiext]NoService(s) to wait for. Options are [apiext,catalog,component_catalog,policy_engine,simplequeue,analyzer,notifications,reports,reports_worker].
-t, --timeoutintANCHORECTL_SYSTEM_TIMEOUT-1NoNumber of seconds to wait until error out. < 0 waits forever. Default = -1.
--wait-for-feedsboolANCHORECTL_SYSTEM_WAIT_FOR_FEEDStrueNoWait until feeds are synced. Defaults to true.
Last modified November 3, 2026