Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
Data Structures | Macros | Typedefs | Enumerations | Functions
openapi_dhcp6s.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  openDhcp6sStatData_s
 
struct  openDnsDomainTable_t
 
struct  openDnsServerTable_t
 

Macros

#define OPEN_DHCP6S_DNS_DOMAIN_MAX   8
 
#define OPEN_DHCP6S_DNS_SERVER_MAX   8
 
#define OPEN_DHCP6S_DOMAIN_NAME_MAXLEN   253
 
#define OPEN_DHCP6S_DOMAIN_NAME_MINLEN   1
 
#define OPEN_DHCP6S_DYNAMIC_POOL   1
 
#define OPEN_DHCP6S_HOST_NAME_MAXLEN   32
 
#define OPEN_DHCP6S_INACTIVE_POOL   0
 
#define OPEN_DHCP6S_MANUAL_POOL   2
 
#define OPEN_DHCP6S_MAX_DUID_STR_LEN   389
 
#define OPEN_DHCP6S_MAX_POOL_NUMBER   256
 Structure to store DNS-Domsins list.
 
#define OPEN_DHCP6S_NOT_READY_POOL   3
 To support SNMP create operation.
 
#define OPEN_DHCP6S_POOL_NAME_MAXLEN   32
 
#define OPEN_DHCP6S_POOL_NAME_MINLEN   1
 
#define OPEN_DHCP6S_RELAYOPT_REMOTEID_MAXLEN   64
 wildcard for IP helper ingress interface
 
#define OPEN_IH_INTF_ANY   0
 DHCPv6 statistics common data-structure for both interface statistics and per VRF global statistics.
 

Typedefs

typedef struct openDhcp6sStatData_s openDhcp6sStatData_t
 

Enumerations

enum  OPEN_DHCP6_MODE_t { OPEN_DHCP6_MODE_NONE = 0, OPEN_DHCP6_MODE_SERVER, OPEN_DHCP6_MODE_CLIENT, OPEN_DHCP6_MODE_RELAY }
 
enum  OPEN_DHCP6_PREFIX_TYPE_t { OPEN_DHCP6_PREFIX_IAPD = 0, OPEN_DHCP6_PREFIX_IANA, OPEN_DHCP6_PREFIX_IATA }
 

Functions

open_error_t openapiDhcp6MapIntfIsValid (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isValidFlag)
 Determine if the interface is valid for participation in DHCPv6 components. More...
 
open_error_t openapiDhcp6MapIntfValidFirstGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
 Get the first valid interface for participation in DHCPv6 components. More...
 
open_error_t openapiDhcp6MapIntfValidNextGet (openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum)
 Get the next valid interface for participation in DHCPv6 components. More...
 
open_error_t openapiDhcp6sAdminModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
 Get the administrative mode of the IPv6 DHCP-Sever for given VRF. More...
 
open_error_t openapiDhcp6sAdminModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
 Set the administrative mode of the IPv6 DHCP-Sever for given VRF. More...
 
open_error_t openapiDhcp6sBindingClear (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_DHCP6_PREFIX_TYPE_t prefixType, open_inet_addr_t *clientAddr)
 Clear the binding specified by the IPv6 address for the given VRF. More...
 
open_error_t openapiDhcp6sBindingClearAll (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
 Clear all the binding entries for a given VRF. More...
 
open_error_t openapiDhcp6sBindingCountGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *count)
 Get the count of number of bindings in the binding database for a given VRF. More...
 
open_error_t openapiDhcp6sBindingGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_buffdesc *duid, uint32_t *iaid, open_inet_addr_t *prefixAddr, uint16_t *prefixLen, uint32_t *prefixType, open_inet_addr_t *clientAddr, uint32_t *clientIntfNum, uint32_t *expiration, uint32_t *validLifetime, uint32_t *preferLifetime)
 Get next active binding from the DHCPv6 server for a given VRF. More...
 
open_error_t openapiDhcp6sIntfGetNext (openapiClientHandle_t *client_handle, uint32_t *ifNum)
 Get the next interface with active DHCPv6 configuration. More...
 
open_error_t openapiDhcp6sIntfModeDelete (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vrfName)
 Delete DHCPv6 Server/Relay parameters on a given interface and VRF. More...
 
open_error_t openapiDhcp6sIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP6_MODE_t *mode, open_buffdesc *pPoolName, uint32_t *serverPref, open_inet_addr_t *relayAddr, uint32_t *relayIfNum, open_buffdesc *remoteId, OPEN_BOOL_t *rapidCommit, OPEN_BOOL_t *allowUnicast, open_buffdesc *localVrfName, open_buffdesc *relayDestVrfName, uint32_t *pdClientIntIfNum)
 Get the DHCPv6 Interface parameters for a given interface. More...
 
open_error_t openapiDhcp6sIntfModeRelaySet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum, open_inet_addr_t *serverAddr, uint32_t serverIfNum, open_buffdesc *remoteId)
 Set DHCPv6 Relay parameters for an interface. More...
 
