libipadm.h revision f6da83d4178694e7113b71d1e452f15b296f73d8
/*
* CDDL HEADER START
*
* 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
* 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]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _LIBIPADM_H
#define _LIBIPADM_H
#ifdef __cplusplus
extern "C" {
#endif
#include <netdb.h>
#include <ifaddrs.h>
#include <libnvpair.h>
#define IPADM_AOBJ_USTRSIZ 32
#define MAXPROPVALLEN 512
#define LOOPBACK_IF "lo0"
/* special timeout values for dhcp operations */
#define IPADM_DHCP_WAIT_DEFAULT (-1)
#define IPADM_DHCP_WAIT_FOREVER (-2)
/*
* Specifies that the string passed to ipadm_str2nvlist() is a string of comma
* separated names and that each name does not have values associated with it.
*/
#define IPADM_NORVAL 0x00000001
/* error codes */
typedef enum {
IPADM_SUCCESS, /* No error occurred */
IPADM_FAILURE, /* Generic failure */
IPADM_EAUTH, /* Insufficient user authorizations */
IPADM_EPERM, /* Permission denied */
IPADM_NO_BUFS, /* No Buffer space available */
IPADM_NO_MEMORY, /* Insufficient memory */
IPADM_BAD_ADDR, /* Invalid address */
IPADM_BAD_PROTOCOL, /* Wrong protocol family for operation */
IPADM_DAD_FOUND, /* Duplicate address detected */
IPADM_EXISTS, /* Already exists */
IPADM_IF_EXISTS, /* Interface already exists */
IPADM_ADDROBJ_EXISTS, /* Address object already exists */
IPADM_ADDRCONF_EXISTS, /* Addrconf already in progress */
IPADM_ENXIO, /* Interface does not exist */
IPADM_GRP_NOTEMPTY, /* IPMP Group non-empty on unplumb */
IPADM_INVALID_ARG, /* Invalid argument */
IPADM_INVALID_NAME, /* Invalid name */
IPADM_DLPI_FAILURE, /* Could not open DLPI link */
IPADM_DLADM_FAILURE, /* DLADM error encountered */
IPADM_PROP_UNKNOWN, /* Unknown property */
IPADM_ERANGE, /* Value is outside the allowed range */
IPADM_ESRCH, /* Value does not exist */
IPADM_EOVERFLOW, /* Number of values exceed the allowed limit */
IPADM_NOTFOUND, /* Object not found */
IPADM_IF_INUSE, /* Interface already in use */
IPADM_ADDR_INUSE, /* Address alrelady in use */
IPADM_BAD_HOSTNAME, /* hostname maps to multiple IP addresses */
IPADM_ADDR_NOTAVAIL, /* Can't assign requested address */
IPADM_ALL_ADDRS_NOT_ENABLED, /* All addresses could not be enabled */
IPADM_NDPD_NOT_RUNNING, /* in.ndpd not running */
IPADM_DHCP_START_ERROR, /* Cannot start dhcpagent */
IPADM_DHCP_IPC_ERROR, /* Cannot communicate with dhcpagent */
IPADM_DHCP_IPC_TIMEOUT, /* Communication with dhcpagent timed out */
IPADM_TEMPORARY_OBJ, /* Permanent operation on temporary object */
IPADM_IPC_ERROR, /* Cannot communicate with ipmgmtd */
IPADM_OP_DISABLE_OBJ, /* Operation on disable object */
IPADM_NOTSUP, /* Operation not supported */
IPADM_EBADE /* Invalid data exchange with ipmgmtd */
/*
* option flags taken by the libipadm functions
*
* - IPADM_OPT_PERSIST:
* requests to persist the configuration so that it can be
* re-enabled or reapplied on boot.
*
* - IPADM_OPT_ACTIVE:
* Requests to apply configuration without persisting it and
* used by show-* subcommands to retrieve current values.
*
* - IPADM_OPT_DEFAULT:
* retrieves the default value for a given property
*
* - IPADM_OPT_PERM
* retrieves the permission for a given property
*
* - IPADM_OPT_POSSIBLE
* retrieves the range of values for a given property
*
* - IPADM_OPT_APPEND
* for multi-valued properties, appends a new value.
*
* - IPADM_OPT_REMOVE
* for multi-valued properties, removes the specified value
*
* - IPADM_OPT_IPMP
* Used in ipadm_create_if() to plumb ipmp interfaces.
*
* - IPADM_OPT_GENPPA
* Used in ipadm_create_if() to generate a ppa for the given interface.
*
* - IPADM_OPT_ZEROADDR
* return :: or INADDR_ANY
*
* - IPADM_OPT_RELEASE
* Used to release the lease on a dhcp address object
*
* - IPADM_OPT_INFORM
* Used to perform DHCP_INFORM on a specified static address object
*
* - IPADM_OPT_UP
* Used to bring up a static address on creation
*
* - IPADM_OPT_V46
* Used to plumb both IPv4 and IPv6 interfaces by ipadm_create_addr()
*/
#define IPADM_OPT_PERSIST 0x00000001
#define IPADM_OPT_ACTIVE 0x00000002
#define IPADM_OPT_DEFAULT 0x00000004
#define IPADM_OPT_PERM 0x00000008
#define IPADM_OPT_POSSIBLE 0x00000010
#define IPADM_OPT_APPEND 0x00000020
#define IPADM_OPT_REMOVE 0x00000040
#define IPADM_OPT_IPMP 0x00000080
#define IPADM_OPT_GENPPA 0x00000100
#define IPADM_OPT_ZEROADDR 0x00000200
#define IPADM_OPT_RELEASE 0x00000400
#define IPADM_OPT_INFORM 0x00000800
#define IPADM_OPT_UP 0x00001000
#define IPADM_OPT_V46 0x00002000
/* IPADM property class */
/* protocol property that can be applied on interface too */
/* opaque ipadm handle to libipadm functions */
struct ipadm_handle;
typedef struct ipadm_handle *ipadm_handle_t;
/* ipadm_handle flags */
/* opaque address object structure */
typedef struct ipadm_addrobj_s *ipadm_addrobj_t;
/* ipadm_if_info_t states */
typedef enum {
IFIS_OK, /* Interface is usable */
IFIS_DOWN, /* Interface has no UP addresses */
IFIS_FAILED, /* Interface has failed. */
IFIS_OFFLINE, /* Interface has been offlined */
IFIS_DISABLED /* Interface has been disabled. */
typedef struct ipadm_if_info_s {
struct ipadm_if_info_s *ifi_next;
/* ipadm_if_info_t flags */
#define IFIF_BROADCAST 0x00000001
#define IFIF_MULTICAST 0x00000002
#define IFIF_POINTOPOINT 0x00000004
#define IFIF_VIRTUAL 0x00000008
#define IFIF_IPMP 0x00000010
#define IFIF_STANDBY 0x00000020
#define IFIF_INACTIVE 0x00000040
#define IFIF_VRRP 0x00000080
#define IFIF_NOACCEPT 0x00000100
#define IFIF_IPV4 0x00000200
#define IFIF_IPV6 0x00000400
/* ipadm_addr_info_t state */
typedef enum {
IFA_DISABLED, /* Address not in active configuration. */
IFA_DUPLICATE, /* DAD failed. */
IFA_DOWN, /* Address is not IFF_UP */
IFA_TENTATIVE, /* DAD verification initiated */
IFA_OK, /* Address is usable */
IFA_INACCESSIBLE /* Interface has failed */
/* possible address types */
typedef enum {
typedef struct ipadm_addr_info_s {
char ia_aobjname[IPADM_AOBJSIZ];
/* ipadm_addr_info_t flags */
#define IA_UP 0x00000001
#define IA_UNNUMBERED 0x00000002
#define IA_PRIVATE 0x00000004
#define IA_TEMPORARY 0x00000008
#define IA_DEPRECATED 0x00000010
extern void ipadm_close(ipadm_handle_t);
/* Check authorization for network configuration */
extern boolean_t ipadm_check_auth(void);
/*
* Interface mangement functions
*/
uint32_t);
uint32_t);
extern void ipadm_free_if_info(ipadm_if_info_t *);
extern void ipadm_if_move(ipadm_handle_t, const char *);
/*
* Address management functions
*/
uint32_t);
uint32_t);
uint32_t);
extern void ipadm_free_addr_info(ipadm_addr_info_t *);
uint32_t);
uint32_t);
uint32_t);
uint32_t);
ipadm_addrobj_t *);
extern void ipadm_destroy_addrobj(ipadm_addrobj_t);
size_t);
/* Functions to set fields in addrobj for static addresses */
struct sockaddr_storage *);
/* Functions to set fields in addrobj for IPv6 addrconf */
/* Functions to set fields in addrobj for DHCP */
/*
* Property management functions
*/
/* call back function for the property walker */
void *);
ipadm_prop_wfunc_t *, void *);
/* Interface property management - set, reset and get */
/* Address property management - set, reset and get */
const char *, const char *, uint_t);
/* Protoocl property management - set, reset and get */
extern ipadm_status_t ipadm_init_prop(void);
/*
* miscellaneous helper functions.
*/
extern const char *ipadm_status2str(ipadm_status_t);
extern char *ipadm_proto2str(uint_t);
extern uint_t ipadm_str2proto(const char *);
extern ipadm_status_t ipadm_open_arp_on_udp(const char *, int *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBIPADM_H */