usr/src/man/man3iscsit/it_tpg_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_TPG_CREATE 3ISCSIT "Oct 1, 2008"
   7 .SH NAME
   8 it_tpg_create, it_tpg_delete, it_tpg_free \- create and         delete iSCSI
   9 target portal groups
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-liscsit\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <libiscsit.h>
  15
  16 \fBint\fR \fBit_tpg_create\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t **\fR\fItpg\fR,
  17      \fBchar *\fR\fItpg_name\fR, \fBchar *\fR\fIportal_ip_port\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBit_tpg_delete\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t *\fR\fItpg\fR,
  23      \fBboolean_t\fR \fIforce\fR););
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBvoid\fR \fBit_tpg_free\fR(\fBit_tpg_t *\fR\fItpg\fR);
  29 .fi
  30
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIcfg\fR\fR
  36 .ad
  37 .RS 18n
  38 a pointer t the iSCSI configuration structure
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fItpg\fR\fR
  45 .ad
  46 .RS 18n
  47 a pointer to the \fBit_tpg_t\fR structure representing the target portal group
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fItpg_name\fR\fR
  54 .ad
  55 .RS 18n
  56 an identifier for the target portal group
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIportal_ip_port\fR\fR
  63 .ad
  64 .RS 18n
  65 a string containing an appropriately formatted IP \fBaddress\fR:\fBport\fR.
  66 Both IPv4 and IPv6 addresses are permitted. This value becomes the first portal
  67 in the target portal group. Applications can add additional values using
  68 \fBit_portal_create\fR(3ISCSIT) before committing the target portal group. IPv6
  69 addresses should be enclosed in square brackets ('[', ']').
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fIforce\fR\fR
  76 .ad
  77 .RS 18n
  78 boolean value indicating if the target portal group should be removed even if
  79 it is associated with one or more targets. If not \fBB_TRUE\fR, the operation
  80 will fail if the target product group is associated with a target.
  81 .RE
  82
  83 .SH DESCRIPTION
  84 .sp
  85 .LP
  86 The \fBit_tpg_create()\fR function allocates and creates an \fBit_tpg_t\fR
  87 structure representing a new iSCSI target portal group. The new \fBit_tpg_t\fR
  88 structure is added to the global \fItpg\fR list (\fIcfg_tgt_list\fR) in the
  89 \fBit_config_t\fR structure.
  90 .sp
  91 .LP
  92 The \fBit_tpg_delete()\fR function deletes the target portal group represented
  93 by \fItpg\fR, where \fItpg\fR is an existing \fBit_tpg_t\fR structure within
  94 the global configuration \fIcfg\fR.
  95 .sp
  96 .LP
  97 The \fBit_tpg_free()\fR function deallocates resources associated with an
  98 \fBit_tpg_t\fR structure. If \fItpg\fR->\fInext\fR is not \fINULL\fR, this
  99 function frees all members of the list.
 100 .sp
 101 .LP
 102 Configuration changes as a result of these functions are not instantiated until
 103 the modified configuration is committed by calling
 104 \fBit_config_commit\fR(3ISCSIT).
 105 .SH RETURN VALUES
 106 .sp
 107 .LP
 108 The \fBit_tpg_create()\fR and \fBit_tpg_delete()\fR functions return 0 on
 109 success and an error value on failure.
 110 .SH ERRORS
 111 .sp
 112 .LP
 113 The \fBit_tpg_create()\fR and \fBit_tpg_delete()\fR functions will fail if:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEBUSY\fR\fR
 118 .ad
 119 .RS 10n
 120 The portal group is associated with one or more targets.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBEEXIST\fR\fR
 127 .ad
 128 .RS 10n
 129 The portal was already configured for another portal group associated with this
 130 target.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBEINVAL\fR\fR
 137 .ad
 138 .RS 10n
 139 A parameter is invalid.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBENOMEM\fR\fR
 146 .ad
 147 .RS 10n
 148 Resources could not be allocated.
 149 .RE
 150
 151 .SH ATTRIBUTES
 152 .sp
 153 .LP
 154 See \fBattributes\fR(5) for descriptions of the following attributes:
 155 .sp
 156
 157 .sp
 158 .TS
 159 box;
 160 c | c
 161 l | l .
 162 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 163 _
 164 Interface Stability     Committed
 165 _
 166 MT-Level        MT-Safe
 167 .TE
 168
 169 .SH SEE ALSO
 170 .sp
 171 .LP
 172 \fBit_config_commit\fR(3ISCSIT), \fBit_ini_create\fR(3ISCSIT),
 173 \fBit_portal_create\fR(3ISCSIT), \fBit_tgt_create\fR(3ISCSIT),
 174 \fBlibiscsit\fR(3LIB), \fBlibnvpair\fR(3LIB), \fBlibstmf\fR(3LIB),
 175 \fBattributes\fR(5)