usr/src/man/man3iscsit/it_portal_create.3iscsit

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IT_PORTAL_CREATE 3ISCSIT "Oct 1, 2008"
   7 .SH NAME
   8 it_portal_create, it_portal_delete \- create and delete iSCSI portals
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-liscsit\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <libiscsit.h>
  14
  15 \fBint\fR \fBit_portal_create\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t *\fR\fItpg\fR,
  16      \fBit_portal_t **\fR\fIportal\fR, \fBchar *\fR\fIportal_ip_port\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBit_portal_delete\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t *\fR\fItpg\fR,
  22      \fBit_portal_t *\fR\fIportal\fR);
  23 .fi
  24
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIcfg\fR\fR
  30 .ad
  31 .RS 18n
  32 a pointer to the iSCSI configuration structure
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fItpg\fR\fR
  39 .ad
  40 .RS 18n
  41 a pointer to the \fBit_tpg_t\fR structure representing the target portal group
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIportal\fR\fR
  48 .ad
  49 .RS 18n
  50 a pointer to the \fBit_portal_t\fR structure representing the portal
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIportal_ip_port\fR\fR
  57 .ad
  58 .RS 18n
  59 a string containing an appropriatedly formatted IP address:port. Both IPv4 and
  60 IPv6 addresses are permitted. IPv6 addresses should be enclosed in square
  61 brackets ('[', ']').
  62 .RE
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBit_portal_create()\fR function adds an \fBit_portal_t\fR structure
  68 representing a new portal to the specified target portal group. A portal may
  69 belong to one and only one target portal group.
  70 .sp
  71 .LP
  72 The \fBit_portal_delete()\fR function removes the specified portal from the
  73 specified target portal group.
  74 .sp
  75 .LP
  76 Configuration changes as a result of these functions are not instantiated until
  77 the modified configuration is committed by calling
  78 \fBit_config_commit\fR(3ISCSIT).
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 The \fBit_portal_create()\fR function returns 0 on success and an error value
  83 on failure.
  84 .SH ERRORS
  85 .sp
  86 .LP
  87 The \fBit_portal_create()\fR function will fail if:
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEEXIST\fR\fR
  92 .ad
  93 .RS 10n
  94 The portal was already configured for another portal group.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBEINVAL\fR\fR
 101 .ad
 102 .RS 10n
 103 A parameter is invalid.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBENOMEM\fR\fR
 110 .ad
 111 .RS 10n
 112 Resources could not be allocated.
 113 .RE
 114
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     Committed
 129 _
 130 MT-Level        MT-Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBit_ini_create\fR(3ISCSIT), \fBit_tgt_create\fR(3ISCSIT),
 137 \fBit_tpg_create\fR(3ISCSIT), \fBlibiscsit\fR(3LIB),
 138 \fBit_config_commit\fR(3ISCSIT), \fBlibiscsit\fR(3LIB), \fBlibnvpair\fR(3LIB),
 139 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)