---
title: "client"
canonical: "https://help.vicon.com/space/Shogun111/13207686/client"
format: markdown
---
# Description

Turns the client on and off

This command enables you to send remote script commands.

## Functional area

Remote control

# Command syntax

## Syntax

|  |
| --- |
| `client on/off/toggle [-port string] [-ip string]` |

### Arguments

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

### Flags

> Macro (scroll-tablelayout)

| **Name** | **Flag arguments** | **Argument type** | **Exclusive to** | **Comments** |
| --- | --- | --- | --- | --- |
| `port` | 1 | string | — | Specifies the port to use for the network socket connection |
| `ip` |  | string |  | Specifies the IP address |

## Return value

void

## Examples

```plaintext
// This command will enable the sending of commands to a remote server
client on -port 4344;
```

> Macro (scroll-pagebreak)

# Additional information

## Related commands

- [remoteControl](https://vicon-help.atlassian.net/wiki/spaces/Shogun111/pages/13208284)
- [sendRemote](https://vicon-help.atlassian.net/wiki/spaces/Shogun111/pages/13208386)
- [server](https://vicon-help.atlassian.net/wiki/spaces/Shogun111/pages/13208388)