Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
open_error_t openapiCloudManagedModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get Cloud Managed Administrative Mode.
[in] | client_handle | Client handle from registration API |
[out] | mode | Administrative Mode |
OPEN_E_NONE | Get Operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | Valid mode cannot be retrieved. |
OpEN API Version: 1.8
open_error_t openapiCloudManagedModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set Cloud Managed Administrative Mode.
[in] | client_handle | Client handle from registration API |
[in] | mode | Administrative Mode |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | Mode cannot be set. |
OpEN API Version: 1.8
open_error_t openapiCloudManagedOperModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get Cloud Managed operational Mode.
[in] | client_handle | Client handle from registration API |
[out] | mode | Operational Mode |
OPEN_E_NONE | Get Operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | Valid mode cannot be retrieved. |
OpEN API Version: 1.19
open_error_t openapiCloudManagedOperModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set Cloud Managed operational Mode.
[in] | client_handle | Client handle from registration API |
[in] | mode | Operational Mode |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | Mode cannot be set. |
OpEN API Version: 1.19
open_error_t openapiCloudManagedProxyIpGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | ipAddr, | ||
uint32_t * | portNum | ||
) |
Get Cloud Managed Proxy Server IP Address.
[in] | client_handle | Client handle from registration API |
[out] | ipAddr | Proxy Server IPv4 or IPv6 address. |
[out] | portNum | Port number |
OPEN_E_NONE | Get Operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | The server IP address cannot be retrieved. |
OpEN API Version: 1.8
open_error_t openapiCloudManagedProxyIpSet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | ipAddr, | ||
uint32_t | portNum | ||
) |
Set Cloud Managed Proxy Server IP Address.
[in] | client_handle | Client handle from registration API |
[in] | ipAddr | Proxy Server IPv4 or IPv6 address. |
[in] | portNum | Port number |
- | Minimum value OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MIN | |
- | Maximum value OPENAPI_CLOUD_MANAGED_PROXY_PORTNUM_MAX |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | The server IP address cannot be set with the values specified. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[out] | userName | User Name |
- | Minimum buffer size OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX | |
[out] | encryptType | Password Encryption Type |
- | OPEN_PASSWORD_ENCRYPT_ALG_t | |
[out] | password | User Password |
- | Minimum buffer size OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX |
OPEN_E_NONE | Get operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | The used credentials cannot be retrieved. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | userName | User Name |
- | Maximum length (OPENAPI_CLOUD_MANAGED_USERNAME_LEN_MAX - 1) | |
[in] | encryptType | Password Encryption Type |
- | OPEN_PASSWORD_ENCRYPT_ALG_t | |
[in] | password | User Password |
- | Maximum length unencrypted (OPENAPI_CLOUD_MANAGED_PASSWORD_DECRYPTED_LEN_MAX - 1) | |
- | Maximum length encrypted (OPENAPI_CLOUD_MANAGED_PASSWORD_ENCRYPTED_LEN_MAX - 1) |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | Either the User Name, Password, or Encryption type cannot be set. |
OpEN API Version: 1.8
open_error_t openapiCloudManagedServerUrlGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | url | ||
) |
Get Cloud Managed Server URL.
[in] | client_handle | Client handle from registration API |
[out] | url | Server URL string |
- | Minimum buffer size OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | The server URL string could not be retrieved. |
OpEN API Version: 1.8
open_error_t openapiCloudManagedServerUrlSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | url | ||
) |
Set Cloud Managed Server URL.
[in] | client_handle | Client handle from registration API |
[in] | url | Server 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) |
OPEN_E_NONE | Set operation is successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | The server URL string could not be set. |
OpEN API Version: 1.8