IT_PORTAL_CREATE(3ISCSIT) iSCSI Management Library Functions
it_portal_create, it_portal_delete - create and delete iSCSI portals
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);
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 appropriately formatted IP
address:port. Both IPv4 and IPv6 addresses are
permitted. IPv6 addresses should be enclosed in
square brackets ('[', ']').
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).
The it_portal_create() function returns 0 on success and an error
value on failure.
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.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
it_config_commit(3ISCSIT), it_ini_create(3ISCSIT),
it_tgt_create(3ISCSIT), it_tpg_create(3ISCSIT), libiscsit(3LIB),
libnvpair(3LIB), libstmf(3LIB), attributes(7)
February 21, 2023 IT_PORTAL_CREATE(3ISCSIT)
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 appropriately 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(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
it_config_commit(3ISCSIT), it_ini_create(3ISCSIT),
it_tgt_create(3ISCSIT), it_tpg_create(3ISCSIT), libiscsit(3LIB),
libnvpair(3LIB), libstmf(3LIB), attributes(7)
February 21, 2023 IT_PORTAL_CREATE(3ISCSIT)