1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH it_portal_create 3ISCSIT "1 Oct 2008" "SunOS 5.11" "iSCSI Management Library Functions"
.SH NAME
it_portal_create, it_portal_delete \- create and delete iSCSI portals
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-liscsit\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <libiscsit.h>
\fBint\fR \fBit_portal_create\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t *\fR\fItpg\fR,
\fBit_portal_t **\fR\fIportal\fR, \fBchar *\fR\fIportal_ip_port\fR);
.fi
.LP
.nf
\fBvoid\fR \fBit_portal_delete\fR(\fBit_config_t *\fR\fIcfg\fR, \fBit_tpg_t *\fR\fItpg\fR,
\fBit_portal_t *\fR\fIportal\fR);
.fi
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcfg\fR\fR
.ad
.RS 18n
.rt
a pointer to the iSCSI configuration structure
.RE
.sp
.ne 2
.mk
.na
\fB\fItpg\fR\fR
.ad
.RS 18n
.rt
a pointer to the \fBit_tpg_t\fR structure representing the target portal group
.RE
.sp
.ne 2
.mk
.na
\fB\fIportal\fR\fR
.ad
.RS 18n
.rt
a pointer to the \fBit_portal_t\fR structure representing the portal
.RE
.sp
.ne 2
.mk
.na
\fB\fIportal_ip_port\fR\fR
.ad
.RS 18n
.rt
a string containing an appropriatedly formatted IP address:port. Both IPv4 and
IPv6 addresses are permitted. IPv6 addresses should be enclosed in square
brackets ('[', ']').
.RE
.SH DESCRIPTION
.sp
.LP
The \fBit_portal_create()\fR function adds an \fBit_portal_t\fR structure
representing a new portal to the specified target portal group. A portal may
belong to one and only one target portal group.
.sp
.LP
The \fBit_portal_delete()\fR function removes the specified portal from the
specified target portal group.
.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).
.SH RETURN VALUES
.sp
.LP
The \fBit_portal_create()\fR function returns 0 on success and an error value
on failure.
.SH ERRORS
.sp
.LP
The \fBit_portal_create()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBEEXIST\fR\fR
.ad
.RS 10n
.rt
The portal was already configured for another portal group.
.RE
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt
A parameter 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_ini_create\fR(3ISCSIT), \fBit_tgt_create\fR(3ISCSIT),
\fBit_tpg_create\fR(3ISCSIT), \fBlibiscsit\fR(3LIB),
\fBit_config_commit\fR(3ISCSIT), \fBlibiscsit\fR(3LIB), \fBlibnvpair\fR(3LIB),
\fBlibstmf\fR(3LIB), \fBattributes\fR(5)
|
