---
name: "nbd_set_socket_activation_name"
section: "3"
platform: "linux"
package: "libnbd"
version: "1.24.4-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/nbd_set_socket_activation_name"
---

# nbd\_set\_socket\_activation\_name(3)

set the socket activation name

## NAME

nbd\_set\_socket\_activation\_name - set the socket activation name

## SYNOPSIS

```
 #include <libnbd.h>
 int nbd_set_socket_activation_name (
       struct nbd_handle *h, const char *socket_name
     );
```

## DESCRIPTION

When running an NBD server using [**nbd\_connect\_systemd\_socket\_activation**(3)](/nbd_connect_systemd_socket_activation/3.md) you can optionally name the socket.  Call this function before connecting to the server.

Some servers such as [**qemu-storage-daemon**(1)](/qemu-storage-daemon/1.md) can use this information to associate the socket with a name used on the command line, but most servers will ignore it. The name is passed through the `"LISTEN_FDNAMES"` environment variable.

The parameter `"socket_name"` can be a short alphanumeric string. If it is set to the empty string (also the default when the handle is created) then the name `"unknown"` will be seen by the server.

## RETURN VALUE

If the call is successful the function returns `0`.

## ERRORS

On error `-1` is returned.

Refer to "ERROR HANDLING" in [**libnbd**(3)](/libnbd/3.md) for how to get further details of the error.

The following parameters must not be NULL: `"h"`, `"socket_name"`. For more information see "Non-NULL parameters" in [**libnbd**(3)](/libnbd/3.md).

## HANDLE STATE

nbd\_set\_socket\_activation\_name can be called when the handle is in the following state:

```
 ┌─────────────────────────────────────┬─────────────────────────┐
 │ Handle created, before connecting   │ ✅ allowed              │
 │ Connecting                          │ ❌ error                │
 │ Connecting & handshaking (opt_mode) │ ❌ error                │
 │ Connected to the server             │ ❌ error                │
 │ Connection shut down                │ ❌ error                │
 │ Handle dead                         │ ❌ error                │
 └─────────────────────────────────────┴─────────────────────────┘
```

## VERSION

This function first appeared in libnbd 1.16.

If you need to test if this function is available at compile time check if the following macro is defined:

```
 #define LIBNBD_HAVE_NBD_SET_SOCKET_ACTIVATION_NAME 1
```

## SEE ALSO

[**nbd\_connect\_systemd\_socket\_activation**(3)](/nbd_connect_systemd_socket_activation/3.md), [**nbd\_create**(3)](/nbd_create/3.md), [**nbd\_get\_socket\_activation\_name**(3)](/nbd_get_socket_activation_name/3.md), [**libnbd**(3)](/libnbd/3.md).

## AUTHORS

Eric Blake

Richard W.M. Jones

## COPYRIGHT

Copyright Red Hat

## LICENSE

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA