---
title: "slave"
canonical: "https://help.vicon.com/space/ShogunPost121/1253736875/slave"
format: markdown
---
# Description

Allows you to enable or disable a DBS (Distributed Batch System) slave.

A slave seat provides processing services to the DBS master seat, receiving tasks from the master seat and returning the results. A DBS slave can only actively process requests from one master at a time. In order for the master and slave to communicate, they must be on the same workgroup and port.

## Functional area

Master/Slave

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `slave on/off/toggle [-port integer] [-workgroup string]` |

### Arguments

| Name | Type | Required | Comments |
| --- | --- | --- | --- |
| `on/off/toggle` | boolean | yes | Turn the slave on or off |

### Flags

> Macro (scroll-tablelayout)

| Name | Flag arguments | Argument type | Exclusive to | Comments |
| --- | --- | --- | --- | --- |
| `port` |  | integer |  | Sets the port that the slave uses to listen for broadcasts from the master. It accepts a number value from 1 to 49150 and it must be set to the same port number as the master. |
| `workgroup` | 1 | string | — | Sets this slave as part of the given processing workgroup. See *Description* above for information about processing. |

## Return value

void

## Examples

```plaintext
// This command will enable a DBS slave and join it as part of
// the "Farming" processing group.
slave on -workgroup "Farming";
slave toggle –workgroup "DBSWorkgroup" – port 5419;
```

# Additional information

## Related commands

- [master](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736732)