JSDoc: Class: machine

new machine()

Source:

lib/virtualBox/machine.js, line 13

Methods

(static) connectionInfo(machineName) → {promise}

Gets the connection info for a docker machine

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 244

Returns:

Q Promise


  {
            host:
            port:
            protocol:
            ca:
            cert:
            key:
 }

Type: promise

(static) create(machineName, settingsopt) → {promise}

Creates a docker machine

Parameters:

Name	Type	Attributes	Description
`machineName`	string		The name of the docker machine
`settings`	object	<optional>	The settings for creating the docker machine

Default Value:

Settings
```
  {
     driver: 'virtualbox'
  }
  
```

Source:

lib/virtualBox/machine.js, line 139

Returns:

Q Promise

Type: promise

(static) exists(machineName) → {promise}

Checks if a docker machine exists

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 20

Returns:

Q Promise -> true or false

Type: promise

(static) exists(machineName) → {promise}

Checks if a docker machine exists

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 48

Returns:

Q Promise -> true or false

Type: promise

(static) ipAddress(machineName, mapNameopt) → {promise}

Adds an entry to the global.dockerMachineIP map

Parameters:

Name	Type	Attributes	Default	Description
`machineName`	string			The name of the docker machine
`mapName`	string	<optional>	machineName	Map identifier

Source:

lib/virtualBox/machine.js, line 221

Returns:

Q Promise -> IP Address

Type: promise

(static) regenerateCerts(machineName) → {promise}

Regenerates docker machine certificates

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 292

Returns:

Q Promise

Type: promise

(static) restart(machineName) → {promise}

Starts a docker machine

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 197

Returns:

Q Promise

Type: promise

(static) start(machineName) → {promise}

Starts a docker machine

Parameters:

Name	Type	Description
`machineName`	string	The name of the docker machine

Source:

lib/virtualBox/machine.js, line 172

Returns:

Q Promise

Type: promise