'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.TH it_ini_create 3ISCSIT "1 Oct 2008" "SunOS 5.11" "iSCSI Management Library Functions"
.SH NAME
it_ini_create, it_ini_setprop, it_ini_delete, it_ini_free \- create, modify and delete iSCSI Initiator Contexts
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-liscsit\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <libiscsit.h>

\fBint\fR \fBit_ini_create\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_ini_t **\fR\fIini\fR,
     \fBchar *\fR\fIini_node_name\fR);
.fi

.LP
.nf
\fBint\fR \fBit_ini_setprop\fR(\fBit_ini_t *\fR\fIini\fR, \fBnvlist_t *\fR\fIproplist\fR,
     \fBnvlist_t **\fR\fIerrlist\fR););
.fi

.LP
.nf
\fBvoid\fR \fBit_ini_delete\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_ini_t *\fR\fIini\fR);
.fi

.LP
.nf
\fBvoid\fR \fBit_ini_free\fR(\fBit_ini_t *\fR\fIini\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcfg\fR\fR
.ad
.RS 17n
.rt  
a pointer t the iSCSI configuration structure
.RE

.sp
.ne 2
.mk
.na
\fB\fIini\fR\fR
.ad
.RS 17n
.rt  
a pointer to the \fBit_ini_t\fR structure representing the initiator context
.RE

.sp
.ne 2
.mk
.na
\fB\fIini_node_name\fR\fR
.ad
.RS 17n
.rt  
the iSCSI node name of the remote initiator
.RE

.sp
.ne 2
.mk
.na
\fB\fIproplist\fR\fR
.ad
.RS 17n
.rt  
a pointer to an \fBnvlist_t\fR containing the initiator properties to be set
.RE

.sp
.ne 2
.mk
.na
\fB\fIerrlist\fR\fR
.ad
.RS 17n
.rt  
an optional pointer to an \fBnvlist_t\fR that will be used to store specific errors (if any) when validating initiator properties
.RE

.SH DESCRIPTION
.sp
.LP
The \fBit_ini_create()\fR function adds an initiator context to the global configuration.
.sp
.LP
The \fBit_ini_setprop()\fR function validates the provided property list and sets the properties for the specified initiator.  If \fIerrlist\fR is not \fINULL\fR, this function returns detailed errors for each property that failed.  The format for \fIerrlist\fR is \fIkey\fR = \fIproperty\fR, \fIvalue\fR = \fIerror\fR string.
.sp
.LP
The \fBit_ini_delete()\fR function removes the specified initiator context from the global configuration.
.sp
.LP
The \fBit_ini_free()\fR function deallocates resources of an \fBit_ini_t\fR structure. If \fIini\fR\(->\fInext\fR is not \fINULL\fR, this function frees all members of the list.
.sp
.LP
Configuration changes as a result of these functions are not instantiated until the modified configuration is committed by calling \fBit_config_commit\fR(3ISCSIT).
.sp
.LP
Initiator nvlist properties are as follows:
.sp

.sp
.TS
tab();
cw(.9i) cw(.95i) cw(3.65i) 
lw(.9i) lw(.95i) lw(3.65i) 
.
\fBnvlist\fR KeyTypeValid Values
_
\fBchapuser\fR\fBstring\fRany string, or \fBnone\fR to remove
\fBchapsecret\fR\fBstring\fRT{
string of at least 12 characters but not more than 255 characters.  secret will be base64 encoded when stored.
T}
.TE

.SH RETURN VALUES
.sp
.LP
The \fBit_ini_create()\fR, \fBit_ini_setprop()\fR, and \fBit_ini_delete()\fR functions return 0 on success and an error value on failure.
.SH ERRORS
.sp
.LP
The \fBit_ini_create()\fR, \fBit_ini_setprop()\fR, and \fBit_ini_delete()\fR functions will fail if:
.sp
.ne 2
.mk
.na
\fB\fBEEXIST\fR\fR
.ad
.RS 10n
.rt  
The requested initiator context is already configured.
.RE

.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
A parameter or property is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
.rt  
Resources could not be allocated.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBit_config_commit\fR(3ISCSIT), \fBit_portal_create\fR(3ISCSIT), \fBit_tgt_create\fR(3ISCSIT), \fBit_tpg_create\fR(3ISCSIT), \fBlibiscsit\fR(3LIB), \fBlibnvpair\fR(3LIB), \fBlibstmf\fR(3LIB), \fBstmfGetProviderData\fR(3STMF), \fBstmfSetProviderData\fR(3STMF), \fBattributes\fR(5)