openapi_mgmttelnet.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_mgmttelnet.h
*
* @purpose   This code implements the OpEN telnet management API
*
* @component OPEN
*
* @create    02/06/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_MGMTTELNET_H_INCLUDED
#define OPENAPI_MGMTTELNET_H_INCLUDED

#include "openapi_common.h"


/*************************************************************************/
open_error_t
openapiAgentTelnetAdminModeSet(openapiClientHandle_t *client_handle,
                               OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t
openapiAgentTelnetAdminModeGet(openapiClientHandle_t *client_handle,
                               OPEN_CONTROL_t *pMode);

/*************************************************************************/
open_error_t
openapiSwDevCtrlTelnetMgmtPortNumSet(openapiClientHandle_t *client_handle,
                                     uint32_t port, OPEN_BOOL_t flag);

/*************************************************************************/
open_error_t
openapiSwDevCtrlTelnetMgmtPortNumGet(openapiClientHandle_t *client_handle,
                                     uint32_t *pPort);

/*************************************************************************/
open_error_t
openapiAgentTelnetNumSessionsSet(openapiClientHandle_t *client_handle,
                                 uint32_t maxSession);

/*************************************************************************/
open_error_t
openapiAgentTelnetNumSessionsGet(openapiClientHandle_t *client_handle,
                                 uint32_t *pSession);

/*************************************************************************/
open_error_t
openapiAgentTelnetTimeoutSet(openapiClientHandle_t *client_handle,
                             uint32_t timeout);

/*************************************************************************/
open_error_t
openapiAgentTelnetTimeoutGet(openapiClientHandle_t *client_handle,
                             uint32_t *pTimeout);

/*************************************************************************/
open_error_t
openapiAgentTelnetNewSessionsSet(openapiClientHandle_t *client_handle,
                                 OPEN_CONTROL_t state);

/*************************************************************************/
open_error_t
openapiAgentTelnetNewSessionsGet(openapiClientHandle_t *client_handle,
                                 OPEN_CONTROL_t *pState);

/*************************************************************************/
open_error_t
openapiAgentTelnetCurrentNumSessionsGet(openapiClientHandle_t *client_handle,
                                        uint32_t *pSession);
#endif /* OPENAPI_MGMTTELNET_H_INCLUDED */