Command Index

analysisdatasets

$ ica analysisdatasets --help
The root command for actions that act on analysis datasets in GSS

Usage:
  ica analysisdatasets [flags]
  ica analysisdatasets [command]

Available Commands:
  list        Get list of analysis datasets

Flags:
  -h, --help   help for analysisdatasets

analysisdatasets list

$ ica analysisdatasets list --help
Get a list of analysis datasets to which you have access.

Usage:
  ica analysisdatasets list [flags]

Flags:
      --analysis-run-id strings   optional parameter. Set to filter the analysis datasets list and only include analysis datasets associated with the provided analysis runs
  -h, --help                      help for list
      --include strings           include options
      --max-items int             maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32           optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string         page token used for retrieving paged list results
      --sort-by string            specifies the order to list items (default "timeCreated Desc")

completion

$ ica completion --help
Generates bash completion scripts
        to load completion run the following on a bash shell prompt

        . <(ica completion)

        To configure your bash shell to load completions for each session add to your bashrc

        # ~/.bashrc or ~/.profile
        . <(ica completion)

Usage:
  ica completion [flags]

Flags:
  -h, --help   help for completion

config

Usage:
  ica config [flags]
  ica config [command]

Available Commands:
  get         Get configuration information
  set         Set configuration information

Flags:
  -h, --help   help for config

config get

Get configuration information.

Usage:
  ica config get [flags]

Flags:
  -h, --help   help for get

config set

Set configuration information.

Usage:
  ica config set [flags]

Flags:
  -h, --help   help for set

files

Usage:
  ica files [flags]
  ica files [command]

Available Commands:
  archive     Archives a gds file
  create      Create a file
  delete      Delete file(s) from GDS
  download    Download the specified file
  get         Get file info
  list        Get list of files
  unarchive   Unarchives a gds file
  update      Get upload credentials and optionally set type for a specified file
  upload      Upload a file

Flags:
  -h, --help   help for files

files archive

Archives a gds file.  Files in archived, archiving or unarchiving state will not be included in filter for batch action.

Usage:
  ica files archive [file id or gdspath, or gdspath filter for batch action] [flags]

Flags:
  -h, --help          help for archive
      --tier string   storage tier [archive, deepArchive] (default "archive")

files create

Create a file in GDS to get upload credentials.  File gdspath should be of form gds://{volumeName}/{path}.

Usage:
  ica files create [file gdspath] [flags]

Flags:
      --acl strings       Comma delimited list of acls on which to filter the list
  -h, --help              help for create
      --set-type string   explicitly set file type
      --with-access       return object store access

files delete

Delete file(s) from GDS.  Files in archiving or unarchiving state will not be included in filter for batch action.

Usage:
  ica files delete [file id or gdspath, or gdspath filter for batch action] [flags]

Flags:
      --force   force delete without prompts
  -h, --help    help for delete

files download

Download the specified file

Usage:
  ica files download [file id or gdspath, or gdspath filter for batch action] [local path] [flags]

Flags:
  -h, --help                 help for download
      --num-workers int      number of workers to parallelize.  Default calculated based on CPUs available.
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

files get

Get file info, including presigned url

Usage:
  ica files get [file id or gdspath] [flags]

Flags:
  -h, --help                 help for get
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

files list

Get a list of files to which you have access.  A filter path is required of form gds://{volumeName}/{path}

Usage:
  ica files list [gdspath to use as filter] [flags]

Flags:
      --acl strings             Comma delimited list of acls on which to filter the list
      --archive-status string   filter by archive status comma seperated list of any of [None, Archived, Archiving, Unarchiving].  Default includes all
  -h, --help                    help for list
      --is-uploaded string      filter for files that have either been uploaded or are not yet uploaded [true or false].  Default includes all
      --max-items int           maximum number of items to return, use 0 for no limit (default 50)
      --nonrecursive            Optional field to specify that resources should not be returned recursively in and under the specified paths. Only returns resources directly in the specified paths
      --page-size int32         optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string       page token used for retrieving paged list results
      --sort-by string          specifies the order to list items (default "timeCreated Desc")
      --tenant-id string        tenant identifier of the resource(s)
      --tenant-name string      Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml
      --with-access             return object store access

files unarchive

Unarchives a gds file.  Only files in archived state will  be included in filter for batch action.

Usage:
  ica files unarchive [file id or gdspath, or gdspath filter for batch action] [flags]

Flags:
  -h, --help           help for unarchive
      --speed string   restore speed [standard, economy] (default "economy")

files update

Usage:
  ica files update [file id or gds path] [flags]

Flags:
  -h, --help              help for update
      --set-type string   explicitly set file type
      --with-access       return object store access

files upload

Upload a file to GDS.  If the target path does not already exist, it will be created automatically.

Usage:
  ica files upload [LOCAL-PATH] [gdspath] [flags]

Flags:
  -h, --help   help for upload

folders

This is the root command for actions that act on folders in GDS.

Usage:
  ica folders [flags]
  ica folders [command]

Available Commands:
  archive     Archive folder from GDS
  copy        Copy a folder
  create      Create a folder
  delete      Delete folder from GDS
  get         Get folder info
  jobs        Folder job actions
  list        Get list of folders
  sessions    Folder session actions
  unarchive   Unarchive folder from GDS
  update      Get upload credentials for an existing folder
  upload      Upload a folder

folders archive

Archive folder from GDS

Usage:
  ica folders archive [folder id or gdspath] [flags]

Flags:
  -h, --help          help for archive
      --tier string   storage tier [archive, deepArchive] (default "archive")

folders copy

Copy a folder from a source folder to another existing parent folder.  Folders should be of the form gds://{volumeName}/{path}.

Usage:
  ica folders copy [source_folder gdspath] [target_parent_folder gdspath] [flags]

Flags:
  -h, --help                 help for copy
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~/.ica/.tenants.yaml

folders create

Create a folder in GDS to get upload credentials

Usage:
  ica folders create [folder gdspath] [flags]

Flags:
      --acl strings   Comma delimited list of acls on which to filter the list
  -h, --help          help for create
      --with-access   return object store access

folders delete

Usage:
  ica folders delete [folder id or gdspath] [flags]

Flags:
      --force   force delete without prompts
  -h, --help    help for delete

folders get

Usage:
  ica folders get [folder id] [flags]

Flags:
  -h, --help                 help for get
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

folders jobs

The root command for actions that act on folder jobs in GDS

Usage:
  ica folders jobs [flags]
  ica folders jobs [command]

Available Commands:
  get         Get job info

Flags:
  -h, --help   help for jobs

folders jobs get

Get job info

Usage:
  ica folders jobs get [folder id] [job id] [flags]

Flags:
  -h, --help   help for get

folders list

Usage:
  ica folders list [gdspath to use as filter] [flags]

Flags:
      --acl strings          Comma delimited list of acls on which to filter the list
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --nonrecursive         Optional field to specify that resources should not be returned recursively in and under the specified paths. Only returns resources directly in the specified paths
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

folders sessions

The root command for actions that act on folder sessions in GDS

Usage:
  ica folders sessions [flags]
  ica folders sessions [command]

Available Commands:
  complete    Complete a session
  get         Get session info

Flags:
  -h, --help   help for sessions

folders sessions complete

Complete a session

Usage:
  ica folders sessions complete [folder id] [session id] [uploaded file count] [flags]

Flags:
  -h, --help   help for complete

folders sessions get

Get session info

Usage:
  ica folders sessions get [folder id] [session id] [flags]

Flags:
  -h, --help   help for get

folders unarchive

Unarchive folder from GDS

Usage:
  ica folders unarchive [folder id or gdspath] [flags]

Flags:
  -h, --help           help for unarchive
      --speed string   restore speed [standard, economy] (default "economy")

folders update

Get upload credentials for an existing folder

Usage:
  ica folders update [folder id or gds path] [flags]

Flags:
      --acl strings   Comma delimited list of acls on which to filter the list
  -h, --help          help for update
      --with-access   return object store access

folders upload

Upload a folder to GDS

Usage:
  ica folders upload [LOCAL-PATH] gds://{volume}/{path} [flags]

Flags:
  -h, --help              help for upload
      --num-workers int   number of workers to parallelize.  Default calculated based on CPUs available.

ga4gh

The root command for actions that act on GA4GH resources.

Usage:
  ica ga4gh [flags]
  ica ga4gh [command]

