removePoolReservationLink()

PoolReservationLink removePoolReservationLink(string usn, string reservationLinkId)

This method removes a reservation link applied to a subscription.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription from which to remove the reservation link.
reservationLinkId: Format: string; Purpose: Specifies the value representing the pool reservation link to remove from the subscription.

Results

This method returns a PoolReservationLink XML document containing a Quarantine link type if a reservation is removed. Otherwise an empty result is returned.

Smile emits the SubscriptionIpRangesUpdated message after the subscription is updated.

Example: A returned PoolReservationLink XML document

This example shows a returned PoolReservationLink XML document specifying that the pool reservation is quarantined.

<PoolReservationLink xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <LinkId>d8ef89fa-f53d-4b8e-8775-3a7227da063b</LinkId>
  <LinkType>Quarantine</LinkType>
  <Reservation>
    <ReservationId>0cc6b0e8-3c20-4606-8085-69c94170f0c3</ReservationId>
    <Start>10000100</Start>
    <End>10000199</End>
  </Reservation>
  <Expiry>2014-05-30T18:01:52.332+10:00</Expiry>
</PoolReservationLink>

Faults

NoSuchItemException

This fault is returned when the subscription or reservationLinkId does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.RemovePoolReservationLink usn
 reservationLinkId

usn: Purpose: Specifies the USN of the subscription from which to remove the reservation link.
reservationLinkId: Purpose: Specifies the value representing the pool reservation link to remove from the subscription.

Note: For more information about the Java client and the options it accepts, see Java client syntax.