table of contents
nbd_set_uri_allow_local_file(3) | LIBNBD | nbd_set_uri_allow_local_file(3) |
NAME¶
nbd_set_uri_allow_local_file - set the allowed transports in NBD URIs
SYNOPSIS¶
#include <libnbd.h> int nbd_set_uri_allow_local_file ( struct nbd_handle *h, bool allow );
DESCRIPTION¶
Allow NBD URIs to reference local files. This is disabled by default.
Currently this setting only controls whether the "tls-psk-file" parameter in NBD URIs is allowed.
RETURN VALUE¶
If the call is successful the function returns 0.
ERRORS¶
On error -1 is returned.
Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.
The following parameters must not be NULL: "h". For more information see "Non-NULL parameters" in libnbd(3).
HANDLE STATE¶
nbd_set_uri_allow_local_file 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.2.
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_URI_ALLOW_LOCAL_FILE 1
SEE ALSO¶
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
2024-10-18 | libnbd-1.20.3 |