Available Commands:
  trs         GA4GH TRS API compliant commands
  wes         GA4GH WES API compliant commands

Flags:
  -h, --help   help for ga4gh

ga4gh trs

The root command for actions that act on GA4GH Tool Registry Service resources.

Usage:
  ica ga4gh trs [flags]
  ica ga4gh trs [command]

Available Commands:
  metadata     Return some metadata that is useful for describing this registry
  tool-classes Get detailed info about a tool
  tools        GA4GH tool repository actions

ga4gh trs metadata

Return some metadata that is useful for describing this registry

Usage:
  ica ga4gh trs metadata [flags]

Flags:
  -h, --help   help for metadata

ga4gh trs tool-classes

Get detailed info about a tool

Usage:
  ica ga4gh trs tool-classes [flags]

Flags:
  -h, --help   help for tool-classes

ga4gh trs tools

The root command for GA4GH-compliant actions that act on the tool registry.

Usage:
  ica ga4gh trs tools [flags]
  ica ga4gh trs tools [command]

Available Commands:
  get         Get detailed info about a tool
  list        List all tools
  versions    GA4GH tool version actions

ga4gh trs tools get

Get detailed info about a tool

Usage:
  ica ga4gh trs tools get [tool id] [flags]

Flags:
  -h, --help   help for get

ga4gh trs tools list

List all tools

Usage:
  ica ga4gh trs tools list [flags]

Flags:
      --author string         The author of the tool
      --description string    The description of the tool.
  -h, --help                  help for list
      --id string             A unique identifier of the tool, scoped to this registry
      --limit int32           Amount of records to return in a given page. By default it is 1000 (default 1000)
      --name string           The name of the image.
      --offset string         Start index of paging. Pagination results can be based on numbers or other values chosen by the registry implementor (for example, SHA values). If this exceeds the current result set return an empty set. If not specified in the request this will start at the beginning of the results.
      --organization string   The organization in the registry that published the image.
      --registry string       The image registry that contains the image
      --toolname string       unique identifier of the tool, scoped to this registry

ga4gh trs tools versions

The root command for GA4GH-compliant actions that act on the tool versions.

Usage:
  ica ga4gh trs tools versions [flags]
  ica ga4gh trs tools versions [command]

Available Commands:
  descriptor  Get the tool descriptor (CWL/WDL) for the specified tool. Get additional tool descriptor files (CWL/WDL) relative to the main file.
  dockerfile  Get the dockerfile for the specified image.
  get         List one specific tool version, acts as an anchor for self references
  list        List versions of a tool
  tests       Get an array of test JSONs suitable for use with this descriptor type.

Flags:
  -h, --help   help for versions

ga4gh trs tools versions descriptor

Get the tool descriptor (CWL/WDL) for the specified tool. Get additional tool descriptor files (CWL/WDL) relative to the main file.

Usage:
  ica ga4gh trs tools versions descriptor [tool id] [version id] [type] [optional relative-path] [flags]

Flags:
  -h, --help   help for descriptor

ga4gh trs tools versions dockerfile

Get the dockerfile for the specified image.

Usage:
  ica ga4gh trs tools versions dockerfile [tool id] [version id] [flags]

Flags:
  -h, --help   help for dockerfile

ga4gh trs tools versions get

List one specific tool version, acts as an anchor for self references

Usage:
  ica ga4gh trs tools versions get [tool id] [version id] [flags]

Flags:
  -h, --help   help for get

ga4gh trs tools versions list

List versions of a tool

Usage:
  ica ga4gh trs tools versions list [tool id] [flags]

Flags:
  -h, --help   help for list

ga4gh trs tools versions tests

Get an array of test JSONs suitable for use with this descriptor type.

Usage:
  ica ga4gh trs tools versions tests [tool id] [version id] [type] [flags]

Flags:
  -h, --help   help for tests

ga4gh wes

The root command for actions that act on GA4GH Workflow Execution Service resources.

Usage:
  ica ga4gh wes [flags]
  ica ga4gh wes [command]

Available Commands:
  runs         GA4GH workflow run actions
  service-info Get information about WES

Flags:
  -h, --help   help for wes

ga4gh wes runs

The root command for GA4GH-compliant actions that act on workflow runs.

