Cloud Managed Configuration And Status [OPENAPI_CLOUD_MANAGED]

Functions
open_error_t	openapiCloudManagedModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Get Cloud Managed Administrative Mode.
open_error_t	openapiCloudManagedModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set Cloud Managed Administrative Mode.
open_error_t	openapiCloudManagedProxyIpGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, uint32_t *portNum)
	Get Cloud Managed Proxy Server IP Address.
open_error_t	openapiCloudManagedProxyIpSet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, uint32_t portNum)
	Set Cloud Managed Proxy Server IP Address.
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.
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.
open_error_t	openapiCloudManagedServerUrlGet (openapiClientHandle_t *client_handle, open_buffdesc *url)
	Get Cloud Managed Server URL.
open_error_t	openapiCloudManagedServerUrlSet (openapiClientHandle_t *client_handle, open_buffdesc *url)
	Set Cloud Managed Server URL.

Detailed Description

Function Documentation

open_error_t openapiCloudManagedModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Get Cloud Managed Administrative Mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	mode	Administrative Mode

Return values

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

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_handle	Client handle from registration API
[in]	mode	Administrative Mode

Return values

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

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_handle	Client handle from registration API
[out]	ipAddr	Proxy Server IPv4 or IPv6 address.
[out]	portNum	Port number

Return values

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

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_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

Return values

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.

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_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

Return values

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

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_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)

Return values

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.

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_handle	Client handle from registration API
[out]	url	Server URL string
	-	Minimum buffer size OPENAPI_CLOUD_MANAGED_SERVER_URL_LEN_MAX

Return values

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

Examples:

cloud_managed_example.c.

open_error_t openapiCloudManagedServerUrlSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	url
	)

Set Cloud Managed Server URL.

Parameters

[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)

Return values

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.

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.