openapi_protectedport.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_protectedport.h
*
* @purpose   This code implements the OpEN Protected Port API
*
* @component OPEN
*
* @create    05/26/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_PROTECTEDPORT_H_INCLUDED
#define OPENAPI_PROTECTEDPORT_H_INCLUDED

#include "openapi_common.h" 


#define OPEN_PROTECTED_PORT_GROUP_NAME_SIZE  49

/*************************************************************************/
open_error_t openapiProtectedPortMaxGroups (openapiClientHandle_t *client_handle,
                                            uint32_t *maxGroupNum); 

/*************************************************************************/
open_error_t openapiProtectedPortGroupNameGet(openapiClientHandle_t *client_handle, 
                                              uint32_t groupId, 
                                              open_buffdesc *groupName);

/*************************************************************************/
open_error_t openapiProtectedPortGroupNameSet(openapiClientHandle_t *client_handle, 
                                              uint32_t groupId, 
                                              open_buffdesc *groupName);

/*************************************************************************/
open_error_t openapiProtectedPortGroupIntfCountGet(openapiClientHandle_t *client_handle, 
                                                   uint32_t groupId, 
                                                   uint32_t *intfCount);

/*************************************************************************/
open_error_t openapiProtectedPortGroupIntfListGet(openapiClientHandle_t *client_handle, 
                                                  uint32_t groupId, 
                                                  open_buffdesc *intfList);

/*************************************************************************/
open_error_t openapiProtectedPortGroupGet(openapiClientHandle_t *client_handle, 
                                          uint32_t ifNum, uint32_t *groupId);

/*************************************************************************/
open_error_t openapiProtectedPortNextGroupGet(openapiClientHandle_t *client_handle, 
                                              uint32_t ifNum, uint32_t groupId, 
                                              uint32_t *NextIfNum, 
                                              uint32_t *NextGroupId);

/*************************************************************************/
open_error_t openapiProtectedPortGroupIntfAdd(openapiClientHandle_t *client_handle, 
                                              uint32_t ifNum, uint32_t groupId);

/*************************************************************************/
open_error_t openapiProtectedPortGroupIntfDelete(openapiClientHandle_t *client_handle, 
                                                 uint32_t ifNum, uint32_t groupId);


#endif /* OPENAPI_PROTECTEDPORT_H_INCLUDED */