xref: /illumos-gate/usr/src/man/man3iscsit/it_portal_create.3iscsit (revision ac2f5fbefc05314fcd97b03f2338b39e6efe643f)
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]
IT_PORTAL_CREATE 3ISCSIT "Oct 1, 2008"
NAME
it_portal_create, it_portal_delete - create and delete iSCSI portals
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -liscsit [ library.\|.\|. ]
#include <libiscsit.h>

int it_portal_create(it_config_t *cfg, it_tpg_t *tpg,
 it_portal_t **portal, char *portal_ip_port);

void it_portal_delete(it_config_t *cfg, it_tpg_t *tpg,
 it_portal_t *portal);
PARAMETERS
cfg

a pointer to the iSCSI configuration structure

tpg

a pointer to the it_tpg_t structure representing the target portal group

portal

a pointer to the it_portal_t structure representing the portal

portal_ip_port

a string containing an appropriatedly formatted IP address:port. Both IPv4 and IPv6 addresses are permitted. IPv6 addresses should be enclosed in square brackets ('[', ']').

DESCRIPTION

The it_portal_create() function adds an it_portal_t structure representing a new portal to the specified target portal group. A portal may belong to one and only one target portal group.

The it_portal_delete() function removes the specified portal from the specified target portal group.

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

RETURN VALUES

The it_portal_create() function returns 0 on success and an error value on failure.

ERRORS

The it_portal_create() function will fail if: EEXIST

The portal was already configured for another portal group.

EINVAL

A parameter is invalid.

ENOMEM

Resources could not be allocated.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

it_ini_create(3ISCSIT), it_tgt_create(3ISCSIT), it_tpg_create(3ISCSIT), libiscsit(3LIB), it_config_commit(3ISCSIT), libiscsit(3LIB), libnvpair(3LIB), libstmf(3LIB), attributes(5)