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

Go to the source code of this file.

Macros

#define OPEN_CAPAB_LIC_MAX_FILE_PARAM_VAL_LEN   64
 
#define OPEN_CAPAB_LIC_MAX_KEY_LEN   32
 
#define OPEN_CAPAB_LIC_MAX_LICENSE_FILES   16
 
#define OPEN_CAPAB_LIC_MAX_MODEL_LEN   32
 
#define OPEN_CAPAB_LIC_MAX_SERIAL_LEN   64
 
#define OPEN_CAPAB_LIC_MAX_VER_LEN   6
 

Enumerations

enum  OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t { OPEN_CAPAB_LICENSE_FILE_PARAM_COPY = 1, OPEN_CAPAB_LICENSE_FILE_PARAM_DATE, OPEN_CAPAB_LICENSE_FILE_PARAM_DESC }
 
enum  OPEN_CAPAB_LICENSE_STATUS_TYPE_t {
  OPEN_CAPAB_LICENSE_STATUS_FILE_NOT_PRESENT = 1, OPEN_CAPAB_LICENSE_STATUS_VALID, OPEN_CAPAB_LICENSE_STATUS_APPLIED, OPEN_CAPAB_LICENSE_STATUS_REMOVED,
  OPEN_CAPAB_LICENSE_STATUS_INVALID, OPEN_CAPAB_LICENSE_STATUS_UNSUPPORTED, OPEN_CAPAB_LICENSE_STATUS_DUPLICATE, OPEN_CAPAB_LICENSE_STATUS_ERROR
}
 
enum  OPEN_CAPAB_LICENSE_TYPE_t { OPEN_CAPAB_LICENSE_TYPE_UNKNOWN = 1, OPEN_CAPAB_LICENSE_TYPE_PORT, OPEN_CAPAB_LICENSE_TYPE_FEATURE, OPEN_CAPAB_LICENSE_TYPE_PORT_FEATURE }
 

Functions

open_error_t openapiCapabLicenseCountGet (openapiClientHandle_t *client_handle, uint32_t *numOfLicenses)
 Get the number of license files in the system.
 
open_error_t openapiCapabLicenseFirstIndexGet (openapiClientHandle_t *client_handle, uint32_t *firstLicenseIndex)
 Get the first license index in the system.
 
open_error_t openapiCapabLicenseKeyGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, open_buffdesc *version)
 Get the key of license file in the system.
 
open_error_t openapiCapabLicenseLicenseRemove (openapiClientHandle_t *client_handle, uint32_t licenseIndex)
 Remove a license file.
 
open_error_t openapiCapabLicenseLicenseRemoveAll (openapiClientHandle_t *client_handle)
 Remove all license files in the System.
 
open_error_t openapiCapabLicenseModelGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, open_buffdesc *model)
 Get the model name of license file.
 
open_error_t openapiCapabLicenseNextIndexGet (openapiClientHandle_t *client_handle, uint32_t currentIndex, uint32_t *nextLicenseIndex)
 Get the next license index in the system.
 
open_error_t openapiCapabLicenseParamGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t paramType, open_buffdesc *paramValue)
 Get the parameter value of license file in the system.
 
open_error_t openapiCapabLicenseSerialNumberGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, open_buffdesc *serialNum)
 Get the serial number of license file.
 
open_error_t openapiCapabLicenseStatusGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, OPEN_CAPAB_LICENSE_STATUS_TYPE_t *status)
 Get the status of license in the system.
 
open_error_t openapiCapabLicenseTypeGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, OPEN_CAPAB_LICENSE_TYPE_t *type)
 Get the type of license.
 
open_error_t openapiCapabLicenseVersionGet (openapiClientHandle_t *client_handle, uint32_t licenseIndex, open_buffdesc *version)
 Get the version number of license file in the system.