opentf-ctl

Note

opentf-ctl is a component of opentf-tools, which must be installed before use. Please refer to “Install tools” for more information on how to install.

The OpenTestFactory command-line tool, opentf-ctl, allows you to run commands against orchestrators. You can use opentf-ctl to run workflows, inspect and manage orchestrator resources, and view workflow logs.

Basic Commands

• get workflows List active and recent workflows
• run workflow {filename} Start a workflow
• get workflow {workflow_id} Get a workflow status
• kill workflow {workflow_id} Cancel a running workflow

Agent Commands

• get agents List registered agents
• delete agent {agent_id} De-register an agent

Channel Commands

• get channels List known channels

Quality Gate Commands

• get qualitygate {workflow_id} Get quality gate status for a workflow
• describe qualitygate {workflow_id} Get description of a quality gate status for a workflow

Attachment Commands

• get attachments {workflow_id} List workflow attachments
• cp {workflow_id}:{...} {destination} Copy a workflow attachment or workflow attachments to the local destination
• generate report {workflow_id} using {file} Generate an Insight Collector report for a workflow

Data Sources Commands

• get datasource {workflow_id} Get workflow data sources

Token Commands

• generate token using {key} Interactively generate a signed token
• check token {token} using {key} Check if token signature matches public key
• view token {token} Show token payload

Advanced Commands

• get namespaces List accessible namespaces
• get subscriptions List active subscriptions
• delete subscription {sub_id} Cancel an active subscription

Other Commands

• config Modify current opentf-ctl configuration
• version List the tools version