Skip to content

AMP Instance Manager command line reference

PhonicUK edited this page Sep 9, 2019 · 5 revisions

Syntax

ampinstmgr [Flags] [Operation] [Arguments] (Optional Arguments)

Available Flags

  • --nocache : When creating/updating instances, do not use an existing cached copy of AMP
  • --advanced : Show advanced operations when using the help command
  • -version : Display the version and exit

Available Operations

 --BrowseInstance [Instance Name]
   Browse to an instance

 --ChangeInstanceStream [Instance Name] [Release Stream] (Force)
   Switch an instance to a different release stream

 --CreateInstance, -c [Module] [Instance Name] [IP Binding] [Port Number] [Licence Key] [Admin Username] [Admin Password] [Provision Settings]
   Create a new standalone AMP instance

 --DeleteInstance, -d [Instance Name] (Skip Verification)
   Delete an existing AMP instance

 --Help, -? (Command)
   Display Help

 --LastLog [Instance Name]
   View the most recent log file for a given AMP instance

 --QuickStart, -quick [Username] [Password] (IP Binding) (Port) (Provision Settings)
   Create an ADS instance

 --RebindInstance [Instance Name] [IP Binding] [Port Number]
   Change the IP/Port binding of an existing AMP instance

 --ReconfigureInstance [Instance Name] [Provision Settings]
   Reconfigure an AMP instance

 --ResetLogin, -e [Instance Name] [Username] [Password]
   Reset a standalone instances login details

 --RestartAllInstances (Instances) (Delay)
   Restart all AMP instances

 --RestartInstance, -r [Instance Name]
   Restart a running AMP instance. If the instance is already stopped it will be started.

 --SetStartBoot, -x [Instance Name]
   Toggle boot-time flag

 --ShowAllInstancePorts
   Show port usage for all instances

 --ShowInstanceInfo, -i [Instance Name]
   Show the information for a given instance.

 --ShowInstancePorts [Instance Name]
   Show port usage by a specific instance

 --ShowInstancesList, -l
   Print the information for current instances as a list.

 --ShowInstancesTable, -t
   Show a table of current instances.

 --ShowModuleList, -m
   Display a list of available modules

 --StartAllInstances, -a (Instances) (Delay)
   Start all AMP instances

 --StartBoot, -b (Delay)
   Start boot-time AMP instances.

 --StartInstance, -s [Instance Name]
   Start an existing AMP instance

 --StopAllInstances, -o (Instances)
   Stop all running AMP instances

 --StopInstance, -q [Instance Name]
   Stop a running AMP instance

 --UpgradeAll, -p (Restart Running Instances) (Mainline Instances Only)
   Upgrade all AMP instances

 --UpgradeInstance, -u [Instance Name]
   Upgrade an existing AMP instance in-place

 --Version
   Display the version

 --View [Instance Name] (Force)
   View the console of a running AMP instance

Clone this wiki locally