Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_system.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_MANUFACTURER_SIZE   6 + 1
 
#define OPEN_OS_VERSION_SIZE   60
 
#define OPEN_SYSTEM_PARAM_SIZE   256
 
#define OPENAPI_HW_VERSION_STR_SIZE   128
 
#define OPENAPI_OS_REVISION_STR_SIZE   100
 

Enumerations

enum  OPEN_PROTOCOL_MODE_t { OPEN_PROTOCOL_MODE_INVALID = 0, OPEN_PROTOCOL_MODE_NONE = 1, OPEN_PROTOCOL_MODE_BOOTP = 2, OPEN_PROTOCOL_MODE_DHCP = 3 }
 OpEN uses this enumeration to define network connectivity protocol modes. More...
 

Functions

open_error_t openapiArpInfoNextGet (openapiClientHandle_t *client_handle, uint32_t *arpIndex, uint32_t *intf, open_inet_addr_t *ipAddr, open_buffdesc *mac_addr)
 Get the next ARP info entry. More...
 
open_error_t openapiClientResourceTrackingSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t trackingControl)
 Sets resource tracking flag for an OpEN API client. More...
 
open_error_t openapiLicenseFeatureStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *featureName, OPEN_BOOL_t *enabled)
 Get license status for component. More...
 
open_error_t openapiLineTerminalLengthDefaultSet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine)
 Set the terminal length of an access line to default. More...
 
open_error_t openapiLineTerminalLengthGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, uint32_t *termLength)
 Get the terminal length of an access line. More...
 
open_error_t openapiLineTerminalLengthSet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, uint32_t termLength)
 Set the terminal length of an access line. More...
 
open_error_t openapiMaintenanceLevelGet (openapiClientHandle_t *client_handle, open_buffdesc *maintenanceLevel)
 Get the maintenance level of the system. More...
 
open_error_t openapiManufacturerGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *manufacturer)
 Get the manufacturer. More...
 
open_error_t openapiNetworkMgmtVlanGet (openapiClientHandle_t *client_handle, uint32_t *mgmtVlan)
 Get the network management VLAN of the system. More...
 
open_error_t openapiNetworkMgmtVlanSet (openapiClientHandle_t *client_handle, uint32_t mgmtVlan)
 Set the network management VLAN on the system. More...
 
open_error_t openapiNetworkPortGatewayIPv4AddrGet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Get the network port gateway IPv4 address. More...
 
open_error_t openapiNetworkPortIPv4AddrGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, open_inet_addr_t *netMask)
 Get the network port IPv4 address and subnet mask. More...
 
open_error_t openapiNetworkPortIPv4ParametersDelete (openapiClientHandle_t *client_handle)
 Delete network port IPv4 parameters. More...
 
open_error_t openapiNetworkPortIPv4ParametersSet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, open_inet_addr_t *netMask, open_inet_addr_t *gateway)
 Set the network parameters. More...
 
open_error_t openapiNetworkPortIPv4ProtocolModeGet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t *protoMode)
 Get the network port IPv4 protocol mode. More...
 
open_error_t openapiNetworkPortIPv4ProtocolModeSet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t protoMode)
 Set the network port IPv4 protocol mode. More...
 
open_error_t openapiNetworkPortIPv6AddressesNextGet (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Get next network port configured IPv6 address and prefix length. More...
 
open_error_t openapiNetworkPortIPv6AdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
 Get IPv6 administrative mode of network port. More...
 
open_error_t openapiNetworkPortIPv6AdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
 Set IPv6 administrative mode on network port. More...
 
open_error_t openapiNetworkPortIPv6AutoConfigModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *autoConfigMode)
 Get IPv6 auto-config mode on network port. More...
 
open_error_t openapiNetworkPortIPv6AutoConfigModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t autoConfigMode)
 Set IPv6 auto-config mode on Network port. More...
 
open_error_t openapiNetworkPortIPv6GatewayGet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Get the network port IPv6 gateway address. More...
 
open_error_t openapiNetworkPortIPv6GatewaySet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Set the network port IPv6 gateway. More...
 
open_error_t openapiNetworkPortIPv6PrefixDelete (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Delete IPv6 prefix(es) on network port. More...
 
open_error_t openapiNetworkPortIPv6PrefixSet (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Set the network IPv6 prefix and prefix length. More...
 
open_error_t openapiNetworkPortIPv6ProtocolModeGet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t *protoMode)
 Set IPv6 protocol mode on network port. More...
 
open_error_t openapiNetworkPortIPv6ProtocolModeSet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t protoMode)
 Set IPv6 protocol mode on network port. More...
 
open_error_t openapiNetworkPortLinkStateGet (openapiClientHandle_t *client_handle, OPEN_LINK_STATE_t *linkState)
 Get network interface link state. More...
 
open_error_t openapiOperSysGet (openapiClientHandle_t *client_handle, open_buffdesc *operSys)
 Get the operating system. More...
 
open_error_t openapiResetConfigurationSet (openapiClientHandle_t *client_handle)
 Clear the switch configuration to factory defaults. More...
 
open_error_t openapiSaveConfigurationSet (openapiClientHandle_t *client_handle)
 Saves the configuration to non-volatile storage. More...
 
open_error_t openapiSerialTimeoutDefaultSet (openapiClientHandle_t *client_handle)
 Set the serial timeout to default value. More...
 
open_error_t openapiSerialTimeoutGet (openapiClientHandle_t *client_handle, uint32_t *serialTimeout)
 Get the serial timeout. More...
 
open_error_t openapiSerialTimeoutSet (openapiClientHandle_t *client_handle, uint32_t serialTimeout)
 Set the serial timeout. More...
 
