This is documentation for Apprenda 7 and 8.
Documentation for newer version is available at https://new.docs.apprenda.com.

ACS Help

This page outlines the commands of the Apprenda Cloud Shell (ACS). Note that to use access all functionality of the ACS, you must make sure that some prerequisites are met.

Structure of Commands

In general, commands for the ACS will use the following structure:

acs [command] [command_options]

Try 'acs ReadHelp [command]' or 'acs /? [command]' for more information.

Commands

Notes about the documentation

  • '[ ]' parameters are optional
  • Commands with a '*' require an active session to a target cloud. If a session has expired, the command should fail gracefully and request a connection.

Also see more information about common workflows in the ACS.

ConnectCloud -cloudAlias <cloudAlias> -user <username> [-password <password>] [-DevTeamAlias <alias>] [-remember]

Please note that -DevTeamAlias is required if the specified User belongs to more than one Development Team.

 

*DemoteVersion -appAlias <applicationAlias> -version <versionAlias> [-y]

 

*DeProvisionAddOn -Alias <addOnAlias> -InstanceAlias <instanceAlias> [-y]

 

DisconnectCloud [-y] (-y forces disconnect without prompt)

 

*GetAddOns

 

*GetDeployedAddOns

 

GetDevTeamsForUser [-cloudAlias <cloudAlias>] [-User <userName>] [-password <password>]

Please note that if a connection already exists, the information retrieved will be for the User under which the connection was made. If no current connection exists, you will be required to provide User and Password parameters.

 

*GetStatistics [-appAlias <applicationAlias>] [-versionAlias <versionAlias>] [-showWorkloads] [-window <utilizationWindowInMinutes>] 

 

*NewApplication -appAlias <applicationAlias> -appName <applicationName> [-description <applicationDescription>] [-package <pathToPackage>] | [-path <pathToSolution>] [-stage <initialStage>] [-uiInstances <numberOfUiInstances>] [-serviceInstances <numberOfServiceInstances>]

-Valid options listed below**

 

NewPackage -Sln <pathToSolution> -O <packagePathAndFileName>

-Valid options listed below**

 

*NewUser -emailAddress <emailAddress> -firstName <firstName> -lastName <lastName> -password <password> [-roles <role,role,role>]

 

*NewVersion -appAlias <applicationAlias> -versionAlias <versionAlias> -versionName <versionName> [-package <pathToPackage>] | [-path <pathToSolution>] [-stage <initialStage>] [-uiInstances <numberOfUiInstances>] [-serviceInstances <numberOfServiceInstances>] [-constructive] [--output <outputFile>]

-Valid options listed below**

 

*PatchVersion -appAlias <applicationAlias> -versionAlias <versionAlias> [-newVersionAlias <newVersionAlias>] [-newVersionName <newVersionName>] [-stage <targetStage>] [-package <pathToPackage>] | [-path <pathToSolution>] [-constructive] (Scenarios for this command listed below****)

-Scenarios listed below****

 

*PromoteVersion -appAlias <applicationAlias> -versionAlias <versionAlias> [-Stage <targetStage>] [-y]

 

*ProvisionAddOn -Alias <addOnAlias> -InstanceAlias <instanceAlias> [-Options <value>] [-Params <values>]

-Valid options listed below***

 

ReadHelp [<commandName>]

 

ReadRegisteredClouds

 

ReadStatus

 

RegisterCloud -url <apprendacloudurl> -alias <cloudalias> 

 

*RemoveApplication -appAlias <applicationAlias>

 

*RemoveVersion -appAlias <applicationAlias> -versionAlias <versionAlias>

 

*SetArchive -appAlias <applicationAlias> -versionAlias <versionAlias> [-package <pathToPackage>] | [-path <pathToSolution>]

-Valid options listed below**

 

*SetInstanceCount -appAlias <applicationAlias> -versionAlias <versionAlias> -component <name> <targetInstanceCount> | +<instances> | -<instances>

 

*SetInstanceMinimum -appAlias <applicationAlias> -versionAlias <versionAlias> -component <name> [-MinCount <minimumInstanceCount>] [-Enforced <true|false>]

 

Additional Options

--Output <outputFile> When followed by an output file, all output will be written both to the console window and the specified file
--NonInteractive When used acs will not prompt for input of required parameters that were not provided.
-HelpDisplays this usage information (aliases: -?, /?)
-Y Suppresses the confirmation prompt.

 

**Additional Options for Packing a Visual Studio Solution (through the NewPackage, NewApplication, NewVersion, or SetArchive commands)

-B When specified, the solution will be rebuild before being packaged.
-Config The solution configuration that should be used when building the solution (typically Debug or Release).
-Filters The list of extensions that should be excluded from the final package.
-I The projects that should be treated as private UI projects.
-PrivateRoot Specifies the primary private UI project; this MUST be specified if UI projects are present but none are named "root".
-S The projects that should be treated as WCF services.
-StoredProcs The list of projects that should be treated as CLR stored procedure projects.
-WS The projects that should be treated as Windows service projects.

***Additional Options for the ProvisionAddOn command

-Params <value> A concretely defined set of parameters. This argument should be the last argument of the ProvisionAddOn command since it will assume that the remaining information is part of this argument. The way to specify each parameter is as follows: -param1 "value1" -param2 "value2"...

The parameters specified when provisioning an Add-On will vary according to the needs of the specific Add-On (many Add-Ons will not require this parameter). Run the GetAddOns command to get a list of available Add-Ons and required/optional parametners.

-Options <value> A string of optional arguments to be passed into the add-on's provision method.

The options specified when provisioning an Add-On will vary according to the needs of the specific Add-On (many Add-Ons will not require this parameter).

****Scenarios for the PatchVersion command

The table below outlines what happens in all possible scenarios when using this command.  Please note that whenever the given version is in the Published stage a new version will automatically be derived from the current version using the supplied -newVersionAlias and -newVersionName arguments.

Current Stage Desired Stage Result
Definition None

Same as Definition -> Definition

Definition Definition

The given archive is uploaded

Definition Sandbox

The given archive is uploaded, then the version is promoted to the Sandbox stage

Definition Published

The given archive is uploaded, then the version is promoted to the Published stage

Sandbox None

Same as Sandbox -> Definition

Sandbox Definition

The version is demoted to the Definition stage, then the given archive is uploaded

Sandbox Sandbox

The version is demoted to the Definition stage, the given archive is uploaded, then the version is promoted to the Sandbox stage

Sandbox Published

The version is demoted to the Definition stage, the given archive is uploaded, then the version is promoted to the Published stage

Published None

Same as Published -> Definition

Published Definition

A new version is derived from the current version, then the given archive is uploaded

Published Sandbox

A new version is derived from the current version, the given archive is uploaded, then the new version is promoted to the Sandbox stage

Published Published

A new version is derived from the current version, the given archive is uploaded, then the new version is promoted to the Published stage