Usage:
  ica ga4gh wes runs [flags]
  ica ga4gh wes runs [command]

Available Commands:
  cancel      Cancel a running workflow
  create      Run a workflow
  get         Get detailed info about a workflow run
  list        List the workflow runs
  status      Get quick status info about a workflow run

Flags:
  -h, --help   help for runs

ga4gh wes runs cancel

Cancel a running workflow

Usage:
  ica ga4gh wes runs cancel [flags]

Flags:
  -h, --help   help for cancel

ga4gh wes runs create

Run a workflow.

Usage:
  ica ga4gh wes runs create [flags]

Flags:
  -h, --help                                help for create
      --workflow-attachment stringArray     The workflow_attachment array may be used to upload files that are required to execute the workflow, including the primary workflow, tools imported by the workflow, other files referenced by the workflow, or files which are part of the input. Specify one flag for each file to include.
      --workflow-engine-parameters string   
      --workflow-params string              The workflow_params JSON object specifies input parameters, such as input files. The exact format of the JSON object depends on the conventions of the workflow language being used. Input files should either be absolute URLs, or relative URLs corresponding to files uploaded using workflow_attachment.
      --workflow-type string                The workflow_type is the type of workflow language and must be CWL or WDL currently (or another alternative supported by this WES instance).
      --workflow-type-version string        The workflow_type_version is the version of the workflow language submitted and must be one supported by this WES instance.
      --workflow-url string                 The workflow_url is either an absolute URL to a workflow file that is accessible by the WES endpoint, or a relative URL corresponding to one of the files attached using workflow_attachment

ga4gh wes runs get

Get detailed info about a workflow run

Usage:
  ica ga4gh wes runs get [flags]

Flags:
  -h, --help   help for get

ga4gh wes runs list

List the workflow runs

Usage:
  ica ga4gh wes runs list [flags]

Flags:
  -h, --help                help for list
      --page-size int       The preferred number of workflow runs to return in a page (default 10)
      --page-token string   Token to use to indicate where to start getting results. If unspecified, return the first page of results.

ga4gh wes runs status

Get quick status info about a workflow run

Usage:
  ica ga4gh wes runs status [flags]

Flags:
  -h, --help   help for status

ga4gh wes service-info

Get information about the GA4GH-compliant Workflow Execution Service

Usage:
  ica ga4gh wes service-info [flags]

Flags:
  -h, --help   help for service-info

help

Help provides help for any command in the application.
Simply type ica help [path to command] for full details.

Usage:
  ica help [command] [flags]

Flags:
  -h, --help   help for help

login

This command logs the end user into the cli and starts their session. User can use their credentials or pass a session token they have already obtained.

Usage:
  ica login [username] [flags]

Flags:
      --api-key string          api-key for authentication
      --auth-url string         single-sign on authentication server address (default "login.illumina.com")
  -d, --domain string           Optionally pass the domain name you are logging into
  -h, --help                    help for login
      --local-port int          local port for single-sign on authentication flow (default 8282)
      --project-id string       project ID to set current project context
      --project-name string     project name to set current project context
      --session-token string    session token for authentication
      --sso                     use single-sign on
      --workgroup-id string     workgroup ID to set current workgroup context
      --workgroup-name string   workgroup name to set current workgroup context

logout

This command logs the end user out of the cli by revoking the session. Additionally, it will prompt the user to revoke and remove the JWT token from the session config

Usage:
  ica logout [flags]

Flags:
  -h, --help   help for logout

projects

This is the root command for actions that act on projects

Usage:
  ica projects [flags]
  ica projects [command]

Available Commands:
  enter       Enter project context
  exit        Exit project context
  list        List projects

Flags:
  -h, --help                help for projects
      --page-token string   page token used for retrieving paged list results

projects enter

This command sets the user to the project context.

Usage:
  ica projects enter [project name] [flags]

Flags:
  -h, --help                   help for enter
      --session-token string   session token for authentication

projects exit

This command switches the user back to their personal context

Usage:
  ica projects exit [flags]

Flags:
  -h, --help                   help for exit
      --session-token string   session token for authentication

projects list

This command lists the projects for the current user

Usage:
  ica projects list [flags]

Flags:
  -h, --help   help for list

samples

The root command for actions that act on samples in GSS

