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

Command Line Interface Help

Usage

.\Apprenda.Wizard.exe [command] [command_options]
Try '.\Apprenda.Wizard.exe /?' or '.\Apprenda.Wizard.exe [command] /?' for more information.

Notes

  • '[ ]' parameters are optional, while '< >' parameters are required
  • if any values (including passwords) contain a non-alpha-numeric characters (such as "@"), the value must be placed within quotation marks

Commands

AddCloud <-url> <-user> <-password> <-inputFile> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-sslPasswords] [-sqlPasswords] [-cachePasswords] [-linuxPassword] [-quiet] [-help]

 

AddDbInstance <-url> <-user> <-password> <-cloud> <-name> <-sqlUser> <-sqlPassword> <-totalMemory> <-totalCpu> <-totalStorage> <-fqdn> [-autoRepair] [-allowRestart] [-autoRetry} [-outputFile] [-dbType] [-serviceName] [-port] [-quiet] [-help]

 

AddNode <-url> <-user> <-password> <-cloud> <-hostName> <-roles> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-customPropertyValues] [-customProperty] [-linuxElevation] [-linuxAdminUser] [-linuxAdminPassword] [-appsRepositoryMount] [-systemRepositoryMount] [-linuxDefaultUser] [-linuxAutomaticAccountCreation] [-quiet] [-help]

 

AddRoles <-url> <-user> <-password> <-cloud> <-hostName> <-roles> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-customPropertyValues] [-customProperty] 

 

AutomaticUpgrade  <-url> <-user> <-password> <-recoveryMethod> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-upgradeFile] [-allowDowntime] [-email] [-quiet] [-help]

 

GenerateInputFile <-url> <-user> <-password> [-xmlPath] [-autoRetry] [-outputFile] [-domain] [-quiet] [-help]

 

Install <-inputFile> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-sqlPasswords] [-tenantPassword] [-windowsAdminPassword] [-windowsSystemPassword] [-smtpPassword] [-iisSharedConfigPasswords] [-signingCertPassword] [-sslPasswords] [-cachePasswords] [-linuxPassword] [-quiet] [-help]

 

ManualUpgrade <-url> <-user> <-password> [-autoRepair] [-allowRestart] [-autoRetry] [-outputFile] [-upgradeFile] [-allowDowntime] [-quiet] [-help]

 

RemoveCloud <-url> <-user> <-password> <-cloud> [-autoRetry] [-outputFile] [-quiet] [-help]

 

RemoveDbInstance <-url> <-user> <-password> <-cloud> <-name> [-autoRetry] [-outputFile] [-quiet] [-help]

 

RemoveNode <-url> <-user> <-password> <-cloud> <-hostName> [-autoRetry] [-outputFile] [-removeMetadata] [-quiet] [-help]

 

RemoveRoles <-url> <-user> <-password> <-cloud> <-hostName> <-roles> [-autoRetry] [-outputFile] [-removeMetadata] [-quiet] [-help]

 

Uninstall <-password> <-url> <-user> [-autoRetry] [-outputFile] [-domain] [-y] [-quiet] [-help]

 

Help <-command>

 

Glossary & Syntax of Command Options

-allowRestart - When this flag is provided, machines will be restarted without prompting the user when required to repair a validation issue. (alias: -restart)

 

-allowDowntime - When specified, proceed with the upgrade even if downtime is required for Apprenda user interfaces. (alias: -ad)

 

-appsRepositoryMount <value> - The path to use on linux servers to mount the applications repository. This is only used when there are currently no linux servers on this Apprenda environment. (alias: -appRepo)

 

-autoRepair - When this flag is provided, an automatic repair of any failed validations will be attempted.

 

-autoRetry  - When this flag is provided, any failed steps will be automatically retried once. 

 

-cachePasswords <value> - A comma separated list of the cache password for every cloud. ex) -cachePw "PrivateCloud=12345,PublicCloud=987654". (alias: -cachePw)

 

-cloud <value> - The name of the cloud to add the new database server instance to. (alias: -c)

 

-customProperty <value> - The name of a pre-existing custom property to be added to this node. (alias: -cp)

 

-customPropertyValues <value> - A comma separated list of property values this node has. (alias: -cpv)

 

-dbType <value> - The type of the database server instance to be added. Possible types: Oracle, SQL Server. Defaults to SQL Server. (alias: -t)

 

-domain <value> - The Windows domain to which the system administrator account for this Apprenda instance belongs.  If not specified a platform operator will be assumed.  Use for <5.0 platforms. (alias: -d)

 

-email <value> - An email address to receive failure notifications (in addition to notifications in the command window) during Platform upgrades. (alias: -e)

 

-fqdn <value> - The fully qualified domain name of this database server instance.

 

-help - Displays this usage information (aliases: -?, /?)

 

-hostName <value> - The host name of the node to add. (alias: -h)

 

-iisSharedConfigPasswords <value> - A comma separated list of the passwords of the Windows user account to use when accessing the IIS shared config file for each cloud. This is only required for clouds using multiple Load Managers. (alias: -iisPw)

