reference_element_api_getclusterinterfacepreference.adoc

permalink	sidebar	keywords	summary
api/reference_element_api_getclusterinterfacepreference.html	sidebar	cluster,interface,preferences,preference,get,getting,getclusterinterfacepreference	The GetClusterInterfacePreference method enables systems integrated with storage clusters running Element software to get information about an existing cluster interface preference. This method is for internal use.

GetClusterInterfacePreference

The GetClusterInterfacePreference method enables systems integrated with storage clusters running Element software to get information about an existing cluster interface preference. This method is for internal use.

Parameters

This method has the following input parameter:

Name	Description	Type	Default value	Required
name	The name of the cluster interface preference.	string	None	Yes

Return value

This method has the following return value:

Name	Description	Type
preference	The name and value of the requested cluster interface preference.	JSON object

Request example

Requests for this method are similar to the following example:

{
	"method": "GetClusterInterfacePreference",
	"params": {
		"name": "prefname"
		},
	"id": 1
}

Response example

This method returns a response similar to the following example:

{
	"id": 1,
	"result": {
		"preference": {
			"name": "prefname",
			"value": "testvalue"
		}
	}
}

New since version

11.0