modi-cli/README.md

Console application for provisioning, displaying or destroying virtual machines in MODI

# modi-cli console application #

## Overview ##

modi-cli is a cross platform console application which gives access to basic Virtual machines operations (provision, destory, status..)
The modi-cli application allows the game teams to use a simple command line tool and integrate it into their existing pipelines, 
spinning up additional machines as needed.

## Features ##

The MODI command line utility allows for users to provision machines from a common win32 command-line prompt or a linux shell or a Mac OsX.
The CLI interface is simple to use and does require to provide the EA credentials of an AD account with permissions to the MODI service.


## Installation ##

In order to install 'modi-cli' use npm: 

`npm set registry http://dev-modi-npm.rws.ad.ea.com`

`npm adduser`

<specify your user and password for THIS repository>

`npm install modi-cli`.


## Usage ##
## Examples ##

1. Provision new virtual machine:
  
   provision -n "bg897" -d "syn-lg" -b "Windows 7 x64 SP1 - Virtual, WEST (CA1)" --loc "US (West Coast)" -c 1 -g 2 -l 2 --ppu-le 570 --ppu-bu 1210 --ppu-dept 5941 --ppu-project synergy --ppu-contact "bg@ea.com" --ppu-contact-name "bogdang"
  
   provision -n "bg897.ad.ea.com" -d "syn-lg" -b "Windows 7 x64 SP1 - Virtual, WEST (CA1)" --loc "US (West Coast)" -c 1 -g 2 -l 2 --ppu-le 570 --ppu-bu 1210 --ppu-dept 5941 --ppu-project synergy --ppu-contact "bg@ea.com" --ppu-contact-name "bogdang"

   provision --machineName "bg714" -d "syn-lg" -b "Windows 7 x64 SP1 - Virtual, WEST (CA1)" --loc "US (West Coast)" -c 1 -g 2 -l 2 --ppu-le 570 --ppu-bu 1210 --ppu-dept 5941 --ppu-project synergy --ppu-contact "bg@ea.com" --ppu-contact-name "bogdang"

2. Destroy virtual machine
	
   destroy -n 'BI-bg990'

3. Properties of the virtual machine

   properties -n "devbg105"

4. Status of the vm.

   status -n "devbg105"

5. Get the blueprints.

   blueprints	

## License ##

EA internal application.