Manual Pages for UNIX Operating System command usage for man it_ini_setprop

iSCSI Management Library Functions         it_ini_create(3ISCSIT)



NAME
     it_ini_create, it_ini_setprop, it_ini_delete, it_ini_free  -
     create, modify and delete iSCSI Initiator Contexts

SYNOPSIS
     cc [ flag... ] file... -liscsit [ library... ]
     #include 

     int it_ini_create(it_config_t *cfg, it_ini_t **ini,
          char *ini_node_name);


     int it_ini_setprop(it_ini_t *ini, nvlist_t *proplist,
          nvlist_t **errlist););


     void it_ini_delete(it_config_t *cfg, it_ini_t *ini);


     void it_ini_free(it_ini_t *ini);


PARAMETERS
     cfg              a pointer t the iSCSI configuration  struc-
                      ture


     ini              a  pointer  to   the   it_ini_t   structure
                      representing the initiator context


     ini_node_name    the iSCSI node name of the remote initiator


     proplist         a pointer to  an  nvlist_t  containing  the
                      initiator properties to be set


     errlist          an optional pointer  to  an  nvlist_t  that
                      will  be  used to store specific errors (if
                      any) when validating initiator properties


DESCRIPTION
     The it_ini_create() function adds an  initiator  context  to
     the global configuration.


     The it_ini_setprop() function validates  the  provided  pro-
     perty list and sets the properties for the specified initia-
     tor.  If errlist is not NULL, this function returns detailed
     errors  for  each  property  that  failed.   The  format for



SunOS 5.11           Last change: 1 Oct 2008                    1






iSCSI Management Library Functions         it_ini_create(3ISCSIT)



     errlist is key = property, value = error string.


     The it_ini_delete() function removes the specified initiator
     context from the global configuration.


     The  it_ini_free()  function  deallocates  resources  of  an
     it_ini_t  structure. If ini->next is not NULL, this function
     frees all members of the list.


     Configuration changes as a result of these functions are not
     instantiated  until  the modified configuration is committed
     by calling it_config_commit(3ISCSIT).


     Initiator nvlist properties are as follows:



     nvlist Key     Type                  Valid Values
     ______________________________________________________________
     chapuser     string      any string, or none to remove
     chapsecret   string      string of at least 12 characters but
                              not   more   than   255  characters.
                              secret will be base64  encoded  when
                              stored.


RETURN VALUES
     The it_ini_create(), it_ini_setprop(),  and  it_ini_delete()
     functions return 0 on success and an error value on failure.

ERRORS
     The it_ini_create(), it_ini_setprop(),  and  it_ini_delete()
     functions will fail if:

     EEXIST    The requested initiator context is already config-
               ured.


     EINVAL    A parameter or property is invalid.


     ENOMEM    Resources could not be allocated.


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:




SunOS 5.11           Last change: 1 Oct 2008                    2






iSCSI Management Library Functions         it_ini_create(3ISCSIT)



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     it_config_commit(3ISCSIT),        it_portal_create(3ISCSIT),
     it_tgt_create(3ISCSIT),              it_tpg_create(3ISCSIT),
     libiscsit(3LIB),       libnvpair(3LIB),       libstmf(3LIB),
     stmfGetProviderData(3STMF),      stmfSetProviderData(3STMF),
     attributes(5)








































SunOS 5.11           Last change: 1 Oct 2008                    3