.\"  Automatically generated man page, do not edit
.TH NOZZLE_GET_IPS 3 2023-09-27 "kronosnet" "Kronosnet Programmer's Manual"
.SH NAME
nozzle_get_ips \- retrieve the list of all configured ips for a given interface 

.SH SYNOPSIS
.nf
.B #include <libnozzle.h>
.sp
\fBint nozzle_get_ips\fP(
    \fBconst nozzle_t       \fP\fInozzle\fP,
    \fBstruct nozzle_ip   **\fP\fInozzle_ip\fP
);
.fi
.SH DESCRIPTION
.PP
nozzle_get_ips
.PP
nozzle - pointer to the nozzle struct
.PP
nozzle_ip - pointer to the head of a list of nozzle_ip structs. The last IP will have next = NULL. nozzle_ip can be NULL if there are no IP addresses associated with this nozzle device. \fBDO NOT\fR free those structs as they are used internally for IP address tracking.
.SH STRUCTURES
.nf

Info about an IP address on a nozzle interface as returned from nozzle_get_ips 

\fB
struct nozzle_ip {
\fR
\fB
    \fBchar     \fP\fIipaddr[IPADDR_CHAR_MAX+1]\fP;\fR  /* The IP address */
\fB
    \fBchar     \fP\fIprefix[PREFIX_CHAR_MAX+1]\fP;\fR  /* Prefix - eg "24" */
\fB
    \fBint      \fP\fIdomain\fP;\fR                     /* AF_INET or AF_INET6 */
\fB
    \fBstruct   \fP\fInext\fP;\fR                       /* Pointer to next struct or NULL */
};
\fP
.fi
.PP
.RE
.SH RETURN VALUE
.PP
0 on success -1 on error and errno is set. 
.PP
.SH SEE ALSO
.PP
.nh
.ad l
\fInozzle_close\fR(3), \fInozzle_set_mtu\fR(3), \fInozzle_get_fd\fR(3), \fInozzle_get_mtu\fR(3), \fInozzle_reset_mtu\fR(3), \fInozzle_set_up\fR(3), \fInozzle_set_down\fR(3), \fInozzle_reset_mac\fR(3), \fInozzle_get_handle_by_name\fR(3), \fInozzle_run_updown\fR(3), \fInozzle_open\fR(3), \fInozzle_del_ip\fR(3), \fInozzle_get_mac\fR(3), \fInozzle_set_mac\fR(3), \fInozzle_get_name_by_handle\fR(3), \fInozzle_add_ip\fR(3)
.ad
.hy
.SH "COPYRIGHT"
.PP
Copyright (C) 2010-2023 Red Hat, Inc. All rights reserved.