voxel.ips.unassign

Unassign an IP address from a server or VM.

Parameters

device_id (required)
Numeric Voxel device id, available from voxel.devices.list
ip_address (optional)
The specific address to assign. Must be from one of the VLANs valid at the requested facility.
ip_assignment_id (optional)
The id of an IP assignment.

Example Response

<rsp stat="ok"/>

Notes

Generally, either one of ip_assignment_id or ip_address should be specified. An ip_assignment_id is available from the output of voxel.devices.list at any time, or voxel.ips.assign when the assignment is first made. The ip_address parameter may be a single IP address (e.g., 10.0.0.1); or a CIDR-format IP address range (e.g., 10.0.0.0/31), in which case any addresses within the range will be unassigned (e.g., if ip_address=10.0.0.0/31 then 10.0.0.1 will be unassigned but 10.0.0.4 will not). If neither ip_address nor ip_assignment_id is specified, all IP assignments will be removed from the specified device.

Method Specific Error Codes

100: Unknown device
The device_id passed in can't be matched to a valid device.