Current File : //usr/share/man/man3iscsit/it_portal_create.3iscsit

'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.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)