Skip to content

Commands And Parameters

Artsiom Lazar edited this page Apr 19, 2023 · 4 revisions

Commands

eval

Is Default: false. Validates specified manifest.

Arguments Key Required Description argument
--file -f true Path to workflow file or url
--output -o true Path workflow definition containing all resolved variables

extract-metadata

Is Default: false. Generate a json with all commands and parameters.

Arguments Key Required Description argument
--output -o true Path to output file.

new

Is Default: false. Creates draft of analysis manifest.

Arguments Key Required Description argument
--output -o true Path to output file

new-engine-collection

Is Default: false. Creates draft of Docker engine collection manifest.

Arguments Key Required Description argument
--output -o true Path to output file

run

Is Default: true. Runs workflow defined by manifest file.

Arguments Key Required Description argument
--file -f true Path to workflow file or url
--docker-engines -d false Docker Engine collection file path
--behavior -b false Defines behavior of Docker Image loading
--exit -e false Terminates execution of program after images are Docker Images are downloaded

Docker Engines with Authentication

Example with Basic Authentication (engines.yaml)

engines:
  engine_name:
    os:
    url:
    workerImage:
    authType: Basic
    basicAuthCredentials:
        username: 
        password:

Example with X509 Authentication (engines.yaml)

engines:
  engine_name:
    os:
    url:
    workerImage:
    authType: X509
    certificateCredentials:
        fileName:
        password:

Example without Authentication (engines.yaml)

engines:
  engine_name:
    os:
    url:
    workerImage:
    authType: None

Clone this wiki locally