Usage:
  ica samples [flags]
  ica samples [command]

Available Commands:
  analysisdatasets Get list of analysisdatasets for a sample
  get              Get sample info
  list             Get list of samples
  registerdata     Register data for a sample

Flags:
  -h, --help   help for samples

samples analysisdatasets

Get a list of analysis datasets for a samples to which you have access.

Usage:
  ica samples analysisdatasets [sample id] [flags]

Flags:
  -h, --help                help for analysisdatasets
      --include strings     include options
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "timeCreated Desc")
      --type strings        analysis dataset types requested

samples get

Get sample info

Usage:
  ica samples get [sample id] [flags]

Flags:
  -h, --help   help for get

samples list

Get a list of samples to which you have access.

Usage:
  ica samples list [flags]

Flags:
  -h, --help                  help for list
      --max-items int         maximum number of items to return, use 0 for no limit (default 50)
      --name string           filter by name
      --page-size int32       optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string     page token used for retrieving paged list results
      --project-name string   filter by projectName
      --sort-by string        specifies the order to list items (default "timeCreated Desc")

samples registerdata

Register data for a sample

Usage:
  ica samples registerdata [flags]

Flags:
      --analysis-datasets string            path to JSON list of one or more analysis datasets that should be associated with the analysis
      --external-analysis-run-id string     Optional external ID for the analysis run
      --external-project-id string          optional external ID for the project associated with the sample (only when a new sample is being created)
      --external-sample-id string           optional external ID to associate with the sample (only when a new sample is being created)
  -h, --help                                help for registerdata
      --project-name string                 projectName of the sample (when IDentifying sample by Name+ProjectName)
      --sample-id string                    optional Sample ID of the sample (if name based matching is not being used)
      --sample-name string                  optional name of the sample (when IDentifying sample by Name+ProjectName)
      --skip-copy-files-to-project-volume   optional. If true, skip copying files to the project volume if the ProjectName matches a known project context
      --total-dataset-count int32           total number of datasets that are being registered as part of the same ExternalAnalysisRunId
      --total-sample-count int32            total number of samples that are being registered as part of the same ExternalAnalysisRunId

subscriptions

The root command for actions that act on subscriptions in ENS.

Usage:
  ica subscriptions [flags]
  ica subscriptions [command]

Available Commands:
  create      Create a subscription
  delete      Delete subscription info
  get         Get subscription info
  list        Get list of subscriptions

Flags:
  -h, --help   help for subscriptions

subscriptions create

Create a subscription in ENS

Usage:
  ica subscriptions create [optional path to createSubscriptionRequest] [flags]

Flags:
      --actions strings             Actions which will be subscribed to for the event type
      --aws-sns-topic string        ARN for the AWS SNS topic
      --aws-sqs-queue string        URL for the AWS SQS queue
      --description string          Optional description for the subscription
      --filter-expression string    JSON-structured filter expression for events matching the subscription
  -h, --help                        help for create
      --name string                 Name of the subscription
      --type string                 Event type which will be subscribed to
      --workflow-id string          ID of the workflow to launch
      --workflow-run-input string   Input for the workflow run
      --workflow-run-name string    Name for the workflow run
      --workflow-version string     Version of the workflow to launch

subscriptions delete

Get subscription info

Usage:
  ica subscriptions get [subscription id] [flags]

Flags:
  -h, --help   help for get

subscriptions get

Get subscription info

Usage:
  ica subscriptions get [subscription id] [flags]

Flags:
  -h, --help   help for get

subscriptions list

Get a list of subscriptions to which you have access.

Usage:
  ica subscriptions list [flags]

Flags:
      --event-type string   filter by event type
  -h, --help                help for list
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "timeCreated Desc")

tasks

The root command for commands that act on tasks in TES

Usage:
  ica tasks [flags]
  ica tasks [command]

Available Commands:
  create      Create a task
  get         Get task info
  list        Get list of tasks
  runs        Task Run actions
  update      Update a task
  versions    Task Version actions

Flags:
  -h, --help   help for tasks

tasks create

Create a task in TES

Usage:
  ica tasks create [optional path to createTaskRequest] [flags]

Flags:
      --description string   description of the task
  -h, --help                 help for create
      --name string          name of the task

tasks get

