Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_system.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_system.h
28 *
29 * @purpose System Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 28/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_SYSTEM_H_INCLUDED
39 #define OPENAPI_SYSTEM_H_INCLUDED
40 #define OPENAPI_HW_VERSION_STR_SIZE 128
41 #define OPENAPI_OS_REVISION_STR_SIZE 100
42 
43 #include "openapi_common.h"
44 
46 typedef enum
47 {
48  OPEN_PROTOCOL_MODE_INVALID = 0,
49  OPEN_PROTOCOL_MODE_NONE = 1,
50  OPEN_PROTOCOL_MODE_BOOTP = 2,
51  OPEN_PROTOCOL_MODE_DHCP = 3
52 } OPEN_PROTOCOL_MODE_t;
53 
54 #define OPEN_MANUFACTURER_SIZE 6 + 1
55 #define OPEN_OS_VERSION_SIZE 60
56 #define OPEN_SYSTEM_PARAM_SIZE 256
57 
58 /*****************************************************************/
77 open_error_t openapiSystemPromptSet(openapiClientHandle_t *client_handle,
78  open_buffdesc *systemPrompt);
79 
80 /*****************************************************************/
94 open_error_t openapiSystemPromptMaxSizeGet(openapiClientHandle_t *client_handle,
95  uint32_t *promptSize);
96 
97 /*****************************************************************/
118 open_error_t openapiSystemHostnameSet(openapiClientHandle_t *client_handle,
119  open_buffdesc *sysHostName);
120 
121 /*****************************************************************/
137 open_error_t openapiSystemHostnameGet(openapiClientHandle_t *client_handle,
138  open_buffdesc *sysHostName);
139 
140 /*****************************************************************/
154 open_error_t openapiSystemHostnameSizeGet(openapiClientHandle_t *client_handle,
155  uint32_t *hostNameSize);
156 
157 /*****************************************************************/
172 open_error_t openapiSystemLocalUnitGet(openapiClientHandle_t *client_handle,
173  uint32_t *unit);
174 
175 /*****************************************************************/
191 open_error_t openapiSystemNameGet(openapiClientHandle_t *client_handle,
192  open_buffdesc *systemName);
193 
194 /*****************************************************************/
208 open_error_t openapiSystemNameMaxSizeGet(openapiClientHandle_t *client_handle,
209  uint32_t *systemNameSize);
210 
211 /*****************************************************************/
233 open_error_t openapiLineTerminalLengthSet(openapiClientHandle_t *client_handle,
234  OPEN_ACCESS_LINE_t accessLine,
235  uint32_t termLength);
236 
237 /*****************************************************************/
254 open_error_t openapiLineTerminalLengthDefaultSet(openapiClientHandle_t *client_handle,
255  OPEN_ACCESS_LINE_t accessLine);
256 
257 /*****************************************************************/
275 open_error_t openapiLineTerminalLengthGet(openapiClientHandle_t *client_handle,
276  OPEN_ACCESS_LINE_t accessLine,
277  uint32_t *termLength);
278 
279 /*****************************************************************/
294 open_error_t openapiSerialTimeoutSet(openapiClientHandle_t *client_handle,
295  uint32_t serialTimeout);
296 
297 /*****************************************************************/
311 open_error_t openapiSerialTimeoutDefaultSet(openapiClientHandle_t *client_handle);
312 
313 /*****************************************************************/
327 open_error_t openapiSerialTimeoutGet(openapiClientHandle_t *client_handle,
328  uint32_t *serialTimeout);
329 
330 /*****************************************************************/
344 open_error_t openapiNetworkMgmtVlanGet(openapiClientHandle_t *client_handle,
345  uint32_t *mgmtVlan);
346 
347 /*****************************************************************/
367 open_error_t openapiNetworkMgmtVlanSet(openapiClientHandle_t *client_handle,
368  uint32_t mgmtVlan);
369 
370 /*****************************************************************/
384 open_error_t openapiNetworkPortLinkStateGet(openapiClientHandle_t *client_handle,
385  OPEN_LINK_STATE_t *linkState);
386 
387 /*****************************************************************/
412 open_error_t openapiNetworkPortIPv4ParametersSet(openapiClientHandle_t *client_handle,
413  open_inet_addr_t *ipAddr,
414  open_inet_addr_t *netMask,
415  open_inet_addr_t *gateway);
416 
417 /*****************************************************************/
434 open_error_t openapiNetworkPortIPv4ParametersDelete(openapiClientHandle_t *client_handle);
435 
436 /*****************************************************************/
452 open_error_t openapiNetworkPortIPv4AddrGet(openapiClientHandle_t *client_handle,
453  open_inet_addr_t *ipAddr,
454  open_inet_addr_t *netMask);
455 
456 /*****************************************************************/
471 open_error_t openapiNetworkPortGatewayIPv4AddrGet(openapiClientHandle_t *client_handle,
472  open_inet_addr_t *gateway);
473 
474 /*****************************************************************/
491 open_error_t openapiNetworkPortIPv6AdminModeSet(openapiClientHandle_t *client_handle,
492  OPEN_CONTROL_t adminMode);
493 
494 /*****************************************************************/
511 open_error_t openapiNetworkPortIPv6AdminModeGet(openapiClientHandle_t *client_handle,
512  OPEN_CONTROL_t *adminMode);
513 
514 /*****************************************************************/
531 open_error_t openapiNetworkPortIPv6AutoConfigModeSet(openapiClientHandle_t *client_handle,
532  OPEN_CONTROL_t autoConfigMode);
533 
534 /*****************************************************************/
550 open_error_t openapiNetworkPortIPv6AutoConfigModeGet(openapiClientHandle_t *client_handle,
551  OPEN_CONTROL_t *autoConfigMode);
552 
553 /*****************************************************************/
570 open_error_t openapiNetworkPortIPv6ProtocolModeSet(openapiClientHandle_t *client_handle,
571  OPEN_PROTOCOL_MODE_t protoMode);
572 
573 /*****************************************************************/
588 open_error_t openapiNetworkPortIPv6ProtocolModeGet(openapiClientHandle_t *client_handle,
589  OPEN_PROTOCOL_MODE_t *protoMode);
590 
591 /*****************************************************************/
612 open_error_t openapiNetworkPortIPv6PrefixSet(openapiClientHandle_t *client_handle,
613  open_inet_pfx_t *ipv6Addr);
614 
615 /*****************************************************************/
635 open_error_t openapiNetworkPortIPv6GatewaySet(openapiClientHandle_t *client_handle,
636  open_inet_addr_t *gateway);
637 
638 /*****************************************************************/
657 open_error_t openapiNetworkPortIPv6AddressesNextGet(openapiClientHandle_t *client_handle,
658  open_inet_pfx_t *ipv6Addr);
659 
660 /*****************************************************************/
676 open_error_t openapiNetworkPortIPv6GatewayGet(openapiClientHandle_t *client_handle,
677  open_inet_addr_t *gateway);
678 
679 /*****************************************************************/
700 open_error_t openapiNetworkPortIPv6PrefixDelete(openapiClientHandle_t *client_handle,
701  open_inet_pfx_t *ipv6Addr);
702 
703 /*****************************************************************/
726 open_error_t openapiServicePortIPv4ParametersSet(openapiClientHandle_t *client_handle,
727  open_inet_addr_t *ipAddr,
728  open_inet_addr_t *netMask,
729  open_inet_addr_t *gateway);
730 
731 /*****************************************************************/
748 open_error_t openapiServicePortIPv4ParametersDelete(openapiClientHandle_t *client_handle);
749 
750 /*****************************************************************/
766 open_error_t openapiServicePortIPv4AddrGet(openapiClientHandle_t *client_handle,
767  open_inet_addr_t *ipAddr,
768  open_inet_addr_t *netMask);
769 
770 /*****************************************************************/
784 open_error_t openapiServicePortMaskGet(openapiClientHandle_t *client_handle,
785  open_inet_addr_t *netMask);
786 
787 /*****************************************************************/
802 open_error_t openapiServicePortGatewayIPv4AddrGet(openapiClientHandle_t *client_handle,
803  open_inet_addr_t *gateway);
804 
805 /*****************************************************************/
822 open_error_t openapiServicePortIPv6AdminModeSet(openapiClientHandle_t *client_handle,
823  OPEN_CONTROL_t adminMode);
824 
825 /*****************************************************************/
842 open_error_t openapiServicePortIPv6AdminModeGet(openapiClientHandle_t *client_handle,
843  OPEN_CONTROL_t *adminMode);
844 
845 /*****************************************************************/
862 open_error_t openapiServicePortIPv6AutoConfigModeSet(openapiClientHandle_t *client_handle,
863  OPEN_CONTROL_t autoConfigMode);
864 
865 /*****************************************************************/
881 open_error_t openapiServicePortIPv6AutoConfigModeGet(openapiClientHandle_t *client_handle,
882  OPEN_CONTROL_t *autoConfigMode);
883 
884 /*****************************************************************/
901 open_error_t openapiServicePortIPv6ProtocolModeSet(openapiClientHandle_t *client_handle,
902  OPEN_PROTOCOL_MODE_t protoMode);
903 
904 /*****************************************************************/
919 open_error_t openapiServicePortIPv6ProtocolModeGet(openapiClientHandle_t *client_handle,
920  OPEN_PROTOCOL_MODE_t *protoMode);
921 
922 /*****************************************************************/
944 open_error_t openapiServicePortIPv6PrefixSet(openapiClientHandle_t *client_handle,
945  open_inet_pfx_t *ipv6Addr);
946 
947 /*****************************************************************/
967 open_error_t openapiServicePortIPv6GatewaySet(openapiClientHandle_t *client_handle,
968  open_inet_addr_t *gateway);
969 
970 /*****************************************************************/
992 open_error_t openapiServicePortIPv6PrefixDelete(openapiClientHandle_t *client_handle,
993  open_inet_pfx_t *ipv6Addr);
994 
995 /*****************************************************************/
1014 open_error_t openapiServicePortIPv6AddressesNextGet(openapiClientHandle_t *client_handle,
1015  open_inet_pfx_t *ipv6Addr);
1016 
1017 /*****************************************************************/
1033 open_error_t openapiServicePortIPv6GatewayGet(openapiClientHandle_t *client_handle,
1034  open_inet_addr_t *gateway);
1035 
1036 /*****************************************************************/
1055 open_error_t openapiNetworkPortIPv4ProtocolModeSet(openapiClientHandle_t *client_handle,
1056  OPEN_PROTOCOL_MODE_t protoMode);
1057 
1058 /*****************************************************************/
1074 open_error_t openapiNetworkPortIPv4ProtocolModeGet(openapiClientHandle_t *client_handle,
1075  OPEN_PROTOCOL_MODE_t *protoMode);
1076 
1077 /*****************************************************************/
1097 open_error_t openapiServicePortIPv4ProtocolModeSet(openapiClientHandle_t *client_handle,
1098  OPEN_PROTOCOL_MODE_t protoMode);
1099 
1100 /*****************************************************************/
1116 open_error_t openapiServicePortIPv4ProtocolModeGet(openapiClientHandle_t *client_handle,
1117  OPEN_PROTOCOL_MODE_t *protoMode);
1118 
1119 /*****************************************************************/
1135 open_error_t openapiTelnetServerAdminModeSet(openapiClientHandle_t *client_handle,
1136  OPEN_CONTROL_t telnetServerMode);
1137 
1138 /*****************************************************************/
1154 open_error_t openapiTelnetServerAdminModeGet(openapiClientHandle_t *client_handle,
1155  OPEN_CONTROL_t *telnetServerMode);
1156 
1157 /*****************************************************************/
1170 open_error_t openapiTransferBytesCompletedSet(openapiClientHandle_t *client_handle,
1171  uint32_t bytes);
1172 
1173 /*****************************************************************/
1190 open_error_t openapiSystemUpTimeGet(openapiClientHandle_t *client_handle,
1191  uint32_t *sysUpTimeSec);
1192 
1193 /*****************************************************************/
1206 open_error_t openapiSystemUpTimeMsecGet(openapiClientHandle_t *client_handle,
1207  uint32_t *sysUpTimeMsec);
1208 
1209 /*****************************************************************/
1221 open_error_t openapiWarmRestartStatusGet(openapiClientHandle_t *client_handle,
1222  OPEN_BOOL_t *warmRestartStatus);
1223 
1224 /*****************************************************************/
1239 open_error_t openapiSystemMacAddrGet(openapiClientHandle_t *client_handle,
1240  open_buffdesc *macAddress);
1241 
1242 /*****************************************************************/
1258 open_error_t openapiSystemBurnedInMacAddrGet ( openapiClientHandle_t *client_handle,
1259  open_buffdesc *mac_address );
1260 
1261 /*****************************************************************/
1279 open_error_t openapiSystemMemoryInfoGet(openapiClientHandle_t *client_handle,
1280  uint32_t *memTotal,
1281  uint32_t *memAlloc,
1282  uint32_t *memFree);
1283 
1284 /*****************************************************************/
1296 open_error_t openapiSaveConfigurationSet(openapiClientHandle_t *client_handle);
1297 
1298 /*****************************************************************/
1314 open_error_t openapiResetConfigurationSet ( openapiClientHandle_t *client_handle );
1315 
1316 /*****************************************************************/
1328 open_error_t openapiSystemReload(openapiClientHandle_t *client_handle);
1329 
1330 /*****************************************************************/
1347 open_error_t openapiManufacturerGet(openapiClientHandle_t *client_handle,
1348  uint32_t unit,
1349  open_buffdesc *manufacturer);
1350 
1351 /*****************************************************************/
1365 open_error_t openapiTimeZoneOffsetGet(openapiClientHandle_t *client_handle,
1366  uint32_t *timeZoneOffsetMin);
1367 
1368 /*****************************************************************/
1384 open_error_t openapiOperSysGet(openapiClientHandle_t *client_handle,
1385  open_buffdesc *operSys);
1386 
1387 /*****************************************************************/
1404 open_error_t openapiArpInfoNextGet(openapiClientHandle_t *client_handle,
1405  uint32_t *arpIndex,
1406  uint32_t *intf,
1407  open_inet_addr_t *ipAddr,
1408  open_buffdesc *mac_addr);
1409 
1410 /*****************************************************************/
1425 open_error_t openapiUidGet(openapiClientHandle_t * client_handle,open_buffdesc *uid);
1426 
1427 /*****************************************************************/
1443 open_error_t openapiMaintenanceLevelGet(openapiClientHandle_t *client_handle,
1444  open_buffdesc *maintenanceLevel);
1445 
1446 /*****************************************************************/
1463 open_error_t openapiClientResourceTrackingSet(openapiClientHandle_t *client_handle,
1464  OPEN_CONTROL_t trackingControl);
1465 
1466 /*****************************************************************/
1482 open_error_t openapiLicenseFeatureStatusGet(openapiClientHandle_t *client_handle,
1483  open_buffdesc *featureName,
1484  OPEN_BOOL_t *enabled);
1485 #endif
1486