open_error_t openapiServicePortGatewayIPv4AddrGet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Get the service port gateway IPv4 address. More...
 
open_error_t openapiServicePortIPv4AddrGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, open_inet_addr_t *netMask)
 Get the service port IPv4 address and subnet mask. More...
 
open_error_t openapiServicePortIPv4ParametersDelete (openapiClientHandle_t *client_handle)
 Delete IPv4 service port parameters. More...
 
open_error_t openapiServicePortIPv4ParametersSet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, open_inet_addr_t *netMask, open_inet_addr_t *gateway)
 Set the service port IPv4 parameters. More...
 
open_error_t openapiServicePortIPv4ProtocolModeGet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t *protoMode)
 Get the service port IPv4 protocol mode. More...
 
open_error_t openapiServicePortIPv4ProtocolModeSet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t protoMode)
 Set the service port IPv4 protocol mode. More...
 
open_error_t openapiServicePortIPv6AddressesNextGet (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Get next service port IPv6 address and prefix length. More...
 
open_error_t openapiServicePortIPv6AdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
 Get IPv6 administrative mode of service port. More...
 
open_error_t openapiServicePortIPv6AdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
 Set IPv6 administrative mode of service port. More...
 
open_error_t openapiServicePortIPv6AutoConfigModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *autoConfigMode)
 Get IPv6 auto-config mode of service port. More...
 
open_error_t openapiServicePortIPv6AutoConfigModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t autoConfigMode)
 Set IPv6 auto-config mode on service port. More...
 
open_error_t openapiServicePortIPv6GatewayGet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Get the service port IPv6 gateway address. More...
 
open_error_t openapiServicePortIPv6GatewaySet (openapiClientHandle_t *client_handle, open_inet_addr_t *gateway)
 Set the service port IPv6 gateway. More...
 
open_error_t openapiServicePortIPv6PrefixDelete (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Delete IPv6 parameters set on a service port. More...
 
open_error_t openapiServicePortIPv6PrefixSet (openapiClientHandle_t *client_handle, open_inet_pfx_t *ipv6Addr)
 Set the service port IPv6 parameters. More...
 
open_error_t openapiServicePortIPv6ProtocolModeGet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t *protoMode)
 Get IPv6 protocol mode of service port. More...
 
open_error_t openapiServicePortIPv6ProtocolModeSet (openapiClientHandle_t *client_handle, OPEN_PROTOCOL_MODE_t protoMode)
 Set IPv6 protocol mode on service port. More...
 
open_error_t openapiServicePortMaskGet (openapiClientHandle_t *client_handle, open_inet_addr_t *netMask)
 Get the service port subnet mask. More...
 
open_error_t openapiSystemBurnedInMacAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *mac_address)
 Gets System Burned in MAC Address. More...
 
open_error_t openapiSystemHostnameGet (openapiClientHandle_t *client_handle, open_buffdesc *sysHostName)
 Get the system hostname. More...
 
open_error_t openapiSystemHostnameSet (openapiClientHandle_t *client_handle, open_buffdesc *sysHostName)
 Set the system hostname. More...
 
open_error_t openapiSystemHostnameSizeGet (openapiClientHandle_t *client_handle, uint32_t *hostNameSize)
 Get the maximum size of system hostname. More...
 
open_error_t openapiSystemLocalUnitGet (openapiClientHandle_t *client_handle, uint32_t *unit)
 Get the current unit's ID. More...
 
open_error_t openapiSystemMacAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddress)
 Get System MAC Address. More...
 
open_error_t openapiSystemMemoryInfoGet (openapiClientHandle_t *client_handle, uint32_t *memTotal, uint32_t *memAlloc, uint32_t *memFree)
 Get current system memory allocation information. More...
 
open_error_t openapiSystemNameGet (openapiClientHandle_t *client_handle, open_buffdesc *systemName)
 Get the administratively-assigned system name. More...
 
open_error_t openapiSystemNameMaxSizeGet (openapiClientHandle_t *client_handle, uint32_t *systemNameSize)
 Get the maximum size of the system name. More...
 
open_error_t openapiSystemPromptMaxSizeGet (openapiClientHandle_t *client_handle, uint32_t *promptSize)
 Get the maximum size of system prompt. More...
 
open_error_t openapiSystemPromptSet (openapiClientHandle_t *client_handle, open_buffdesc *systemPrompt)
 Set the system prompt. More...
 
open_error_t openapiSystemReload (openapiClientHandle_t *client_handle)
 Resets the switch. More...
 
open_error_t openapiSystemUpTimeGet (openapiClientHandle_t *client_handle, uint32_t *sysUpTimeSec)
 Get the stack up time in seconds. More...
 
open_error_t openapiSystemUpTimeMsecGet (openapiClientHandle_t *client_handle, uint32_t *sysUpTimeMsec)
 Get the stack up time in milliseconds. More...
 
open_error_t openapiTelnetServerAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *telnetServerMode)
 Get the telnet server admin mode. More...
 
open_error_t openapiTelnetServerAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t telnetServerMode)
 Set the telnet server admin mode. More...
 
open_error_t openapiTimeZoneOffsetGet (openapiClientHandle_t *client_handle, uint32_t *timeZoneOffsetMin)
 Get the time zone minutes parameter. More...
 
open_error_t openapiTransferBytesCompletedSet (openapiClientHandle_t *client_handle, uint32_t bytes)
 Set the transferred bytes. More...
 
open_error_t openapiUidGet (openapiClientHandle_t *client_handle, open_buffdesc *uid)
 Get UID of the System Uid of the system is Datapath ID of the ofdb. More...
 
open_error_t openapiWarmRestartStatusGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *warmRestartStatus)
 Get warm restart status. More...