Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
Cloud Managed Configuration And Status [OPENAPI_CLOUD_MANAGED]

Macros

#define OPENAPI_CLOUD_MANAGED_PASSWORD_DECRYPTED_LEN_MAX   65
 
#define OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX   129
 
#define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MAX   65535
 
#define OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MIN   1
 
#define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX   151
 
#define OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MIN   11
 
#define OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX   65
 

Functions

open_error_t openapiCloudManagedModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
 Get Cloud Managed Administrative Mode. More...
 
open_error_t openapiCloudManagedModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
 Set Cloud Managed Administrative Mode. More...
 
open_error_t openapiCloudManagedOperModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
 Get Cloud Managed operational Mode. More...
 
open_error_t openapiCloudManagedOperModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
 Set Cloud Managed operational Mode. More...
 
open_error_t openapiCloudManagedProxyIpGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, uint32_t *portNum)
 Get Cloud Managed Proxy Server IP Address. More...
 
open_error_t openapiCloudManagedProxyIpSet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, uint32_t portNum)
 Set Cloud Managed Proxy Server IP Address. More...
 
open_error_t openapiCloudManagedProxyUserGet (openapiClientHandle_t *client_handle, open_buffdesc *userName, OPEN_PASSWORD_ENCRYPT_ALG_t *encryptType, open_buffdesc *password)
 Get Cloud Managed Proxy Server User Credentials. More...
 
open_error_t openapiCloudManagedProxyUserSet (openapiClientHandle_t *client_handle, open_buffdesc *userName, OPEN_PASSWORD_ENCRYPT_ALG_t encryptType, open_buffdesc *password)
 Set Cloud Managed Proxy Server User Credentials. More...
 
open_error_t openapiCloudManagedServerUrlGet (openapiClientHandle_t *client_handle, open_buffdesc *url)
 Get Cloud Managed Server URL. More...
 
open_error_t openapiCloudManagedServerUrlSet (openapiClientHandle_t *client_handle, open_buffdesc *url)
 Set Cloud Managed Server URL. More...
 

Detailed Description

Function Documentation

open_error_t openapiCloudManagedModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t mode 
)

Get Cloud Managed Administrative Mode.

Parameters
[in]client_handleClient handle from registration API
[out]modeAdministrative Mode
Return values
OPEN_E_NONEGet Operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORValid mode cannot be retrieved.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  mode 
)

Set Cloud Managed Administrative Mode.

Parameters
[in]client_handleClient handle from registration API
[in]modeAdministrative Mode
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORMode cannot be set.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedOperModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t mode 
)

Get Cloud Managed operational Mode.

Parameters
[in]client_handleClient handle from registration API
[out]modeOperational Mode
Return values
OPEN_E_NONEGet Operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORValid mode cannot be retrieved.

OpEN API Version: 1.19

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedOperModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  mode 
)

Set Cloud Managed operational Mode.

Parameters
[in]client_handleClient handle from registration API
[in]modeOperational Mode
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORMode cannot be set.

OpEN API Version: 1.19

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedProxyIpGet ( openapiClientHandle_t client_handle,
open_inet_addr_t ipAddr,
uint32_t *  portNum 
)

Get Cloud Managed Proxy Server IP Address.

Parameters
[in]client_handleClient handle from registration API
[out]ipAddrProxy Server IPv4 or IPv6 address.
[out]portNumPort number
Return values
OPEN_E_NONEGet Operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORThe server IP address cannot be retrieved.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedProxyIpSet ( openapiClientHandle_t client_handle,
open_inet_addr_t ipAddr,
uint32_t  portNum 
)

Set Cloud Managed Proxy Server IP Address.

Parameters
[in]client_handleClient handle from registration API
[in]ipAddrProxy Server IPv4 or IPv6 address.
[in]portNumPort number
-Minimum value OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MIN
-Maximum value OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MAX
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORThe server IP address cannot be set with the values specified.
Note
To set the port number to its default, pass in a value of 0.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedProxyUserGet ( openapiClientHandle_t client_handle,
open_buffdesc userName,
OPEN_PASSWORD_ENCRYPT_ALG_t encryptType,
open_buffdesc password 
)

Get Cloud Managed Proxy Server User Credentials.

Parameters
[in]client_handleClient handle from registration API
[out]userNameUser Name
-Minimum buffer size OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX
[out]encryptTypePassword Encryption Type
-OPEN_PASSWORD_ENCRYPT_ALG_t
[out]passwordUser Password
-Minimum buffer size OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX
Return values
OPEN_E_NONEGet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORThe used credentials cannot be retrieved.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedProxyUserSet ( openapiClientHandle_t client_handle,
open_buffdesc userName,
OPEN_PASSWORD_ENCRYPT_ALG_t  encryptType,
open_buffdesc password 
)

Set Cloud Managed Proxy Server User Credentials.

Parameters
[in]client_handleClient handle from registration API
[in]userNameUser Name
-Maximum length (OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX - 1)
[in]encryptTypePassword Encryption Type
-OPEN_PASSWORD_ENCRYPT_ALG_t
[in]passwordUser Password
-Maximum length unencrypted (OPENAPI_CLOUD_MANAGED_PASSWORD_DECRYPTED_LEN_MAX - 1)
-Maximum length encrypted (OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX - 1)
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERROREither the User Name, Password, or Encryption type cannot be set.
Note
Supports encryptType values OPEN_PASSWORD_ENCRYPT_NONE or OPEN_PASSWORD_ENCRYPT_AES only. If an unencrypted password is provided, this API encrypts it using AES prior to setting it in the device. An exception is allowed when setting an unencrypted empty string to clear out the password.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedServerUrlGet ( openapiClientHandle_t client_handle,
open_buffdesc url 
)

Get Cloud Managed Server URL.

Parameters
[in]client_handleClient handle from registration API
[out]urlServer URL string
-Minimum buffer size OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORThe server URL string could not be retrieved.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.
open_error_t openapiCloudManagedServerUrlSet ( openapiClientHandle_t client_handle,
open_buffdesc url 
)

Set Cloud Managed Server URL.

Parameters
[in]client_handleClient handle from registration API
[in]urlServer URL string (including null termination)
-Minimum length (OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MIN - 1)
-Maximum length (OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX - 1)
Return values
OPEN_E_NONESet operation is successful.
OPEN_E_PARAMInvalid parameter is supplied.
OPEN_E_ERRORThe server URL string could not be set.
Note
As a special case, an empty server URL string is allowed since that is used to clear out the URL value from the switch.

OpEN API Version: 1.8

Examples:
cloud_managed_example.c.