---
name: "nutclient_get_device_command_description"
section: "3"
platform: "linux"
package: "libnutclient-dev"
version: "2.8.1-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libnutclient_commands"
---

# nutclient\_get\_device\_command\_description(3)

Instant command related functions in Network UPS Tools high-level client access library

Part of [libnutclient\_commands(3)](/libnutclient_commands/3.md).

## NAME

libnutclient\_commands, nutclient\_get\_device\_commands, nutclient\_has\_device\_command, nutclient\_get\_device\_command\_description, nutclient\_execute\_device\_command - Instant command related functions in Network UPS Tools high-level client access library

## SYNOPSIS

```
#include <nutclient.h>
```

```
typedef void* NUTCLIENT_t;
```

```
typedef char** strarr;
```

```
strarr nutclient_get_device_commands(
        NUTCLIENT_t client,
        const char* dev);
```

```
int nutclient_has_device_command(
        NUTCLIENT_t client,
        const char* dev, const char* cmd);
```

```
char* nutclient_get_device_command_description(
        NUTCLIENT_t client,
        const char* dev, const char* cmd);
```

```
void nutclient_execute_device_command(
        NUTCLIENT_t client,
        const char* dev, const char* cmd,
        const char* param="");
```

## DESCRIPTION

These functions allow to manage instant commands of devices.

• The **nutclient\_get\_device\_commands()** function retrieves the list of command names for a device.

The returned strarr must be freed by *strarr\_free*.

• The **nutclient\_has\_device\_command** function tests if the specified command is supported by the device.

Return 1 is supported and 0 if not.

• The **nutclient\_get\_device\_command\_description** function retrieves the command description, if any.

The returned string must be freed.

• The **nutclient\_execute\_device\_command** intends to execute the instant command, with an optional parameter.

Common arguments:

• *dev* is the device name.

• *cmd* is the instant command name.

## SEE ALSO

[**libnutclient**(3)](/libnutclient/3.md) [**libnutclient\_devices**(3)](/libnutclient_devices/3.md) [**libnutclient\_general**(3)](/libnutclient_general/3.md)