CLI Commands
The following list shows the commands that are available.
Note:
CLI commands do not support new lines. Entries are broken for display purposes only.
Most of these commands have equivalent commands in the REST API. See
REST commands
.
addAgentPoolToTeam
Add an agent pool to a team
addAgentToPool
Add an agent to an agent pool
addAgentToTeam
Add an agent to a team
addApplicationToTeam
Add an application to a team
addComponentToApplication
Add a component to an application.
addComponentToTeam
Add a component to a team
addEnvironmentBaseResource
Add a base resource to an environment
addEnvironmentToTeam
Add an environment to a team
addGroupToTeam
Add a group to a team
addResourceToTeam
Add a resource to a team
addTagToAgent
Add a tag to an agent
addTagToApplication
Add a tag to an application
addTagToComponent
Add a tag to a component
addTagToResource
Add a tag to a resource
addUserToGroup
Add a user to a group
addUserToTeam
Add a user to a team
addVersionFiles
Upload files to a version
addVersionLink
Add a link on a version
addVersionStatus
Add a status to a version
createAgentPool
Create an agent pool
createApplication
Create an application from a JSON file
createApplicationProcess
Create an application process
createAuthToken
Create an authorization token
createComponent
Create a new component
createComponentProcess
Create a new component process
createEnvironment
Create a new environment
createGroup
Create an empty group
createResource
Create a resource
createSnapshot
Create a snapshot
createSnapshotOfEnvironment
Take a snapshot of an environment
createStatus
Create a status
createUser
Create a user
createVersion
Create a component version
deleteAgent
Delete an agent
deleteAgentPool
Delete an agent pool
deleteAgentProperty
Remove a property from an agent
deleteComponentVersionPropDef
Delete a component version property
deleteEnvironment
Delete an environment
deleteGroup
Delete a group
deleteResource
Delete a resource
deleteResourceProperty
Delete a resource property
deleteStatus
Delete a status
deleteUser
Delete a user
downloadVersionArtifacts
Download the artifacts of a component version
exportGroup
List the members of a group
forceRenameAgent
Rename an agent
getAgent
Get information about an agent
getAgentPool
Get information about an agent pool
getAgentPools
Get information about all agent pools
getAgentProperty
Get the value of a property on an agent
getAgents
Get information about all agents
getApplication
Get information about an application
getApplicationProcess
Get information about an application process
getApplicationProcessRequestStatus
Request the status of an application process request
getApplicationProperties
Get all application properties and their values.
getApplicationProperty
Get the value of a custom property on a application
getApplications
Get information about all applications on the server
getBlueprintNodePropertiesTemplate
Get blueprint properties
getBlueprintsInApplication
Get all blueprints in an application
getComponent
Get information about a component
getComponentEnvironmentProperties
Get component environment properties for an environment
getComponentProcess
Get information about a component process
getComponentProperties
Get values for component properties
getComponentProperty
Get the value of a custom property on a component
getComponentVersionPropDefs
List the version property definitions for a component
getComponents
Get information about all components on the server
getComponentsInApplication
Get all components in an application
getEnvironment
Get information about an environment
getEnvironmentBaseResources
Get all base resources for an environment
getEnvironmentProperties
Get environment property values
getEnvironmentProperty
Get the value of a custom property on an environment.
getEnvironmentsInApplication
Get information about all environments in an application
getResource
Get information about a resource
getResourceProperties
List resource properties
getResourceProperty
Get a resource property
getResources
List resources
getResourcesWithComponentVersion
List resources that have a specified component version
getStatus
Get information about a status
getStatuses
List statuses
getSystemConfiguration
List system configuration properties
getSystemProperties
List system properties
getSystemProperty
Get the value of a system property
getTagsOnAgent
List all tags on an agent
getTagsOnApplication
List all tags on an application
getTagsOnComponent
Return all tags on a component
getTagsOnResource
List the tags on a resource
getUser
List information about a user
getVersionLink
Get a link on a component version
getVersionLinks
List links on a version
getVersionProperties
List the properties on a component version
importGroup
Create a group
importLdapUser
Import a user from LDAP
importVersions
Import new component versions
installAgent
Install an agent
login
Log in
logout
Log out
provisionEnvironment
Provision a cloud environment
removeAgentFromPool
Remove an agent from an agent pool
removeAgentFromTeam
Remove an agent from a team
removeAgentPoolFromTeam
Remove an agent pool from a team
removeApplicationFromTeam
Remove an application from a team
removeComponentFromTeam
Remove a component from a team
removeEnvironmentBaseResource
Remove a base resource from an environment
removeEnvironmentFromTeam
Remove an environment from a team
removeResourceFromTeam
Remove a resource from a team
removeTagFromAgent
Delete a tag from an agent
removeTagFromApplication
Remove a tag from an application
removeTagFromComponent
Delete a tag from a component
removeTagFromResource
Remove a tag from a resource
removeUserFromGroup
Remove a user from a group
removeVersionLink
Remove a link from a version
removeVersionStatus
Remove a status from a version
repeatApplicationProcessRequest
Repeat an application process request
requestApplicationProcess
Run an application process
restartAgent
Restart an agent
setAgentProperty
Set a property on a agent
setApplicationProperty
Set a property on an application
setComponentEnvironmentProperty
Set a component environment property value
setComponentProperty
Set a property on a component
setComponentVersionPropDef
Set a version property for a component
setEnvironmentProperty
Set a property on environment
setResourceProperty
Set a property on a resource
setSystemConfiguration
Update the system configuration
setSystemProperty
Set a system property
setVersionProperty
Set a property on a component version
shutdownAgent
Shut down an agent
testAgent
Test the connection from an agent to the server
updateResource
Update a resource
updateUser
Update a user
upgradeAgent
Upgrade an agent
Related concepts
:
Command format
Related tasks
:
Installing the command-line client
Creating components with the command-line client
Related reference
:
Command-line client (CLI) reference
Feedback