Module: VcoWorkflows

Defined in:
lib/vcoworkflows.rb,
lib/vcoworkflows/config.rb,
lib/vcoworkflows/runner.rb,
lib/vcoworkflows/version.rb,
lib/vcoworkflows/workflow.rb,
lib/vcoworkflows/cli/query.rb,
lib/vcoworkflows/constants.rb,
lib/vcoworkflows/vcosession.rb,
lib/vcoworkflows/cli/execute.rb,
lib/vcoworkflows/workflowtoken.rb,
lib/vcoworkflows/workflowservice.rb,
lib/vcoworkflows/workflowparameter.rb,
lib/vcoworkflows/workflowexecutionlog.rb,
lib/vcoworkflows/workflowpresentation.rb

Overview

VcoWorkflows

Defined Under Namespace

Modules: Cli Classes: CLI, Config, Runner, VcoSession, Workflow, WorkflowExecutionLog, WorkflowParameter, WorkflowPresentation, WorkflowService, WorkflowToken

Constant Summary collapse

VERSION =

Gem Version

'0.2.1'
DESC_VERSION =

Version

'Display the installed version of the VcoWorkflows gem'
DESC_CLI_EXECUTE =

Execute

'Execute the specified workflow'
DESC_CLI_QUERY =

Query

'Query vCO for a workflow'
DESC_CLI_WORKFLOW =

Workflow

'Name of the workflow'
DESC_CLI_WORKFLOW_ID =

ID

'GUID of the workflow'
DESC_CLI_DRY_RUN =

dry-run

'Dry run; do not actually perform operations against vCO'
DESC_CLI_VERBOSE =

verbose

'Show extra information'
DESC_CLI_NAME =

name

'Name of the workflow to execute'
DESC_CLI_SERVER =

server

'VMware vCenter Orchestrator server URL'
DESC_CLI_USERNAME =

username

'vCO user name'
DESC_CLI_PASSWORD =

password

'vCO password'
DESC_CLI_VERIFY_SSL =

verify certificates

'Perform TSL Certificate verification'
DESC_CLI_EXECUTE_WATCH =

watch execution

'Wait around for workflow results'
DESC_CLI_EXECUTE_PARAMETERS =

execution parameter list

'Comma-separated list of key=value parameters for workflow'
DESC_CLI_QUERY_EXECS =

query exeuction list

'Fetch a list of executions for the workflow'
DESC_CLI_QUERY_EXEC_LIM =

limit queried execution list size

'Limit the number of returned executions to the most recent N'
DESC_CLI_QUERY_EXEC_ID =

exeuction id

'Fetch the execution data for this execution GUID'
DESC_CLI_QUERY_EXEC_STATE =

execution state

'Fetch the state of the specified workflow execution'
DESC_CLI_QUERY_EXEC_LOG =

execution log

'In addition to execution data, show the execution log'
DESC_CLI_QUERY_JSON =

show JSON

'Show the JSON document for the requested information'
API_URL_BASE =

What do all the vCO REST URIs start with?

'/vco/api'
ERR =

error messages

{
  wtf: 'vcoworkflows: I have no idea what just went wrong.',
  no_workflow_found: 'vcoworkflows: no workflow found!',
  too_many_workflows: 'vcoworkflows: more than one workflow found for given name!',
  wrong_workflow_wtf: 'vcoworkflows: search returned the wrong workflow! (?)',
  no_workflow_service_defined: 'vcoworkflows: Attempted to execute a workflow with a nil workflow service!',
  param_verify_failed: 'vcoworkflows: Attempt to verify required parameter failed!',
  no_such_parameter: 'Attempted to set a parameter that does not exist!',
  url_unset: 'No URL was configured, nothing to connect to!',
  username_unset: 'No username was specified, either by $VCO_USER or --username',
  password_unset: 'No password was specified, either by $VCO_PASSWD or --password'
}