Get task info

Usage:
  ica tasks get [task id] [flags]

Flags:
  -h, --help   help for get

tasks list

Get a list of tasks to which you have access.

Usage:
  ica tasks list [flags]

Flags:
  -h, --help                help for list
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "timeCreated Desc")

tasks runs

The root command for actions that act on task runs in TES

Usage:
  ica tasks runs [flags]
  ica tasks runs [command]

Available Commands:
  abort       Abort a task run
  create      Create and launch a single instance of a task run
  get         Get information for a specific task run
  list        Get list of task runs
  list        Get list of task runs
  logs        Download log files generated by a task run
  output      List output directories for a specific task run

Flags:
  -h, --help   help for runs

tasks runs abort

Abort a task run

Usage:
  ica tasks runs abort [task run id] [flags]

Flags:
  -h, --help   help for abort

tasks runs create

Create and launch a single instance of a task run

Usage:
  ica tasks runs create [path to json CreateTaskRunRequest or pipe json to command] [flags]

Flags:
      --description string   description of the task run
      --execution string     path to the execution details of the task run
  -h, --help                 help for create
      --name string          name of the task run

tasks runs get

Get information for a specific task run

Usage:
  ica tasks runs get [task run id] [flags]

Flags:
  -h, --help   help for get

tasks runs list

Get list of task runs

Usage:
  ica tasks runs list [flags]

Flags:
  -h, --help                help for list
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "timeCreated Desc")
      --status string       filter by status

tasks runs logs

Download log files generated by a task run to the destination folder

Usage:
  ica tasks runs logs [task run id] [dest path] [flags]

Flags:
  -h, --help   help for logs

tasks runs output

List output directories for a specific task run

Usage:
  ica tasks runs output [task run id] [flags]

Flags:
  -h, --help   help for output

tasks update

Update a task in TES

Usage:
  ica tasks update [task id] [optional path to updateTaskRequest] [flags]

Flags:
      --description string   description of the task
  -h, --help                 help for update
      --name string          name of the task

tasks versions

The root command for actions that act on task version in TES

Usage:
  ica tasks versions [flags]
  ica tasks versions [command]

Available Commands:
  create      Create a new version for a specified task
  get         Get information for a specific task and version
  launch      Launches a specific task version with the specified arguments
  list        Get list of versions for a given task
  update      Update a version for a specified task

Flags:
  -h, --help   help for versions

tasks versions create

Create a new version for a specified task

Usage:
  ica tasks versions create [task id] [optional path to createTaskVersionRequest] [flags]

Flags:
      --description string   description of the task version
      --execution string     path to execution details of the task version
  -h, --help                 help for create
      --version string       version name of the task version

tasks versions get

Get information for a specific task and version

Usage:
  ica tasks versions get [task id] [version id] [flags]

Flags:
  -h, --help   help for get

tasks versions launch

Launches a specific task version with the specified arguments

Usage:
  ica tasks versions launch [task id] [version id] {path-to-LaunchTaskRequest.json or pipe to command} [flags]

Flags:
      --arguments string     path to input arguments file for the task run
      --description string   description of the task run
  -h, --help                 help for launch
      --name string          name of the task run

tasks versions list

Get list of versions for a given task.

Usage:
  ica tasks versions list [task id] [flags]

Flags:
  -h, --help                help for list
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "timeCreated Desc")

tasks versions update

Update a version for a specified task

Usage:
  ica tasks versions update [task id] [version id] [optional path to updateTaskVersionRequest] [flags]

Flags:
      --description string   description of the task version
      --execution string     path to execution details of the task version
  -h, --help                 help for update
      --version string       version name of the task version

tokens

Tokens command provides functions for JWT token management.

Usage:
  ica tokens [flags]
  ica tokens [command]

Available Commands:
  create      Create a JWT token
  details     Get the details of a token

Flags:
  -h, --help   help for tokens

tokens create

This command generates a JWT token to call icaservices. User has ability to optionally pass in a session token or an API key as the first argument. If it isn't passed in, this will use the session token in the config.

Usage:
  ica tokens create [flags]

