Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_cloud_managed.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2019 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_cloud_managed.h
28 *
29 * @purpose Cloud Managed Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 12/01/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_CLOUD_MANAGED_H_INCLUDED
39 #define OPENAPI_CLOUD_MANAGED_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPENAPI_CLOUD_MANAGED_PASSWORD_DECRYPTED_LEN_MAX 65
44 #define OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX 129
45 #define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MAX 65535
46 #define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MIN 1
47 #define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX 151
48 #define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MIN 11
49 #define OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX 65
50 
51 /*****************************************************************/
65 open_error_t openapiCloudManagedModeGet(openapiClientHandle_t *client_handle,
66  OPEN_CONTROL_t *mode);
67 
68 /*****************************************************************/
82 open_error_t openapiCloudManagedModeSet(openapiClientHandle_t *client_handle,
83  OPEN_CONTROL_t mode);
84 
85 /*****************************************************************/
100 open_error_t openapiCloudManagedProxyIpGet(openapiClientHandle_t *client_handle,
101  open_inet_addr_t *ipAddr,
102  uint32_t *portNum);
103 
104 /*****************************************************************/
124 open_error_t openapiCloudManagedProxyIpSet(openapiClientHandle_t *client_handle,
125  open_inet_addr_t *ipAddr,
126  uint32_t portNum);
127 
128 /*****************************************************************/
147 open_error_t openapiCloudManagedProxyUserGet(openapiClientHandle_t *client_handle,
148  open_buffdesc *userName,
149  OPEN_PASSWORD_ENCRYPT_ALG_t *encryptType,
150  open_buffdesc *password);
151 
152 /*****************************************************************/
177 open_error_t openapiCloudManagedProxyUserSet(openapiClientHandle_t *client_handle,
178  open_buffdesc *userName,
179  OPEN_PASSWORD_ENCRYPT_ALG_t encryptType,
180  open_buffdesc *password);
181 
182 /*****************************************************************/
198 open_error_t openapiCloudManagedServerUrlGet(openapiClientHandle_t *client_handle,
199  open_buffdesc *url);
200 
201 /*****************************************************************/
220 open_error_t openapiCloudManagedServerUrlSet(openapiClientHandle_t *client_handle,
221  open_buffdesc *url);
222 
223 /*****************************************************************/
237 open_error_t openapiCloudManagedOperModeGet(openapiClientHandle_t *client_handle,
238  OPEN_CONTROL_t *mode);
239 
240 /*****************************************************************/
254 open_error_t openapiCloudManagedOperModeSet(openapiClientHandle_t *client_handle,
255  OPEN_CONTROL_t mode);
256 
257 #endif /* OPENAPI_CLOUD_MANAGED_H_INCLUDED */
258