Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_sdm.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_sdm.h
28 *
29 * @purpose View and configure SDM templates
30 *
31 * @component OPEN
32 *
33 * @create 12/12/2016
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_SDM_H_INCLUDED
39 #define OPENAPI_SDM_H_INCLUDED
40 
41 #include <stdio.h>
42 #include <stddef.h>
43 #include <sys/un.h>
44 
45 #include "openapi_common.h"
46 
47 #define OPEN_MAX_SDM_TEMPLATES 5
49 #define OPEN_SDM_TEMPLATE_NAME_LEN 32
51 /* The values in the following enum are stored persistently and identify the
52  template in use when a switch boots. */
53 
54 typedef enum
55 {
56  OPEN_SDM_TEMPLATE_NONE = 0,
57  OPEN_SDM_TEMPLATE_DUAL_DEFAULT = 1,
58  OPEN_SDM_TEMPLATE_V4_DEFAULT = 2,
59  OPEN_SDM_TEMPLATE_V4_DATA_CENTER = 3,
60  OPEN_SDM_TEMPLATE_DATA_CENTER_PLUS = 4,
61  OPEN_SDM_TEMPLATE_DUAL_DATA_CENTER = 5,
62  OPEN_SDM_TEMPLATE_MPLS_DUAL_DATA_CENTER = 6,
63  OPEN_SDM_TEMPLATE_DCVPN_DUAL_DATA_CENTER = 7,
64  OPEN_SDM_TEMPLATE_DCVPN_V4_DATA_CENTER = 8,
65  OPEN_SDM_TEMPLATE_ALPM = 9,
66  OPEN_SDM_TEMPLATE_ALPM_MPLS_DUAL_DATA_CENTER = 10,
67  OPEN_SDM_TEMPLATE_MAX = OPEN_SDM_TEMPLATE_ALPM_MPLS_DUAL_DATA_CENTER
68 } OPEN_SDM_TEMPLATE_ID_t;
69 
70 /*****************************************************************/
84 open_error_t openapiSdmTemplateSupported(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, OPEN_BOOL_t *supported);
85 
86 /*****************************************************************/
98 open_error_t openapiSdmActiveTemplateGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId);
99 
100 /*****************************************************************/
115 open_error_t openapiSdmNextActiveTemplateGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId);
116 
117 /*****************************************************************/
135 open_error_t openapiSdmNextActiveTemplateSet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId);
136 
137 /*****************************************************************/
155 open_error_t openapiSdmTemplateNameGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, open_buffdesc *templateName);
156 
157 /*****************************************************************/
173 open_error_t openapiSdmTemplateMaxArpEntriesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxEntries);
174 
175 /*****************************************************************/
191 open_error_t openapiSdmTemplateMaxIpv4RoutesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes);
192 
193 /*****************************************************************/
209 open_error_t openapiSdmTemplateMaxNdpEntriesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxEntries);
210 
211 /*****************************************************************/
227 open_error_t openapiSdmTemplateMaxIpv6RoutesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes);
228 
229 /*****************************************************************/
245 open_error_t openapiSdmTemplateMaxEcmpNextHopsGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxHops);
246 
247 /*****************************************************************/
263 open_error_t openapiSdmTemplateMaxIpv4McastRoutesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes);
264 
265 /*****************************************************************/
281 open_error_t openapiSdmTemplateMaxIpv6McastRoutesGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes);
282 
283 /*****************************************************************/
296 open_error_t openapiSdmTemplateIdNextGet(openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId);
297 
298 #endif /* OPENAPI_SDM_H_INCLUDED */
299