open_error_t openapiDhcp6sIntfModeServerSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *poolName, uint32_t serverPref, OPEN_BOOL_t rapidCommit, OPEN_BOOL_t allowUnicast)
 Set DHCPv6 Server parameters for an interface. More...
 
open_error_t openapiDhcp6sIntfRelayEntryDelete (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum, open_inet_addr_t *serverAddr, uint32_t serverIfNum, open_buffdesc *remoteId)
 Delete DHCPv6 Relay entry/parameters for a given interface. More...
 
open_error_t openapiDhcp6sIntfValidate (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Verify the interface has active DHCPv6 configuration. More...
 
open_error_t openapiDhcp6sNumberToPoolNameGet (openapiClientHandle_t *client_handle, uint32_t poolNumber, open_buffdesc *poolName)
 Get the pool name corresponding to a valid pool number. More...
 
open_error_t openapiDhcp6sPoolCreate (openapiClientHandle_t *client_handle, open_buffdesc *poolName)
 Create a DHCPv6 address pool. More...
 
open_error_t openapiDhcp6sPoolDelete (openapiClientHandle_t *client_handle, open_buffdesc *poolName)
 Delete a DHCPv6 address pool. More...
 
open_error_t openapiDhcp6sPoolDnsDomainAdd (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *domainName)
 Add a DHCPv6 DNS Domain Name for a pool. More...
 
open_error_t openapiDhcp6sPoolDnsDomainRemove (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *domainName)
 Remove a DHCPv6 DNS Domain Name from a pool. More...
 
open_error_t openapiDhcp6sPoolDnsDomainsGet (openapiClientHandle_t *client_handle, open_buffdesc *poolName, openDnsDomainTable_t *dnsDomainNames)
 Get the DHCPv6 DNS Domain Names from a pool. More...
 
open_error_t openapiDhcp6sPoolDnsServerAdd (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *pAddr)
 Add a DHCPv6 host DNS Server for a automatic pool. More...
 
open_error_t openapiDhcp6sPoolDnsServerRemove (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *pAddr)
 Delete a DHCPv6 host DNS Servers for a automatic pool. More...
 
open_error_t openapiDhcp6sPoolDnsServersGet (openapiClientHandle_t *client_handle, open_buffdesc *poolName, openDnsServerTable_t *dnsServers)
 Get DHCPv6 host DNS Servers for a automatic pool. More...
 
open_error_t openapiDhcp6sPoolEntryFirst (openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolIndex)
 Get the first entry in DHCPv6 address pool. More...
 
open_error_t openapiDhcp6sPoolEntryNext (openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolIndex)
 Get the next entry in DHCPv6 address pool. More...
 
open_error_t openapiDhcp6sPoolHostAdd (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *hostName, open_inet_addr_t *prefixAddr, uint16_t prefixLen, uint32_t validLifetime, uint32_t preferLifetime)
 Add a host within a DHCPv6 Server pool. More...
 
open_error_t openapiDhcp6sPoolHostGetNext (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *duidStr, open_buffdesc *hostName, uint32_t *iaid, open_inet_addr_t *prefixAddr, uint16_t *prefixLen, uint32_t *validLifetime, uint32_t *preferLifetime)
 Get next host within a DHCPv6 Server pool. More...
 
open_error_t openapiDhcp6sPoolHostRemove (openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *prefixAddr, uint16_t prefixLen)
 Delete the host within a DHCPv6 Server pool. More...
 
open_error_t openapiDhcp6sPoolNumGet (openapiClientHandle_t *client_handle, uint32_t *poolsCount)
 Get the number of pool for a DHCPv6 Server. More...
 
open_error_t openapiDhcp6sPoolTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolType)
 Get the DHCPv6 Server pool type. More...
 
open_error_t openapiDhcp6sPoolValidate (openapiClientHandle_t *client_handle, uint32_t poolNumber)
 Check if a DHCPv6 pool corresponding to number is valid or not. More...
 
open_error_t openapiDhcp6sServerDuidGet (openapiClientHandle_t *client_handle, open_buffdesc *duid)
 Get the DHCPv6 Server DUID. More...
 
open_error_t openapiDhcp6sStatisticsClear (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vrfName)
 Clear the DHCPv6-Server statistics for a given interface or VRF. More...
 
open_error_t openapiDhcp6sStatisticsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vrfName, openDhcp6sStatData_t *dhcp6Stats)
 Get the DHCPv6-Server statistics for a given VRF or interface. More...
 
open_error_t openapiDhcpv6RelayEntryGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_in6_addr_t *relayAddr, uint32_t *relayIfNum)
 Get the exact DHCPv6 interface relay entry. More...
 
open_error_t openapiDhcpv6RelayEntryNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *relayAddr, uint32_t *relayIfNum, open_buffdesc *vrfName, uint32_t *nextIfNum, open_inet_addr_t *nextRelayAddr, uint32_t *nextRelayIfNum, open_buffdesc *nextVrfName)
 Get the next DHCPv6 interface relay parameters for an interface. More...