The value for the -iisPw parameter should give the name of the cloud (as specified in the input file) followed by the password that corresponds to the user account indicated for that IIS configuration share in the input file. For instance, if the Apprenda Platform will include two clouds that each uses a shared iis config, the value for -iisPw will be "Private=mypassword,Public=mypassword2"

Cloud name: Private
User: myuser
Password: mypassword

Cloud name: Public
User: myuser2
Password: mypassword 2

-inputFile <value> - The path to the Apprenda Grid XML file that defines the Apprenda instance you wish to configure. (alias: -i)

 

-linuxAdminPassword <value> - The linux admin password. This is only used when there are currently no linux servers on this Apprenda environment. (aliases: -lap, -adminPassword)

 

-linuxAdminUser <value> - The linux admin user to use when adding linux servers. This is only used when there are currently no linux servers on this Apprenda environment. (aliases: -lau, -adminUser)

 

-linuxAutomaticAccountCreation <value> - When enabled, the Apprenda system will automatically create linux users for workloads as needed.

 

-linuxDefaultUser <value> - The linux user that will be used by default when starting workloads. (alias: -ldu)

 

-linuxElevation <value> - The method to use when elevating to root on linux servers. Valid options are 'sudo' or 'su'. This is only used when there are currently no linux servers on this Apprenda environment. (aliases: -le, -elevationMethod)

 

-linuxPassword <value> - The password for the Linux admin account to use at install time. This is only required when the Apprenda grid has one or more Linux servers. (alias: -linuxPw)

 

-name <value> - The name of the database server instance to add. (alias: -n)

 

-outputFile <value> - The path to the file where logs will be written. (alias: -o)

 

-password <value> - The password of the platform operator (>=5.0) or system administrator account (<5.0) for this Apprenda instance. (alias: -p)

 

-port <value> - The port of the Oracle database server instance to be added. This option is required and will only be used when adding an Oracle instance.

 

-quiet - Suppresses all output (aliases: -q, /q)

 

-recoveryMethod <value> - The recovery method the Platform will use if a node fails to upgrade. Allowed values are: 'Prompt', 'PlaceInMaintenanceMode' (alias: -rm)

 

-removeMetadata <value> - Remove metadata for node(s) even if they cannot be contacted. (alias: -rm)

 

-roles <value> - A comma separated list of roles that this this node has. Possible roles: web, app, loadManager, linux (alias: -r)

 

-serviceName <value> - The service name of the Oracle database server instance to be added. This option is required and will only be used when adding an Oracle instance. (alias: -sn)

 

-signingCertPassword <value> - The password of the certificate used to sign claims. This is only required when a signing certificate path is provided. (alias: -signingPw)

 

-smtpPassword <value> - The password to use when logging into the mail server to send emails. This is only required when you are using an SMTP server that requires authentication. (alias: -smtpPw)

 

-sqlPasswords <value> - A comma separated list of the passwords to use to connect to database server instances. ex) -sqlPw "SQL\INSTANCE=password,SQL2\INSTANCE=password" (alias: -sqlPw)

The value for the -sqlPw parameter should give the SQL Server instance name followed by the password that corresponds to the SQL user indicated for that SQL Server instance in the input file. For instance, if the Apprenda Platform will include the SQL instances below, the value for -sqlPw will be "Server5=mypassword,Server6/AppDB=mypassword2"

Instance name: Server5 (the default instance is used)
DB admin user: myuser
DB admin password: mypassword

Instance name: Server6/AppDB (a named instance)
Instance name: AppDB
DB admin user: myuser2
DB admin password: mypassword 2

 

-sqlUser <value> - The username to use when connecting to this database server instance.

 

-sslPasswords <value> - A comma separated list of the SSL certificate password for every cloud. ex) -sslPw "PrivateCloud=12345,PublicCloud=987654". These are only required for the clouds that will not have an SSL certificate generated for them. (alias: -sslPw)

 

-systemRepositoryMount <value> - The path to use on linux servers to mount the system repository. This is only used when there are currently no linux servers on this Apprenda environment. (alias: -sysRepo)

 

-tenantPassword <value>- The password to use for the initial login to the Apprenda instance you are installing. (alias: -tenantPw)

 

-totalCpu <value> - The total CPU speed in megahertz of all cores on this database server instance. (alias: -cpu)

 

-totalMemory <value>- The total amount of memory in megabytes of this database server instance. (alias: -mem)

 

-totalStorage <value>- The total amount of disk storage space in megabytes that is available to this database server instance. (alias: -storage)

 

-upgradeFile <value>- The path to the file containing all of the required upgrade settings. (alias: -uf)

 

-url <value>- The URL to the root cloud of the platform you wish to upgrade. ex) http://apps.domain.instance

 

-user <value>- The username of the platform operator (>=5.0) or system administrator account (<5.0) for this Apprenda instance. (alias: -u)

 

-windowsAdminPassword <value>- The password of the Windows user account that Apprenda should use for administrative tasks. (alias: -winAdminPw)

 

-windowsSystemPassword <value>- The password of the Windows user account that Apprenda should use for general execution tasks. (alias: -winSysPw)

 

xmlPath <value> - The path, including the file name, to save the generated XML document to. When not provided, the file will be written to the working directory and use the name of the connected environment. (alias: -xp)

 

-y - When supplied, the confirmation message will be suppressed.