Flags:
      --acl strings             Comma delimited list of identities to include in the access control list (acl) of the token
      --api-key string          api-key for authentication
      --data string             Custom data field to set with token
  -h, --help                    help for create
      --mem strings             Comma delimited list of memberships to set on the token
      --save                    Save the generated token in the session config. This overrides the current token saved in the session config.
      --scopes strings          Comma delimited list of the scopes to request for jwt token
      --session-token string    session token for authentication
      --workgroup-id string     workgroup ID to set current workgroup context
      --workgroup-name string   workgroup name to set current workgroup context

tokens details

Gets the details of an access token including tenant, workgroup, and user information.

Usage:
  ica tokens details [flags]

Flags:
  -h, --help   help for details

version

The version of this application

Usage:
  ica version [flags]

Flags:
  -h, --help   help for version

volumes

The root command for actions that act on volumes in GDS

Usage:
  ica volumes [flags]
  ica volumes [command]

Available Commands:
  create      Create a new volume
  delete      Delete volume from GDS
  get         Get volume info
  list        Get a list of volumes

Flags:
  -h, --help   help for volumes

volumes create

Create a new volume.  Volume name must be unique

Usage:
  ica volumes create [volume name] [flags]

Flags:
  -h, --help          help for create
      --with-access   return object store access

volumes delete

Delete volume from GDS

Usage:
  ica volumes delete [volume id or gdspath] [flags]

Flags:
      --force   force delete without prompts
  -h, --help    help for delete

volumes get

Get volume info.  Volume can be referenced by name or by id.

Usage:
  ica volumes get [volume name or id] [flags]

Flags:
  -h, --help                 help for get
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

volumes list

Get a list of volumes

Usage:
  ica volumes list [flags]

Flags:
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

workflows

The root command for actions that act on workflows in WES

Usage:
  ica workflows [flags]
  ica workflows [command]

Available Commands:
  create      Create a workflow
  get         Get workflow info
  list        Get list of workflows
  runs        Workflow Run actions
  signals     Workflow Signal actions
  update      Update a workflow
  versions    Workflow Version actions

Flags:
  -h, --help   help for workflows

workflows create

Create a workflow in WES

using a json file:
  $ica workflows create /path/to/workflow-create.json

Usage:
  ica workflows create [optional path to createWorkflowRequest] [flags]

Flags:
      --category string       category of the workflow
      --description string    description of the workflow
  -h, --help                  help for create
      --name string           name of the workflow
      --organization string   organization of the workflow

workflows get

Get workflow info

Usage:
  ica workflows get [workflow id] [flags]

Flags:
  -h, --help   help for get

workflows list

Get a list of workflows to which you have access.

Usage:
  ica workflows list [flags]

Flags:
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

workflows runs

The root command for actions that act on workflow runs in WES.

Usage:
  ica workflows runs [flags]
  ica workflows runs [command]

Available Commands:
  abort       Abort a workflow run
  get         Get information for a specific workflow run
  history     Get history for a specified workflow run
  list        Get list of workflow runs

Flags:
  -h, --help   help for runs

workflows runs abort

Abort a workflow run

Usage:
  ica workflows runs abort [workflow run id] [flags]

Flags:
      --cause string   cause for aborted workflow run
      --error string   error for aborted workflow run (default "User aborted")
  -h, --help           help for abort

workflows runs get

Get information for a specific workflow run

Usage:
  ica workflows runs get [workflow run id] [flags]

Flags:
  -h, --help   help for get

workflows runs history

Get history for a specified workflow run

Usage:
  ica workflows runs history [workflow run id] [flags]

Flags:
  -h, --help                help for history
      --max-items int       maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32     optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string   page token used for retrieving paged list results
      --sort-by string      specifies the order to list items (default "eventId Asc")

workflows runs list

Get list of workflow runs

Usage:
  ica workflows runs list [flags]

Flags:
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --status strings       filter by status
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

workflows signals

The root command for actions that act on workflow signals in WES.

Usage:
  ica workflows signals [flags]
  ica workflows signals [command]

Available Commands:
  fail        Fail a workflow signal
  get         Get information for a specific workflow signal
  list        Get list of workflow signals
  succeed     Succeed a workflow signal

Flags:
  -h, --help   help for signals

workflows signals fail

Fail a workflow signal

Usage:
  ica workflows signals fail [workflow signal id] [error string] [cause string] [flags]

