it_portal_create(3iscsit)

1it_portal_create(3ISCSIiTS)CSI Management Library Functioints_portal_create(3ISCSIT)
2
3
4

NAME

6       it_portal_create, it_portal_delete - create and delete iSCSI portals
7

SYNOPSIS

9       cc [ flag... ] file... -liscsit [ library... ]
10       #include <libiscsit.h>
11
12       int it_portal_create(it_config_t *cfg, it_tpg_t *tpg,
13            it_portal_t **portal, char *portal_ip_port);
14
15
16       void it_portal_delete(it_config_t *cfg, it_tpg_t *tpg,
17            it_portal_t *portal);
18
19

PARAMETERS

21       cfg               a pointer to the iSCSI configuration structure
22
23
24       tpg               a  pointer to the it_tpg_t structure representing the
25                         target portal group
26
27
28       portal            a pointer to the it_portal_t  structure  representing
29                         the portal
30
31
32       portal_ip_port    a  string  containing  an appropriatedly formatted IP
33                         address:port. Both IPv4 and IPv6 addresses  are  per‐
34                         mitted.  IPv6  addresses should be enclosed in square
35                         brackets ('[', ']').
36
37

DESCRIPTION

39       The it_portal_create() function adds an  it_portal_t  structure  repre‐
40       senting a new portal to the specified target portal group. A portal may
41       belong to one and only one target portal group.
42
43
44       The it_portal_delete() function removes the specified portal  from  the
45       specified target portal group.
46
47
48       Configuration  changes as a result of these functions are not instanti‐
49       ated until the modified configuration is committed by  calling  it_con‐
50       fig_commit(3ISCSIT).
51

RETURN VALUES

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

ERRORS

57       The it_portal_create() function will fail if:
58
59       EEXIST    The portal was already configured for another portal group.
60
61
62       EINVAL    A parameter is invalid.
63
64
65       ENOMEM    Resources could not be allocated.
66
67

ATTRIBUTES

69       See attributes(5) for descriptions of the following attributes:
70
71
72
73
74       ┌─────────────────────────────┬─────────────────────────────┐
75       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
76       ├─────────────────────────────┼─────────────────────────────┤
77       │Interface Stability          │Committed                    │
78       ├─────────────────────────────┼─────────────────────────────┤
79       │MT-Level                     │MT-Safe                      │
80       └─────────────────────────────┴─────────────────────────────┘
81