Client Tools Command Reference
Overview
Commands
ctm-cancel-pipelineinstance
Cancels a processing Pipeline Instance.
Sets all Processing or Pending statuses to 'Canceled'.
Returns success or failure.
REQUIRED PARAMETERS
-i,--pi Name or ID of a Pipeline Instance.
Associated API: cancel_pipelineinstance
Cancel a running Pipeline Instance.
All Pending or Processing statuses will be set to Canceled.
Required Arguments:
pi- The Name or ID of a Pipeline Instance.
Returns: 'true' on success, errors on failure.
ctm-configure-plugins
Configures the details of multiple plugins from a JSON document.
WARNING: this command will OVERWRITE any existing plugin configuration!
USE WITH CAUTION.
REQUIRED PARAMETERS
-b,--backupfile A JSON document formatted as a list of
Plugin Configurations.
Associated API: configure_plugins
Configures a Flow Plugin.
WARNING: at this time, any plugins in the input JSON will be OVERWRITTEN!
USE WITH CAUTION.
Required Arguments:
plugins- A list of JSON objects, each formatted as a valid Plugin config.
Returns: success or error.
ctm-copy-application-template
Copies an Application Template to a new name or version.
REQUIRED PARAMETERS
-t,--template The Application Template to copy.
-v,--version A version for the new Template.
-n,--newname A name for the new Template.
-r,--newversion A version for the new Template.
Examples
To copy an application template to a new version, same name
ctm-copy-application-template -t "MyApp" -v "1" -n "MyApp" -r "2"
Associated API: copy_application_template
Copies an Application Template.
Required Arguments:
template- the name of an Application Template.version- the Template version.newname- a name for the new Template.newversion- a version for the new Template
Returns: An Application Template Object.
ctm-copy-project
Copy a Project object.
REQUIRED PARAMETERS
-p,--project Value can be either a Project ID or Name.
-n,--newname A name for the new Project.
Examples
ctm-copy-project -p "ProjectName"
Associated API: copy_project
Copy a Project.
Required Arguments:
project- the id or name of a Project.newname- a name for the new Project.
Returns: 'true' on success, errors on failure.
ctm-create-asset
Creates a new fixed address Asset.
REQUIRED PARAMETERS
-n,--name A name for the new Asset.
OPTIONAL PARAMETERS
-s,--status Status, either "Active" or "Inactive".
("Active" if omitted.)
-a,--address Network address of the Asset.
-t,--port Service port of the Asset.
-d,--db_name A database name.
-u,--user A User ID.
-p,--password A Password.
-c,--shared_credential A Shared Credential.
--conn_string A full connection string. (Not typical.)
Examples
ctm-create-asset -n "Test 123" -s "Active" -a "10.10.2.2" -d "test02" -t "1433" -u "appuser" -p "passw0rd"
Associated API: create_asset
Creates an Asset.
Required Arguments:
- name - a name for the new Asset.
Optional Arguments:
status- either 'Active' or 'Inactive'. ('Active' if omitted.)db_name- a Database name.address- the network address of the Asset.port- a service port for the Address.conn_string- some Assets make their connections via an explicit connection string.user- a User ID to associate with this Asset.password- a Password to associate with this Asset.shared_credential- the name of a Shared Credential to use.
Regarding Credentials:
Credentials are optional on an Asset, however if provided there are rules. Explicit details can be associated with only this Asset, or a Shared Credential can be specified.
The minimum required to create a LOCAL set of credentials on this Asset are:
user- a User ID for the Credentialpassword- a Password for the Credential
To specify a Shared Credential, provide the shared_credential argument, which is the name of an existing Credential.
Returns: An Asset Object.
ctm-create-credential
Creates a new set of Shared Credentials that can be used to log into other systems.
REQUIRED PARAMETERS
-n,--name A name for the new Credential, must be
unique.
-d,--description Credential description or long name.
-u,--username The user/login name.
-p,--password The password/privatekey.
OPTIONAL PARAMETERS
-o,--domain An optional domain name for the
credential.
-v,--privileged Additional password required to put
certain Cisco IOS devices into
"privileged" mode.
Examples
ctm-create-credential -n "adminuser" -d "Administrator User" -u "root" -p "passw0rd"
Associated API: create_credential
Creates a new Shared Credential.
Only a 'Developer' can create Credentials.
Required Arguments:
name- The full name of the user.username- A login name for the user.password- Password for the user. If password is not provided, a random password will be generated.
Optional Arguments:
description- Description of the Credential.domain- A domain for the Credential.
Returns: A Credential Object.
ctm-create-phase
Create a new Phase in the Phases library.
Returns a Phase Object.
REQUIRED PARAMETERS
-t,--templatefile A JSON document formatted as a CSK Phase
definition.
Associated API: create_phase
None
ctm-create-pipeline
Creates a Pipeline definition from a JSON document.
Returns a Pipeline Object.
REQUIRED PARAMETERS
-t,--templatefile A JSON document formatted as a CSK
Pipeline definition.
Associated API: create_pipeline
Create a Pipeline Definition.
Required Arguments:
template- A JSON document formatted as a CSK Pipeline Definition.
Returns: A Pipeline Definition Object.
ctm-create-project
Creates a Project.
Returns a Project Object.
REQUIRED PARAMETERS
-n,--name A name for the Project.
OPTIONAL PARAMETERS
-d,--description A description for the Project.
Associated API: create_project
Create a Project.
Required Arguments:
name- Name of the Project.
Returns: A Project Object.
ctm-create-stage
Create a new Stage in the Stages library.
Returns a Stage Object.
REQUIRED PARAMETERS
-t,--templatefile A JSON document formatted as a CSK Stage
definition.
Associated API: create_stage
None
ctm-create-tag
Creates a new Tag to be used to associate objects with one another.
REQUIRED PARAMETERS
-n,--name The name of the new Tag. (AlphaNumeric
ONLY. Cannot contain spaces, punctuation
or special characters.)
OPTIONAL PARAMETERS
-d,--description Tag description.
Examples
ctm-create-tag -n "staging01" -d "staging environment 1"
Associated API: create_tag
Creates a new security Tag.
Required Arguments:
name- The name of the new Tag. (AlphaNumeric ONLY. Cannot contain spaces, punctuation or special characters.)
Optional Arguments:
description- Describe the Tag.
Returns: The new Tag Object if successful, error message on failure.
ctm-create-task
Creates a new blank Task object.
REQUIRED PARAMETERS
-n,--name A name for the new Task.
OPTIONAL PARAMETERS
-d,--desc A description of the new Task.
-c,--code A code for the new Task.
Examples
ctm-create-task -n "mytask" -d "This is a sample task" -c "test2001"
Associated API: create_task
Create a new Task.
Required Arguments:
name- a name for the new Task.
Optional Arguments:
code- a Task code.desc- a Task description.
Returns: A Task Object.
ctm-create-user
Creates a new User.
REQUIRED PARAMETERS
-u,--user A login name for the user.
-n,--name The full name of the user.
-r,--role The users role. (Valid values:
Administrator, Developer, User)
Valid Values: Administrator|Developer|User
OPTIONAL PARAMETERS
-p,--password Password for the user. If "password" is
not provided, a random password will be
generated.
-e,--email Email address for the user. Required if
"password" is omitted.
-a,--authtype "local" or "ldap". Default is "local" if
omitted.
Valid Values: local|ldap
-f,--forcechange Require user to change password. Default
is "true" (1) if omitted. (Valid values: 0
or 1).
Valid Values: 0|1
-s,--status Status of the new account. Default is
"enabled" if omitted. (Valid values:
enabled, disabled, locked)
Valid Values: enabled|disabled|locked
-x,--expires Expiration date for this account. Must be
in mm/dd/yyyy format.
-g,--groups A list of groups the user belongs to.
Group names cannot contain spaces. Comma
delimited list.
-c,--contributors A list of contributors the user is mapped
to. Contributors cannot contain spaces.
Comma delimited list.
--get_token Include a login token in the response.
(Used for passthru login.)
Examples
ctm-create-user -u "dave.thomas" -n "Dave Thomas" -r "User" -e "dave.thomas@example.com" -p "passw0rd" -a "local" -s "enabled"
Associated API: create_user
Creates a new user account.
Only an 'Administrator' can create other users. If the credentials used for this API call are not an Administrator, the call will not succeed.
Required Arguments:
user- A login name for the user.name- The full name of the user.-
role- The users role. Valid values:- Administrator
- Developer
- User
Optional Arguments:
password- Password for the user. If password is not provided, a random password will be generated.email- Email address for the user. Required if 'password' is omitted.authtype- 'local' or 'ldap'. Default is 'local' if omitted.forcechange- Require user to change password. Default is 'true' if omitted. (Valid values: 'true' or 'false')status- Status of the new account. Default is 'enabled' if omitted. (Valid values: enabled, disabled, locked)expires- Expiration date for this account. Default is 'never expires'. Must be in mm/dd/yyyy format.groups- A list of groups the user belongs to. Group names cannot contain spaces. Comma delimited list.get_token- If true, will return an automatic login token. (Valid values: 1, yes, true)contributors- A list of contributors the user is mapped to. Contributors cannot contain spaces. Comma delimited list.
Returns: A User Object.
ctm-delete-cloud-keypair
Removes a key pair (ssh private key) from a Cloud endpoint definition.
REQUIRED PARAMETERS
-c,--cloud The ID or Name of a Cloud.
-n,--name A name for the Key Pair.
Examples
ctm-delete-cloud-keypair -c "us-east-1" -n "privatekey001"
Associated API: delete_cloud_keypair
Removes a Key Pair from a Cloud.
Required Arguments:
cloud- Name or ID of the Cloud.name- Name of the Key Pair to delete.
Returns: A list of Cloud KeyPair Objects.
ctm-delete-credential
Deletes a Shared Credential.
REQUIRED PARAMETERS
-c,--credential ID or Name of the Credential.
Examples
ctm-delete-credential -c "adminuser"
Associated API: delete_credential
Removes a Shared Credential.
Required Arguments:
credential- Name or ID of the Credential to delete.
Returns: Success message if successful, error message on failure.
ctm-delete-pipeline
Delete a Pipeline Definition.
REQUIRED PARAMETERS
-p,--pipeline Value can be either a Definition ID or
Name.
Examples
ctm-delete-pipeline -p "PipelineName"
Associated API: delete_pipeline
Permanently delete a Pipeline Definition.
Required Arguments:
pipeline- the id or name of a Pipeline Definition.
Returns: 'true' on success, errors on failure.
ctm-delete-pipelinegroup
Permanently deletes a Pipeline Instance Group.
Requires the '_id' of the Pipeline Instance Group.
Returns success or failure.
REQUIRED PARAMETERS
-i,--pg ID of a Pipeline Instance Group.
Associated API: delete_pipelinegroup
Permanently delete a Pipeline Instance Group.
Required Arguments:
pg- The ID of a Pipeline Instance Group.
Returns: 'true' on success, errors on failure.
ctm-delete-pipelineinstance
Permanently deletes a Pipeline Instance.
Returns success or failure.
REQUIRED PARAMETERS
-i,--pi Name or ID of a Pipeline Instance.
Associated API: delete_pipelineinstance
Permanently delete a Pipeline Instance.
Required Arguments:
pi- The Name or ID of a Pipeline Instance.
Returns: 'true' on success, errors on failure.
ctm-delete-plan
Deletes a specific queued execution plan for a scheduled task.
REQUIRED PARAMETERS
-p,--plan_id The integer ID of the Plan to delete.
Examples
ctm-delete-plan -p 55
Associated API: delete_plan
Deletes a specific queued execution Plan.
Required Arguments:
plan_id- The integer ID of the Plan to delete.
Returns: Nothing if successful, error messages on failure.
ctm-delete-project
Delete a Project object.
REQUIRED PARAMETERS
-p,--project Value can be either a Project ID or Name.
Examples
ctm-delete-project -p "ProjectName"
Associated API: delete_project
Permanently delete a Project.
Required Arguments:
project- the id or name of a Project.
Returns: 'true' on success, errors on failure.
ctm-delete-task
Deletes a Task.
REQUIRED PARAMETERS
-t,--task The ID or Name of the Task to delete.
OPTIONAL PARAMETERS
-f,--force_delete Force the deletion of a Task, even if it
has history and references.
Examples
To delete a task that does not have any runtime history
ctm-delete-task -t "mytask01"
To force a delete of a task that has runtime history
ctm-delete-task -f "mytask01" -f
Associated API: delete_task
Deletes all versions of a Task.
Required Arguments:
task- Either the Task ID or Name.
Optional Arguments:
force_delete- Delete the Task, even if there are historical rows and references. (Valid values: 1, yes, true)
Returns: Nothing if successful, error messages on failure.
ctm-export-canvas
Exports Canvas items to a directory.
OPTIONAL PARAMETERS
-p,--project If provided, limits export to a specific
Project.
-c,--component If provided, limits a Project to a
specific Component. (project is required.)
-r,--repository Specify either "file" or "db" repository.
("db" if omitted.)
-o,--outputdirectory Directory where the output will be saved.
The directory must exist, and should be
empty.
--printoutput If provided, no file will be created. The
results of the API call will be printed.
Associated API: export_canvas
Generates an export JSON document all Canvas items.
This function is capable of exporting items from the "filesystem" repository, which is an administrative feature.
Optional Arguments:
project- filter by a Canvas Project name.component- filter by a Canvas Component. (Project is required.)repository- specify the repository ('file' or 'db', 'db' if omitted.)
Returns: A JSON document containing Canvas items.
ctm-export-catalog
Export all Project, Pipeline, Package, and Task definitions to a catalog as JSON documents.
OPTIONAL PARAMETERS
-o,--outputdirectory Directory where the output will be saved.
The directory must exist, and should be empty.
ctm-export-flow
Exports everything in the Flow Pipeline definition catalog.
Examples
_Export everything.
ctm-export-flow
Associated API: export_flow
Export the complete Flow definition catalog as a portable backup JSON document.
Returns: A JSON backup document.
ctm-export-phases
Exports all Phases in the catalog.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
_Export all Phases
ctm-export-phases
Associated API: export_phases
None
ctm-export-pipeline
Exports a Pipeline Definition backup file. Includes complete versions of all Phases and Stages.
REQUIRED PARAMETERS
-p,--pipeline Value can be either a Definition ID or
Name.
Examples
To export a Pipeline backup file.
ctm-export-pipeline -p "MyPipeline" > mypipeline.json
Associated API: export_pipeline
Export a Pipeline Definition as a portable backup JSON document.
Required Arguments:
pipeline- the id or name of a Pipeline Definition.
Returns: A Pipeline Definition Object.
ctm-export-project
Gets a Project Definition for export.
REQUIRED PARAMETERS
-p,--project Value can be either a Project ID or Name.
Examples
ctm-export-project -p "ProjectName" > myproject.json
Associated API: export_project
Gets a Project object for export. (Will not include the _id.)
Required Arguments:
project- the id or name of a Project.
Returns: A Project Object.
ctm-export-stages
Exports all Stages in the catalog.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
_Export all Stages
ctm-export-stages
Associated API: export_stages
None
ctm-export-task
Exports a Task that can be checked into version control or imported elsewhere.
REQUIRED PARAMETERS
-t,--task The ID or Name of the Task to export.
OPTIONAL PARAMETERS
-v,--version An optional specific Task Version.
(Default if omitted.)
-r,--include_refs If provided, will include all referenced
subtasks.
-f,--output_file Save the exported Task(s) to the specified
file.
Examples
To export the default version of a task in the default xml format
ctm-export-task -t "mytask01"
To export a specific version of a task in json format
ctm-export-task -t "mytask01" -v "2.000" -F "json"
To export the default version of a task and redirect to a file
ctm-export-task -t "mytask01" > mytask01.xml
To export the default version of a task, include all subtask references and put results in a file
ctm-export-task -t "mytask01" -r -f "~/mytask01.xml"
Associated API: export_task
Create a backup file for a single Task.
The behavior of this command is different depending on the Accept header.
- If 'application/json' (default), it will return a JSON list of individual Task documents.
- If 'application/xml' OR 'text/plain', it will return an XML document of Tasks.
Required Arguments:
task- Value can be either a Task ID, Code or Name.
Optional Arguments:
version` - A specific version. ('Default' if omitted.)include_refs` - If true, will analyze each task and include any referenced Tasks.
Returns: A collection of Task backup objects.
ctm-get-active-tasks
Gets a list of active Task Instances (Submitted, Staged, Pending, Processing).
OPTIONAL PARAMETERS
-f,--filter A filter.
-r,--records Maximum number of records to return.
Examples
Get all active task instances
ctm-get-active-tasks
Get all active task instances that have a status of Processing
ctm-get-active-tasks -f "Processing"
Get all active task instance with a particular string in the name
ctm-get-active-tasks -f "mytask01"
Limit the number of task instances returned
ctm-get-active-tasks -r 10
Associated API: get_task_instances
Gets a list of Task Instances.
Optional Arguments:
filter- A filter to limit the results.status- A comma separated list of statuses to filter the results.from- a date string to set as the "from" marker. (mm/dd/yyyy format)to- a date string to set as the "to" marker. (mm/dd/yyyy format)records- a maximum number of results to get.
Returns: A list of Task Instance Objects.
ctm-get-asset
Prints the properties of an Asset
REQUIRED PARAMETERS
-a,--asset The ID or Name of an Asset.
Examples
ctm-get-asset -a "database001"
Associated API: get_asset
Gets an Asset.
Required Arguments:
asset- an Asset Name or ID.
Returns: An Asset Object.
ctm-get-cloud
Prints the properties of a Cloud endpoint
REQUIRED PARAMETERS
-n,--name The ID or Name of a Cloud.
Examples
ctm-get-cloud -n "us-east-1"
Associated API: get_cloud
Gets a Cloud object.
Required Arguments:
name- a Cloud name or ID.
Returns: A Cloud Object.
ctm-get-document
Gets a datastore document based on a MongoDB query. For query syntax, see the MongDB find() syntax http://docs.mongodb.org/manual/refer...ollection.find
REQUIRED PARAMETERS
-q,--query A query in JSON format.
-c,--collection A document collection. "Default" if
omitted.
Examples
To get the json document from a collection based on a specific query
ctm-get-document -c "workflow_stages" -q '{"stage" : "stage 1"}'
Associated API: get_document
Gets a Datastore document.
Required Arguments:
query- A query in JSON format to select the correct Document.
Optional Arguments:
collection- a document collection. 'Default' if omitted.
Returns: A Datastore Document Object.
ctm-get-document-value
Gets the value for a given key in a Datastore document stored in the MongoDB datastore.
REQUIRED PARAMETERS
-q,--query A query in JSON format to select the
correct Document.
-k,--lookupkey A key to look up. Returns the entire
document if omitted.
OPTIONAL PARAMETERS
-c,--collection A document collection. "Default" if
omitted.
Examples
To get a value from a document based on a specific query
ctm-get-document-value -c "workflow_stages" -q '{"stage" : "stage 1"}' -k "status"
Associated API: get_document_value
Gets the value of a key in a Datastore document.
Datastore queries always return a list of document matches, even if the result set happens to only return data from one document.
Required Arguments:
query- A query in JSON format to select the correct Document.lookupkey- The section of the Document to retrieve. Returns the entire document if omitted.
Optional Arguments:
collection- a document collection. 'Default' if omitted.
Returns: A text value.
ctm-get-license
Prints the license information including expiration date
Examples
ctm-get-license
Associated API: get_license
Get the license details.
Required Arguments:
license- The text of a license key provided by Continuum.
Returns: The relevant properties of the current license.
ctm-get-next-id
Get the next ID in an ID set
REQUIRED PARAMETERS
-n,--name ID set name
OPTIONAL PARAMETERS
-r,--reseed Reseed the ID set starting with this
number
-f,--fallback Fallback to this number if there is an
exception
Associated API: get_next_id
ctm-get-piartifacts
Gets the Artifacts from the Manifest of a Pipeline Instance.
REQUIRED PARAMETERS
-i,--pi Value can be either a Pipeline Instance ID
or Name.
Examples
ctm-get-piartifacts -i "Pipeline Instance Name or ID"
Associated API: get_pi_artifacts
Gets the Changes from the Manifest of a Pipeline Instance.
Required Arguments:
pi- the id or name of a Pipeline Instance.
Returns: A JSON document representing all Changes on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
ctm-get-pichanges
Gets the Changes from the Manifest of a Pipeline Instance.
REQUIRED PARAMETERS
-i,--pi Value can be either a Pipeline Instance ID
or Name.
Examples
ctm-get-pichanges -i "Pipeline Instance Name or ID"
Associated API: get_pi_changes
Gets the Changes from the Manifest of a Pipeline Instance.
Required Arguments:
pi- the id or name of a Pipeline Instance.
Returns: A JSON document representing all Changes on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
ctm-get-pidata
Gets a Pipeline Instance Data object.
REQUIRED PARAMETERS
-i,--pi Value can be either a Pipeline Instance ID
or Name.
OPTIONAL PARAMETERS
-l,--lookup Lookup an expression that evaluates to a
subsection of the document.
Examples
ctm-get-pidata -i "Pipeline Instance Name or ID"
Associated API: get_pi_data
Gets a Pipeline Instance Data object.
Required Arguments:
pi- the id or name of a Pipeline Instance.
Optional Arguments:
lookup- Lookup using an expression that evaluates to a subsection of the document.
Returns: A Pipeline Instance.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
ctm-get-pipeline
Gets a Pipeline Definition.
REQUIRED PARAMETERS
-p,--pipeline Value can be either a Definition ID or
Name.
Examples
ctm-get-pipeline -p "PipelineName"
Associated API: get_pipeline
Gets a Pipeline Definition object.
Required Arguments:
pipeline- the id or name of a Pipeline Definition.
Returns: A Pipeline Definition Object.
ctm-get-pipelineinstance
Gets a Pipeline Instance object.
REQUIRED PARAMETERS
-i,--pi Value can be either a Pipeline Instance ID
or Name.
OPTIONAL PARAMETERS
-s,--include_stages If provided, include the Stages, Steps and
Plugins - the whole enchilada.
Examples
ctm-get-pipelineinstance -i "Pipeline Instance Name or ID"
Associated API: get_pipelineinstance
Gets a Pipeline Instance object.
Required Arguments:
pi- the id or name of a Pipeline Instance.
Optional Arguments:
include_stages- include Stage, Step and Plugin data and status.
Returns: A Pipeline Instance.
ctm-get-piworkitems
Gets the Workitems from the Manifest of a Pipeline Instance.
REQUIRED PARAMETERS
-i,--pi Value can be either a Pipeline Instance ID
or Name.
Examples
ctm-get-piworkitems -i "Pipeline Instance Name or ID"
Associated API: get_pi_workitems
Gets the Workitems from the Manifest of a Pipeline Instance.
Required Arguments:
pi- the id or name of a Pipeline Instance.
Returns: A JSON document representing all Workitems on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
ctm-get-project
Gets a Project Definition.
REQUIRED PARAMETERS
-p,--project Value can be either a Project ID or Name.
Examples
ctm-get-project -p "ProjectName"
Associated API: get_project
Gets a Project object.
Required Arguments:
project- the id or name of a Project.
Returns: A Project Object.
ctm-get-settings
Gets all the configuration settings from the database in json format
OPTIONAL PARAMETERS
-m,--module Filter to a specific module.
Examples
To get all config settings in text format
ctm-get-settings
To get all config settings in json format
ctm-get-settings -F "json"
To get the settings only for the messenger module
ctm-get-settings -m "Messenger"
To get a list of the module names available in the settings configurations
ctm-get-settings |grep -v "^ "|grep -v "^$"
Associated API: get_settings
Lists all the settings of modules.
Optional Arguments:
module- name of the module. If omitted, all module settings are returned.
Returns: A Settings Object.
ctm-get-submission
Gets the raw payload of a specific 'Submission' via a MongoDB query.
For query syntax, see the MongDB find() syntax: http://docs.mongodb.org/manual/refer...ollection.find
Returns the submission document, or a 'not found' message.
REQUIRED PARAMETERS
-q,--query A query in JSON format.
Examples
To find a Submission using the 'after' property:
ctm-get-submission -q '{"after" : "abc123"}'
Associated API: get_submission
Gets a raw 'Submission' payload using a query.
Required Arguments:
query- Valid MongoDB query to identify the previous payload to resubmit.
If the query would return multiple submissions, the newest one is matched.
Returns: the Submission document on success, 'not found' otherwise.
ctm-get-system-log
Get the System Log.
OPTIONAL PARAMETERS
-i,--object_id An Object ID filter.
-t,--object_type The integer representation of an internal
object type. Can be used with one of the
following when log_type = Object: (User =
1, Asset = 2, Task = 3, Schedule = 4, Tag
= 7, Image = 8, MessageTemplate = 18,
Parameter = 34, Credential = 35, Domain =
36, CloudAccount = 40, Cloud = 41,
CloudKeyPair = 45)
-u,--user A user name to filter result on.
-l,--log_type The type of log, either Object or Security
-a,--action The action that triggered a log entry. One
of the following: (UserLogin, UserLogout,
UserLoginAttempt, UserPasswordChange,
UserSessionDrop, ObjectAdd, ObjectModify,
ObjectDelete, bjectView, ObjectCopy,
ConfigChange)
-f,--filter A filter whereby the results would contain
this string
--from A "from" date in the format of m/d/yyyy.
--to A "to" date in the format of m/d/yyyy.
-r,--records Maximum number of records to return,
default is 100.
Examples
To get the last 100 denied login attempts
ctm-get-system-log -l "Security" -a "UserLoginAttempt"
To get any log entries attributed to the administrator user between two dates
ctm-get-system-log -u "administrator" -l "Object" --from "1/6/2014" --to "1/7/2014"
To get the last 300 task modifications
ctm-get-system-log -t 3 -r 300
Associated API: get_system_log
Gets the system log. If all arguments are omitted, will return the most recent 100 entries.
Optional Arguments:
object_id- An object_id filter to limit the results.object_type- An object_type filter to limit the results.log_type- A log_type filter. ('Security' or 'Object')action- An action filter.filter- A filter to limit the results.from- a date string to set as the "from" marker. (mm/dd/yyyy format)to- a date string to set as the "to" marker. (mm/dd/yyyy format)records- a maximum number of results to get.
Returns: A list of Log Entry Objects.
ctm-get-task
Prints the properties of a Task
REQUIRED PARAMETERS
-t,--task The ID or Name of a Task.
OPTIONAL PARAMETERS
-v,--version An optional specific Task Version.
(Default if omitted.)
-i,--include_code Include all task step code, if
output_format is "json" or "xml".
Examples
To print the high level properties of a specific Task version
ctm-get-task -t "mytask01" -v "2.000"
To print the properties and code of the default version of a Task
ctm-get-task -t "new example" -i
Associated API: get_task
Gets a Task object.
Required Arguments:
task- Value can be either a Task ID or Name.
Optional Arguments:
version- A specific version. ('Default' if omitted.)include_code- Whether to include Codeblocks and Steps. (Only included if 'output_format' is 'json' or 'xml'. 'False' if omitted.)
Returns: A Task Object.
ctm-get-task-instance
Get the properties of a Task Instance such as status, submitted and completed dates, etc.
REQUIRED PARAMETERS
-i,--instance The Task Instance number.
Examples
ctm-get-task-instance -i 43669
Associated API: get_task_instance
Gets the details of a Task Instance.
Required Arguments:
instance- The Task Instance identifier.
Returns: A Task Instance Object.
ctm-get-task-plans
Gets a list of queued schedule execution plans for a task.
REQUIRED PARAMETERS
-t,--task The ID or Name of a Task.
OPTIONAL PARAMETERS
-v,--version An optional specific Task Version.
(Default if omitted.)
Examples
Get all scheduled execution plans for a particular task
ctm-get-task-plans -t "mytask01"
Get all scheduled execution plans for a specific versions of a task
ctm-get-task-plans -t "mytask01" -v "2.000"
Associated API: get_task_plans
Gets a list of the queued execution plans for a Task.
Required Arguments:
task- Value can be either a Task ID or Name.
Optional Arguments:
version- A specific version. ('Default' if omitted.)
Returns: A list of Execution Plan Objects.
ctm-get-task-schedules
Gets a list of schedule definitions for a given task.
REQUIRED PARAMETERS
-t,--task The ID or Name of a Task.
OPTIONAL PARAMETERS
-v,--version An optional specific Task Version.
(Default if omitted.)
Examples
To list the schedules for a particular task
ctm-get-task-schedules -t "mytask01"
To list the schedules for a particular version of a task
ctm-get-task-schedules -t "new example" -v "2.000"
Associated API: get_task_schedules
Gets a list of Schedule definitions for a Task.
Required Arguments:
task- Value can be either a Task ID or Name.
Optional Arguments:
version- A specific version. ('Default' if omitted.)
Returns: A list of Task Schedule Objects.
- Text results do not include timing details.
- JSON results include Schedule definitions suitable for use in the 'schedule_task' function.
ctm-get-worklist
Gets a list of pending Pipeline Instances.
OPTIONAL PARAMETERS
-f,--filter Limit the result to a specific key:value
pair.
Examples
ctm-get-worklist -f "key:value"
Associated API: get_worklist
Gets a list of Pipeline in 'pending' status.
Optional Arguments:
filter- a key:value filter to limit the results.
Returns: A list of pending Pipeline Instances.
ctm-import-backup
Imports a task backup file into the system. This file can include one or more tasks within it and must be XML or JSON formatted
REQUIRED PARAMETERS
-f,--file The file name of the backup file.
OPTIONAL PARAMETERS
-c,--on_conflict Action to take if one or more Tasks have a
conflict. "replace", "minor", "major",
"cancel".
Examples
ctm-import-backup -f ~/mytask01.xml
Associated API: import_backup
Imports an XML or JSON backup file.
Required Arguments:
import_text- An XML or JSON document in the format of a Task backup file.
Returns: A list of items in the backup file, with the success/failure of each import.
ctm-import-canvas
Imports Canvas items from a properly formatted directory.
OPTIONAL PARAMETERS
-i,--inputdirectory Directory where the Canvas files exist.
Current directory if omitted.
-r,--repository "Specify either "file" or "db" repository.
"db" if omitted.
Only Administrators are allowed to use the
"file" option.
--ignoreconflicts If provided, the import process will
handle Name conflicts aggressively. If
Canvas items with the same
Project/Component/Name exist, they will be
overwritten.
ctm-import-catalog
Import all Project, Pipeline, Package, and Task definitions from a catalog as JSON documents.
OPTIONAL PARAMETERS
-i, --inputdirectory Directory where the input files are located.
The directory must exist.
-o, --overwrite Valid values: true|false (default)
If 'overwrite' is 'true' and the Definition exists, it will be replaced.
ctm-import-flow
Imports a backup of Flow definitions.
Returns success or error.
REQUIRED PARAMETERS
-b,--backupfile A JSON document formatted as a complete
Flow backup.
OPTIONAL PARAMETERS
-o,--overwrite Valid values: all|none (default).
Associated API: import_flow
Import a complete Flow backup.
Required Arguments:
backup- A JSON document formatted as a complete Flow backup.
Optional Arguments:
-
overwrite- Valid values: pipelines|phases|all|none (default).If 'overwrite' is 'all', all existing Pipeline Definitions, Phases and Stages will be replaced. If 'overwrite' is 'none' (default), any existing Pipeline Definitions, Phases and Stages will be left unchanged.
Returns: Success or error.
ctm-import-pipeline
Imports a Pipeline Definition from a JSON document.
Returns a Pipeline Object.
REQUIRED PARAMETERS
-b,--backupfile A JSON document formatted as a complete
Pipeline Definition backup.
OPTIONAL PARAMETERS
-o,--overwrite Valid values: pipeline|phases|all|none
(default).
Associated API: import_pipeline
Import a Pipeline Definition.
Required Arguments:
backup- A JSON document formatted as a complete Continuum Pipeline Definition backup.
Optional Arguments:
-
overwrite- Valid values: true|false (default).If 'overwrite' is 'true' and the Definition exists, it will be replaced.
Returns: A Pipeline Definition Object.
ctm-import-project
Imports a Project Definition from a JSON document.
Returns a Project Object.
REQUIRED PARAMETERS
-b,--backupfile A JSON document formatted as a complete
Project backup.
OPTIONAL PARAMETERS
-o,--overwrite Valid values: true|false (default).
Associated API: import_project
Import a Project.
Required Arguments:
backup- A JSON document formatted as a complete Project backup.
Optional Arguments:
-
overwrite- Valid values: pipeline|phases|all|none (default).If 'overwrite' is 'true' the Project will be replaced.
Returns: A Project Object.
ctm-initiate-pipeline
Initiate a Pipeline Definition with matching 'key' information.
Returns a Pipeline Instance Object.
REQUIRED PARAMETERS
-d,--definition Pipeline Definition to initiate.
-p,--project The Project name with which to associate
this instance.
-g,--group Descriptive label of a group to summarize
multiple instances of this
definition/project.
OPTIONAL PARAMETERS
-n,--name An explicit name for the unique instance.
(Autogenerated if omitted.)
-j,--details A JSON object with additional details
about this instance.
Associated API: initiate_pipeline
Attempt to initiate a Pipeline Definition.
Required Arguments:
definition- ID or Name of a Pipeline Definition to initiate.project- An identifying name for a Project. (ie: repo name) Useful if a single pipeline definition supports multiple projects.group- Summary name, (ie: branch name) used to group all runs of this definition/project combination. Describes your 'use' of this Pipeline.
Optional Arguments:
instance_name- An explicit name to use for this unique run. (ie: commit id)details- a JSON object with additional properties for the Pipeline Instance, often required by specific plugins.
Returns: A Pipeline Instance Object.
ctm-install-license
Installs or updates the Continuum license by importing a license file
REQUIRED PARAMETERS
-i,--inputfile Path to a license.dat file.
Examples
ctm-install-license -i "~/license.lic"
Associated API: install_license
Installs a license file.
Required Arguments:
license- The text of a license key provided by Continuum.
Returns: Success or Error message.
ctm-invoke-plugin
Execute a specified Flow Plugin Function
Response varies based on the specified Plugin.
REQUIRED PARAMETERS
-p,--plugin Plugin.Module containing the desired
function to invoke. (ex: github.main)
-m,--method Method to invoke. (ex "get_issue")
OPTIONAL PARAMETERS
-a,--args A JSON object containing Plugin Function
specific arguments.
Associated API: invoke_plugin
Invoke a Plugin Function.
Required Arguments:
plugin- the name of the Plugin PLUS the Module. (ex: github.main)method- the method to invoke. (ex "get_issue")
Optional Arguments:
args- a JSON formatted string of arguments which will be sent to the Plugin Function.
Returns: Response varies depending on the Plugin Function called.
ctm-list-application-template-tasks
Lists all Tasks associated with an Application Template and the corresponding sequence or action
REQUIRED PARAMETERS
-t,--template Name of the Application Template.
-v,--version The Application Template Version.
Examples
To list all tasks associated with an application template and version
ctm-list-application-template-tasks -t "Sample Application" -v 5
Associated API: list_template_tasks
Lists all Tasks associated with an Application Template.
Required Arguments:
template- the name of a defined Application Template.version- the Application Template version.
Returns: An list of Task Objects. associated with the Application Template.
ctm-list-canvas-items
Lists Canvas Items
OPTIONAL PARAMETERS
-p,--project Filter by a single Canvas Project.
-c,--component Further filter a Project by Component.
(project is required.)
-r,--repository Specify either "file" or "db" repository.
("db" if omitted)
Associated API: list_canvas_items
Returns a list of all elements in the Canvas feature.
Optional Arguments:
project- filter by a Canvas Project name.component- filter by a Canvas Component. (Project is required.)repository- specify the repository ('file' or 'db', 'db' if omitted.)
Returns: A list of all Canvas elements.
ctm-list-cloud-accounts
Lists Cloud Accounts.
OPTIONAL PARAMETERS
-f,--filter A string to use to filter the resulting
data. Any row of data that has one field
contains the string will be returned.
Examples
List all cloud accounts with AWS in the name or cloud type
ctm-list-cloud-accounts -f "AWS"
Associated API: list_cloud_accounts
Lists all Cloud Accounts.
Optional Arguments:
-
filter- will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)- Account Name
- Account Number
- Provider
- Login ID
- Default Cloud Name
Returns: A list of Cloud Account Objects.
ctm-list-clouds
Lists Cloud endpoints.
OPTIONAL PARAMETERS
-f,--filter A string to use to filter the resulting
data. Any row of data that has one field
contains the string will be returned.
Examples
List all cloud endpoints
ctm-list-clouds
List all vcloud cloud endpoints
ctm-list-clouds -f "vCloud"
Associated API: list_clouds
Lists all Clouds.
Optional Arguments:
-
filter- will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)- Cloud Name
- Provider
- Default Account Name
- API URL
Returns: A list of Cloud Objects.
Lists all installed 'flow' commands. Accepts no arguments.
ctm-list-document-collections
List all collections in the MongoDB datastore.
OPTIONAL PARAMETERS
-f,--filter A string to use to filter the resulting
data. Any row of data that has one field
contains the string will be returned.
Examples
List all datastore collections
ctm-list-document-collections
List all datastore collections, with workflow in the name
ctm-list-document-collections -f "workflow"
Associated API: list_document_collections
Lists all Datastore Document Collections.
Optional Arguments:
filter- will filter results on the Collection name. (A string to match in the Collection name.)
Returns: A list of Document Collections.
ctm-list-methods
Retrieves a list of all REST API methods and their documentation.
OPTIONAL PARAMETERS
-l,--listonly List the methods without documentation.
Examples
To print a full listing of all api commands with documentation
ctm-list-methods
To print only the names with the api commands sorted
ctm-list-methods -l
ctm-list-phases
Lists all Phases in the catalog.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
_List all Phases
ctm-list-phases
Associated API: list_phases
None
ctm-list-pipelinegroups
Lists all Pipeline Instance Groups.
OPTIONAL PARAMETERS
-p,--pipeline Limit the results to a specific Pipeline.
-r,--project Limit the results to a specific project.
-g,--group Limit the results to a specific group.
Examples
_List all Pipeline Instance Groups
ctm-list-pipelinegroups
Associated API: list_pipelinegroups
Lists all Pipeline Instance Groups (Stories).
Optional Arguments:
pipeline- will limit the results a specific Pipeline Definition.project- will limit the results a specific 'project'.group- will limit the results to a specific 'group'.
Returns: A list of Pipeline Instance Group Objects.
ctm-list-pipelineinstances
Lists all Pipeline Instances.
OPTIONAL PARAMETERS
-d,--definition Limit the results to a specific Pipeline
Definition.
-r,--project Limit the results to a specific project.
-g,--group Limit the results to a specific group.
Examples
_List all Pipeline Instances
ctm-list-pipelineinstances
Associated API: list_pipelineinstances
Lists all Pipeline Instances.
Optional Arguments:
definition- will limit the results a specific Pipeline Definition.project- will limit the results to a specific 'project'.group- will limit the results to a specific 'group'.
Returns: A list of Pipeline Instance Objects.
ctm-list-pipelines
Lists all Pipeline Definitions.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
List all Pipelines
ctm-list-pipelines
Associated API: list_pipelines
Lists all Pipeline Definitions.
Optional Arguments:
filter- will filter a value match on any of the following fields: (Multiple filter arguments can be provided, delimited by spaces.)- Definition Name
- Status
Returns: A list of Pipeline Definition Objects.
ctm-list-processes
Lists server processes (poller, messenger, etc.) along with heartbeat information.
Examples
ctm-list-processes
Associated API: list_processes
Lists all running processes.
Returns: A list of Process Objects.
ctm-list-projects
Lists all Projects.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
_List all Projects
ctm-list-projects
Associated API: list_projects
Lists all Projects.
Optional Arguments:
Returns: A list of Project Objects.
ctm-list-stages
Lists all Stages in the catalog.
OPTIONAL PARAMETERS
-f,--filter A filter.
Examples
_List all Stages
ctm-list-stages
Associated API: list_stages
None
ctm-list-tasks
Lists Tasks
OPTIONAL PARAMETERS
-f,--filter A string to use to filter the resulting
data. Any row of data that has one field
contains the string will be returned.
-v,--show_all_versions Show all Versions, not just the "default".
Examples
List all tasks
ctm-list-tasks
List all tasks with a particular string in the name, all versions
ctm-list-tasks -f "Test Logging Level" -v
Associated API: list_tasks
Lists all Tasks.
Only 'Default' versions are shown.
Optional Arguments:
filter- will filter a value match in Task Name, Code or Description. (Multiple filter arguments can be provided, delimited by spaces.)show_all_versions- if provided, will display all versions. ('False' if omitted.)
Returns: A list of Task Objects.
The Task Objects returned to this function are streamlined - they do not contain all the properties available in the get_task endpoint.
ctm-patch
If enabled, allows remote patching of a source or configuration file.
REQUIRED PARAMETERS
-p,--path Path of file to patch.
-n,--newfile Replacement file.
-a,--authcode Authorization code.
Associated API: patch
If enabled, allows remote patching of a source or configuration file.
Required Arguments:
path- the path (in $CONTINUUM_HOME) of the file to be patchedcontent- the content which will replace the target fileauthcode- the secure authorization code
Returns: Success message if successful, error message on failure.
ctm-powershell
Test WinRM connections and issue commands.
OPTIONAL PARAMETERS
-s,--server Windows server address.
-u,--user Windows User with WinRM permissions.
-p,--password Windows User Password.
-a,--asset The ID or Name of an Asset to use instead
of --server, --user and --password.
-k,--kerberos Use Kerberos (Domain) authentication.
-c,--command A command to execute via WinRM.
Examples
ctm-powershell -uusername -ppassword -sserver -c"write-host 'Hello World'"
Associated API: winrm_command
Test connectivity or issue Windows Remote Management commands on a defined Asset.
Required Arguments:
- asset - Asset ID or Name of an Asset to use for the connection.
OR
- server - WinRM Server FQDN or IP address.
- user - User account.
- password - User password.
Optional Arguments:
- kerberos - Use Kerberos authentication if 'True', basic authentication if omitted.
- command - The command to execute. (Will connection test only if omitted.)
- powershell - (boolean) If True, will execute the command as a PowerShell command.
Returns: The result of the command, or errors.
ctm-register-plugin
Registers a new Flow Plugin.
REQUIRED PARAMETERS
-n,--name Name of the new plugin to register.
Examples
ctm-register-plugin -n "PluginName"
Associated API: register_plugin
Register a new Flow Plugin.
Required Arguments:
name- Name of the new plugin.
Returns: success or error.
ctm-reset-password
Resets a User's login password.
OPTIONAL PARAMETERS
-p,--password The new password.
-u,--user The ID or Name of a User Account.
-g,--generate Generate a new, random password.
Examples
Reset a User's password to a random password which will be emailed to the user
ctm-reset-password -u "username1" bob -g
Reset a User's password to a specified password
ctm-reset-password -u "username1" -p "passw0rd"
Associated API: reset_password
Resets the password of the authenticated, or a specified User.
If a user is specified, and the authenticated user is an Administrator, this will reset the password of the specified user to the provided value.
If no user is specified, the password of the authenticated user will be changed.
NOTE: to prevent accidental change of an Administrators password, an extra trap is in place: * the username (or id) MUST be provided, even if the authenticated user is the user being changed.
Required Arguments:
password- the new password.- - OR -
generate- generate a random password.
Optional Arguments:
user- Either the User ID or Name.
Returns: Success message if successful, error messages on failure.
Restart one or more Continuum services, specified as space delimited arguments.
Associated API: Restart one or more Continuum services, specified as space delimited arguments.
None Restart ALL Continuum services. Accepts no arguments.
ctm-resubmit-change
Resubmits a previous change 'Submission' to the specified Project.
Identify the submission data using a valid MongoDB query.
For query syntax, see the MongDB find() syntax: http://docs.mongodb.org/manual/refer...ollection.find
Returns a success or failure.
REQUIRED PARAMETERS
-q,--query A query in JSON format.
Examples
To find a GitHub Webhook using the 'after' property:
ctm-resubmit-change -q '{"after" : "abc123"}'
Associated API: resubmit_change
Resubmits a change 'Submission' payload to the specified Project.
Required Arguments:
query- Valid MongoDB query to identify the previous payload to resubmit.
If the query would return multiple submissions, the newest one is matched.
Returns: 'true' on success, errors on failure.
ctm-retry-pipelineinstance
Retries a failed or canceled Pipeline Instance.
Returns a Pipeline Instance object.
REQUIRED PARAMETERS
-i,--pi Name or ID of a Pipeline Instance.
Associated API: retry_pipelineinstance
Attempt to retry a failed Pipeline Instance. Simply restarts it again at Phase One.
CAUTION: The Workspace data is not cleared or reset. Depending on the design of the Pipeline, this may not succeed, or might produce unexpected results.
Required Arguments:
pi- The Name or ID of a Pipeline Instance.
Returns: A Pipeline Instance Object.
ctm-rollback
Rollback Continuum to a previously installed release.
OPTIONAL PARAMETERS
-v,--version An explicit official release version to
install.
Examples
ctm-rollback -v 16.0.400
Associated API: rollback
None
ctm-run-task
Submits a Task for execution
REQUIRED PARAMETERS
-t,--task The ID or Name of the Task to run.
OPTIONAL PARAMETERS
-v,--version An optional specific Task Version.
(Default if omitted.)
-l,--log_level An optional Logging level. One of 10,20
(default),30,40,50 with 10 most verbose,
50 no logging
-a,--account The ID or Name of Cloud Account
credentials for the Task.
-o,--options A JSON object containing additional
options for the Task.
-r,--run_later The Task will be scheduled to run at the
specified date/time. ex. "7/4/1776
15:30".
-p,--parameters JSON or XML formatted parameters, or a
path to a file containing JSON or XML
parameters.
-d,--data JSON object initial runtime data, or a
path to a file containing a JSON object.
Examples
To submit a particular task
ctm-run-task -t "mytask01"
To submit a particular version of a task
ctm-run-task -t "mytask01" -v "2.000"
To submit a task the most verbose logging level
ctm-run-task -t "mytask01" -l 10
To submit a task logging on critical errors only
ctm-run-task -t "mytask01" -l 50
To submit a task with a certain Cloud Account
ctm-run-task -t "mytask01" -a "vcloudaccount01"
To submit a task to run one time in the future
ctm-run-task -t "mytask01" -r "1/16/2014 9:40"
Initial runtime data as a JSON string. (Notice double quotes inside, single quote outside.)
ctm-run-task -t "mytask01" -d '{"ship":"Serenity","captain":"Malcolm Reynolds"}'
Initial runtime data in a JSON file
ctm-run-task -t "mytask01" -d "~/mytask01_params.json"
Associated API: run_task
Runs a Task.
Required Arguments:
task- Either the Task ID or Name.version- The Task Version. (Unnecessary if 'task' is an ID.)
Optional Arguments:
data- A JSON document defining the intial Runtime Variable environment for this Task.log_level- an integer (0-4) where 0 is none, 2 is normal and 4 is verbose. Default is 2.account- the ID or Name of a Cloud Account. Certain Task commands require a Cloud Account.parameters- A JSON or XML document defining parameters for the Task.options- a JSON object defining certain options for this Task. Typically used to provide scope for extensions to the Task Engine.run_later- if provided, the Task will be scheduled to run at the specified date/time. ex. "7/4/1776 15:30"
Returns: A Task Instance Object.
- If 'output_format' is set to 'text', returns only a Task Instance ID.
- If 'run_later' was specified, will return a success or error message.
ctm-schedule-tasks
Schedules one or more Tasks using a json template file.
REQUIRED PARAMETERS
-s,--schedulefile The path to a json formatted schedule
definition file. See the schedule_tasks
API documentation for the format of the
file.
Examples
ctm-schedule-tasks -s ./schedule_template.json
Associated API: schedule_tasks
Schedules one or more Tasks.
Required Arguments:
tasks- a JSON document containing a list of Tasks and schedule details.
Schedule definition format:
All lists are zero based integers. The Task Schedule Object response from the get_task_schedules command in JSON format can provide schedule definition examples for this command.
[
{
"Task" : *task name*,
"Version" : *optional*,
"Months": "*" or [list of months],
"DaysOrWeekdays": "Days" = days of the month, "Weekdays" = days of the week (default),
"Days": "*" or [list of days],
"Hours": "*" or [list of hours],
"Minutes": "*" or [list of minutes]
},
{
...
}
]
Returns: Nothing if successful, error messages on failure.
ctm-send-message
Sends a message to an email address using the messenger.
REQUIRED PARAMETERS
-t,--to Comma-separated Users or addresses.
-s,--subject Subject of the message.
-m,--message Content of the message.
OPTIONAL PARAMETERS
-c,--cc Comma-separated Users or addresses to CC.
-b,--bcc Comma-separated Users or addresses to BCC.
Examples
To send an email to an email address
ctm-send-message -t "bob.thomas@example.com" -s "hello world" -m "this is a test message"
To send an email to a list of email addresses with a blind copy
ctm-send-message -t "bob.thomas@example.com,tom.thumb@example.com" -b "hellen.hunt@example.com -s "hello world" -m "this is a test message"
Associated API: send_message
Sends a message to a registered user. Message will be 'From' the authenticated API user.
The 'to' argument accepts both email addresses AND Continuum Users. Each item in the 'to' list will try to look up a Continuum User, and if it doesn't match, will assume the entry is an email address.
Required Arguments:
to- a single or comma-separated list of valid email addresses or Continuum Users.subject- a subject linemessage- the message body
Optional Arguments:
cc- a carbon copy list of comma-separated email addresses or Continuum Users.bcc- a blind carbon copy list of comma-separated email addresses or Continuum Users.
Returns: Success message if successful, error message on failure.
ctm-set-document-values
Sets the value for set of provided keys in a document in the MongoDB datastore.
REQUIRED PARAMETERS
-q,--query A query in JSON format to select the
correct Document.
-u,--updatedoc A key to look up in the document.
OPTIONAL PARAMETERS
-c,--collection A document collection. "Default" if
omitted.
Examples
ctm-set-document-values -c "workflow_stages" -q '{"stage" : "stage 1"}' -u '{"status" : "running", "foo.bar" : "baz"}'
Associated API: set_document_values
Sets multiple values in a Datastore document.
Required Arguments:
query- A query in JSON format to select the correct Document.updatedoc- A document representing path:value pairs to be updated.
Optional Arguments:
collection- a document collection. 'Default' if omitted.
Multiple keys are updated in a looping manner. Unsuccessful updates will return an error, but will not stop subsequent updates from occuring.
Returns: A success message, or error messages on failure.
ctm-set-pi-description
Sets pipeline instance description
REQUIRED PARAMETERS
-i,--pi Pipeline instance ID or name
-d,--description Key name to set
Associated API: set_pi_description
Set pipeline instance description
Required Arguments:
pi- the id or name of a pipeline instancedescription- Description of the instance (HTML allowed)
Returns: 'true' on success, errors on failure.
ctm-set-pi-global-summary
Sets pipeline instance global summary data
REQUIRED PARAMETERS
-i,--pi Pipeline instance ID or name
-k,--key Key name to set
-v,--value Value to set
Associated API: set_pi_global_summary
Set global summary data on a pipeline instance
Required Arguments:
pi- the id or name of a pipeline instancekey- key to set in the global summaryvalue- value for the provided key
Returns: 'true' on success, errors on failure.
Example using curl:
curl http://continuum-server.example.com:8080/api/set_pi_data?token=5752fb9abb288013973fabf4&key=hello&value=world&pi=57acb49a320c7a41bf32958a
ctm-set-pipelinegroup-number
Set the autonumber root on Pipeline Instance Group. (Used to issue ascending numbers to Instances in the Group.)
Requires the '_id' of the Pipeline Instance Group and the new number value to set.
Returns success or failure.
REQUIRED PARAMETERS
-i,--pg ID of a Pipeline Instance Group.
-n,--newnumber New Number to set.
Associated API: set_pipelinegroup_number
Set the autonumber root on Pipeline Instance Group. (Used to issue ascending numbers to Instances in the Group.)
Required Arguments:
pg- The ID of a Pipeline Instance Group.newnumber- The new number to set as the autonumber root.
Returns: 'true' on success, errors on failure.
Start ALL Continuum services. Accepts no arguments.
ctm-stop-task
Cancels a task instance in a running status
REQUIRED PARAMETERS
-i,--instance The Task Instance ID to stop.
Examples
ctm-stop-task -i 43675
Associated API: stop_task
Stops a running Task Instance.
Required Arguments:
instance- The Task Instance identifier.
Returns: Nothing if successful, error messages on failure.
ctm-testbamboo
Test Bamboo connectivity
OPTIONAL PARAMETERS
-i,--instance Bamboo instance name in the Continuum
configuration. Optional, do not use if
testing default Bamboo instance.
Examples
ctm-testbamboo -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testbitbucket
Test BitBucket connectivity
OPTIONAL PARAMETERS
-i,--instance Instance name in the Continuum
configuration. Optional, not necessary if
testing the default instance.
Examples
ctm-testbitbucket -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testgitlab
Test GitLab connectivity
OPTIONAL PARAMETERS
-i,--instance Instance name in the Continuum
configuration. Optional, not necessary if
testing the default instance.
Examples
ctm-testgitlab -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testhipchat
Test HipChat Server connectivity
OPTIONAL PARAMETERS
-i,--instance HipChat instance name in the Continuum
configuration. Optional, do not use if
testing default HipChat instance.
Examples
ctm-testhipchat -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testjenkins
Test Jenkins connectivity
OPTIONAL PARAMETERS
-i,--instance Jenkins instance name in the Continuum
configuration. Optional, do not use if
testing default Jenkins instance.
Examples
ctm-testjenkins -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testjira
Test Jira connectivity
OPTIONAL PARAMETERS
-i,--instance Jira instance name in the Continuum
configuration. Optional, do not use if
testing default Jira instance.
Examples
ctm-testjira -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testoctopus
Test Octopus connectivity
OPTIONAL PARAMETERS
-i,--instance Octopus instance name in the Continuum
configuration. Optional, do not use if
testing default Octopus instance.
Examples
ctm-testoctopus -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testteamcity
Test TeamCity connectivity
OPTIONAL PARAMETERS
-i,--instance TeamCity instance name in the Continuum
configuration. Optional, do not use if
testing default TeamCity instance.
Examples
ctm-testteamcity -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-testversionone
Test VersionOne connectivity
OPTIONAL PARAMETERS
-i,--instance VersionOne instance name in the Continuum
configuration. Optional, do not use if
testing default VersionOne instance.
Examples
ctm-testversionone -i instancename
Associated API: test_plugin_connection
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
plugin- the module name of a Plugin.
Optional Arguments:
instance- A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.
Returns: A success message or error message
ctm-untag-object
Removes a security Tag from an object.
REQUIRED PARAMETERS
-t,--tag The name of the Tag.
-o,--object_id The ID of the object.
-y,--object_type The numeric object type of the object.
(User = 1, Asset = 2, Task = 3)
Examples
To untag a task using task uuid and the task object type
ctm-untag-object -t "development" -o "7f17e600-794f-11e3-bb4c-c8bcc89d4845" -y 3
Associated API: remove_object_tag
Removes a security Tag from an object.
Required Arguments:
tag- The name of the Tag.object_id- The ID of the object.object_type- The numeric type of the object.
Returns: Success message if successful, error message on failure.
ctm-update
Update Continuum to the latest official release, or alternatively select a specific release.
OPTIONAL PARAMETERS
-v,--version An explicit official release version to
install.
-d,--development A specific development version to install.
Examples
ctm-update
ctm-update -v 16.0.400
ctm-update -d 16.1.503
Associated API: update
None
ctm-version
Displays the Version by request from the API.
Examples
ctm-version
Associated API: version
Returns: The Continuum version.
ctm-winrm
Test WinRM connections and issue commands.
OPTIONAL PARAMETERS
-s,--server Windows server address.
-u,--user Windows User with WinRM permissions.
-p,--password Windows User Password.
-a,--asset The ID or Name of an Asset to use instead
of --server, --user and --password.
-k,--kerberos Use Kerberos (Domain) authentication.
-c,--command A command to execute via WinRM.
Examples
ctm-winrm -uusername -ppassword -sserver -c"dir c:"
Associated API: winrm_command
Test connectivity or issue Windows Remote Management commands on a defined Asset.
Required Arguments:
- asset - Asset ID or Name of an Asset to use for the connection.
OR
- server - WinRM Server FQDN or IP address.
- user - User account.
- password - User password.
Optional Arguments:
- kerberos - Use Kerberos authentication if 'True', basic authentication if omitted.
- command - The command to execute. (Will connection test only if omitted.)
- powershell - (boolean) If True, will execute the command as a PowerShell command.
Returns: The result of the command, or errors.