Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

libiscsi(3) [netbsd man page]

LIBISCSI(3)						   BSD Library Functions Manual 					       LIBISCSI(3)

NAME
libiscsi -- iSCSI network storage protocol implementation LIBRARY
iSCSI protocol library (libiscsi, -liscsi) SYNOPSIS
#include <iscsi.h> int iscsi_target_set_defaults(iscsi_target_t *target); int iscsi_target_start(iscsi_target_t *target); int iscsi_target_listen(iscsi_target_t *target); int iscsi_target_shutdown(iscsi_target_t *target); void iscsi_target_write_pidfile(const char *filename); int iscsi_target_setvar(iscsi_target_t *target, const char *name, const char *value); char * iscsi_target_getvar(iscsi_target_t *target, const char *name); int iscsi_initiator_set_defaults(iscsi_initiator_t *initiator); int iscsi_initiator_start(iscsi_initiator_t *initiator); int iscsi_initiator_discover(iscsi_initiator_t *initiator, char *x, uint64_t a, int b); int iscsi_initiator_shutdown(iscsi_initiator_t *initiator); int iscsi_initiator_setvar(iscsi_initiator_t *initiator, const char *name, const char *value); char * iscsi_initiator_getvar(iscsi_initiator_t *initiator, const char *name); DESCRIPTION
libiscsi is a library interface to the iSCSI target and initiator. This conforms to IETF RFC 3720. The corresponding command line utilities for libiscsi are iscsi-initiator(8) and iscsi-target(8). In normal operation, a process acting as a target (i.e. presenting storage to the network) will call iscsi_target_set_defaults() and will then set various values using the iscsi_target_setvar() function. The value of a variable can be retrieved at any time using the iscsi_target_getvar() function. When all of the variables have been set, the iscsi_target_start() function is called, and the block storage will be served up by the process. A useful illustration of the use of these functions can be found in the source code to the iscsi-target(8) utility. The libiscsi library also provides an implementation of the client end of the iSCSI subsystem, which is known as the initiator. The process acting as an initiator will first call the iscsi_initiator_set_defaults() function, to set default values for the initiator variables. Once all the values have been set to the user preferences using the iscsi_initiator_setvar() function, then the iscsi_initiator_start() function is called. The libiscsi library can be used to perform iSCSI device discovery by calling the iscsi_initiator_discovery() function. This will return a list of all the iSCSI targets which are serving up block storage according to the variables which have already been set. SEE ALSO
iscsi-initiator(8), iscsi-target(8) HISTORY
The libiscsi library first appeared in NetBSD 4.0. This programmatic interface to the iSCSI subsystem first appeared in NetBSD 6.0. AUTHORS
Alistair Crooks <agc@NetBSD.org>. BSD
February 19, 2011 BSD

Check Out this Related Man Page

ISCSID(8)						    BSD System Manager's Manual 						 ISCSID(8)

NAME
iscsid -- iSCSI initiator daemon SYNOPSIS
iscsid [-P pidfile] [-d] [-l loglevel] [-m maxproc] [-t seconds] DESCRIPTION
The iscsid daemon is responsible for performing the Login Phase of iSCSI connections, as well as performing SendTargets discovery. Upon startup, the iscsid daemon opens the iSCSI initiator device file and waits for kernel requests. iscsid does not use any configuration files. All needed information is supplied by the kernel. When the iscsid daemon is not running, already established iSCSI connections continue to work. However, establishing new connections, or recovering existing ones in case of connection error, is not possible. The following options are available: -P pidfile Specify alternative location of a file where main process PID will be stored. The default location is /var/run/iscsid.pid. -d Debug mode. The server sends verbose debug output to standard error, and does not put itself in the background. The server will also not fork and will exit after processing one connection. This option is only intended for debugging the initiator. -l loglevel Specifies debug level. The default is 0. -m maxproc Specifies limit for concurrently running child processes handling connections. The default is 30. Setting it to 0 disables the limit. -t seconds Specifies timeout for login session, after which the connection will be forcibly terminated. The default is 60. Setting it to 0 disables the timeout. FILES
/dev/iscsi The iSCSI initiator device file. /var/run/iscsid.pid The default location of the iscsid PID file. EXIT STATUS
The iscsid utility exits 0 on success, and >0 if an error occurs. SEE ALSO
iscsi(4), iscsictl(8) HISTORY
The iscsid command appeared in FreeBSD 10.0. AUTHORS
The iscsid utility was developed by Edward Tomasz Napierala <trasz@FreeBSD.org> under sponsorship from the FreeBSD Foundation. BSD
September 12, 2014 BSD
Man Page