node-deadline/lib/slaves/Slave.md

Module to interface with Deadline Compute Management System by Thinkbox Software

#Deadline.slaves.Slave

Represents a singular ative slave from the Deadline database. Also available as `Deadline.Slave`.

###Properties

| Property      | type   | Maps to       | Description
|---------------|--------|---------------|------------
| id            | String | _id           | The unique id of the slave
| name          | String | Name          | The name of the slave
| updated       | Date   | LastWriteTime | The last time the slave infgo was updated (as of access)
| RAMFree       | Number | RAMFree       | total bytes of free RAM
| diskFee       | Number | Disk          | total bytes of free disk space
| diskString    | String | DiskString    | a nice string showing free disk space on this slave
| processorSpeed| Number | ProcSpd       | the speed of the processor in Hz
| CPUs          | Number | CPU           | the number of CPU cores
|               | Number | NetSent       | ??
|               | Number | NetRecieved   | ??
| swapUsed      | Number | Swap          | amount of swap memory used
| diskRead      | Number | DiskRead      | disk read speed at time of access
| diskWrite     | Number | DiskWrite     | disk write speed at time of access
| upTime        | Number | UpTime        | number of seconds running
| host          | String | Host          | the host name of the machine
| user          | String | User          | user that deadline slave is running as
| IP            | String | IP            | the ip address of the slave
| MAC           | String | MAC           | the MAC address of the slave
| processors    | Number | Procs         | number of processor cores in the machine
| RAM           | Number | RAM           | amount of ram in the machine (in bytes)
| architecture  | String | Arch          | the architecture of the machine (ex x64)
| OS            | String | OS            | the operating system on the slave
| version       | String | Ver           | the version of deadline slave being used
| videoCard     | String | Vid           | the video device installed on the slave
| config        | String | Config        | ???
| state         | Number | Stat          | the state of the slave (at time of access)
| stateDate     | Date   | StatDate      | the last time the state was updated
| onComplete    | String | OnTaskComp    | what the slave will do when the task is complete
| completed     | Number | CompletedTasks| the number of tasks completed by this slave
| failed        | Number | TskFail       | the number of tasks failed on this slave
| renderTime    | Number | RndTime       | the amount of time this slave has been rendering
| message       | String | Msg           | the last message from this slave
|               |        | Plse          | weather the slave is connected to Pulse
| port          | Number | Port          | the connection port for this slave
| pools         | String | Pools         | the pools this slave will render for (if any)
| groups        | String | Grps          | the groups this slave belongs to (if any)

**NOTE:** properties with no name have yet to be assigned, but are available in the *slave._data* object.
There are also other properties on that object which are not listed here.
Be aware that changing these options directly requires that you add the property name to the *slave._updated*
array in order to have the information change when the slave is saved.

###Deadline.slaves.Slave.set( properties )

Sets the given properties on this slave. The **properties** object is a set of key-value pairs to update with.

```javasccript
slave.set( {
  description: "My new slave description"
} );
```