Skip to main content
Element Software

TestAddressAvailability

Contributors netapp-pcarriga
PDFs

You can use the TestAddressAvailability method to check to see if a certain IP address is in use on an interface within the storage cluster.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

interface

The target network interface (such as eth0, Bond10G, etc).

string

None

Yes

address

The IP address to scan for on the target interface.

string

None

Yes

virtualNetworkTag

The target VLAN ID.

integer

None

No

timeout

The timeout in seconds for testing the target address.

integer

5

No

Return values

This method has the following return values:

Name

Description

Type

address

The IP address tested.

string

available

True if the requested IP address is in use, and false if it is not.

boolean

Request example

Requests for this method are similar to the following example:

{
	"method": "TestAddressAvailability",
	"params": {
		"interface": "Bond10G",
		"address": "10.0.0.1",
		"virtualNetworkTag": 1234
	}
}

Response example

This method returns a response similar to the following example:

{
	"id": 1,
	"result": {
		"address":"10.0.0.1",
		"available": true
	}
}

New since version

11.0