Flags:
      --cause string   cause for failed workflow signal
      --error string   error for failed workflow signal (default "User failed")
  -h, --help           help for fail

workflows signals get

Get information for a specific workflow signal

Usage:
  ica workflows signals get [workflow signal id] [flags]

Flags:
  -h, --help   help for get

workflows signals list

Get list of workflow signals

Usage:
  ica workflows signals list [flags]

Flags:
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

workflows signals succeed

Send a succeed signal to proceed a workflow

        using a json file:
        $ica workflows signals succeed $SIGNAL_ID /path/to/succeed-request.json

Usage:
  ica workflows signals succeed [workflow signal id] [flags]

Flags:
  -h, --help            help for succeed
      --result string   result for succeeded workflow signal

workflows update

Update a workflow in WES

Usage:
  ica workflows update [workflow id] [path to json file OR pipe json] [flags]

Flags:
      --category string       category of the workflow
      --description string    description of the workflow
  -h, --help                  help for update
      --name string           name of the workflow
      --organization string   organization of the workflow

workflows versions

The root command for actions that act on workflow versions in WES

Usage:
  ica workflows versions [flags]
  ica workflows versions [command]

Available Commands:
  create      Create a new version for a specified workflow
  get         Get information for a specific workflow and version
  launch      Launches a specific workflow version with the specified arguments
  list        Get list of workflow versions
  update      Update a version for a specified workflow

Flags:
  -h, --help   help for versions

workflows versions create

Create a new version for a specified workflow

using a json file:
  $ica workflows versions create {workflowId} /path/to/createWorkflowVersionRequest.json

Usage:
  ica workflows versions create [workflow id] [optional path to createWorkflowVersionRequest] [flags]

Flags:
      --definition string         definition of the workflow version
      --description string        description of the workflow version
  -h, --help                      help for create
      --language-name string      language name of the workflow version
      --language-version string   language version of the workflow version
      --version string            version name of the workflow version

workflows versions get

Get information for a specific workflow and version

Usage:
  ica workflows versions get [workflow id] [version name] [flags]

Flags:
  -h, --help   help for get

workflows versions launch

Launches a specific workflow version with the specified arguments

Usage:
  ica workflows versions launch [workflow id] [version name] [optional path to launchWorkflowVersionRequest] [flags]

Flags:
  -h, --help           help for launch
      --input string   path to input file for the workflow run
      --name string    name of the workflow run

workflows versions list

Get list of workflow versions

Usage:
  ica workflows versions list [optional workflow id] [flags]

Flags:
  -h, --help                 help for list
      --max-items int        maximum number of items to return, use 0 for no limit (default 50)
      --page-size int32      optimizes listing operations by limiting the number of items retrieved with each API call (default 1000)
      --page-token string    page token used for retrieving paged list results
      --sort-by string       specifies the order to list items (default "timeCreated Desc")
      --tenant-id string     tenant identifier of the resource(s)
      --tenant-name string   Optional field to reference shared resources in another tenant, mapping config in ~./ica/.tenants.yaml

workflows versions update

Update a version for a specified workflow

Usage:
  ica workflows versions update [workflow id] [version name] [path to updateWorkflowVersionRequest.json or piped into command] [flags]

Flags:
      --definition string         definition of the workflow version
      --description string        description of the workflow version
  -h, --help                      help for update
      --language-name string      language name of the workflow version
      --language-version string   language version of the workflow version
      --version string            version name of the workflow version

workgroups

This is the root command for actions that act on workgroups

Usage:
  ica workgroups [flags]
  ica workgroups [command]

Available Commands:
  enter       Enter workgroup context
  exit        Exit workgroup context
  list        List workgroups

Flags:
  -h, --help   help for workgroups

workgroups enter

This command sets the user to the workgroup context.

Usage:
  ica workgroups enter [workgroup name] [flags]

Flags:
  -h, --help                   help for enter
      --session-token string   session token for authentication

workgroups exit

This command switches the user back to their personal context

Usage:
  ica workgroups exit [flags]

Flags:
  -h, --help                   help for exit
      --session-token string   session token for authentication

workgroups list

This command lists the workgroups for the current user

Usage:
  ica workgroups list [flags]

Flags:
  -h, --help                   help for list
      --session-token string   session token for authentication