getIpRanges()

SubscriptionIpRanges getIpRanges(string usn)

This method retrieves all IP addresses reserved from IP number pools, as well as those not managed by a pool reservation, for a given subscription.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription for which to retrieve IP range reservations.

Results

This method returns a SubscriptionIpRanges XML document containing a list of the IP address reservations for the given subscription. If the subscription has no reservations, an empty list will be returned.

There are no messages defined by this method.

Example: A returned SubscriptionIpRanges XML document

This example shows a SubscriptionIpRanges XML document.

<SubscriptionIpRanges xmlns="http://xml.inomial.com/smile/2.xsd">
  <SubscriptionIpRange>
    <SubscriptionIpRangeId>9E291E0C-0014-4205-8568-C6AC5C979234</SubscriptionIpRangeId>
    <FromAddress>10.16.126.1</FromAddress>
    <ToAddress>10.16.126.254</ToAddress>
  </SubscriptionIpRange>
  <SubscriptionIpRange>
    <SubscriptionIpRangeId>1F9C9511-487C-4DEC-B0B9-3759ED80B0A7</SubscriptionIpRangeId>
    <FromAddress>2001:0269:77c3:15ef::1</FromAddress>
    <ToAddress>2001:0269:77c3:153f:ffff:ffff:ffff:fffe</ToAddress>
  </SubscriptionIpRange>
</SubscriptionIpRanges>

Example: A returned SubscriptionIpRanges XML document containing a range reserved from IP number pools

This example shows a SubscriptionIpRanges XML document containing a range reserved from IP number pools.

<SubscriptionIpRanges xmlns="http://xml.inomial.com/smile/2.xsd">
  <SubscriptionIpRange>
    <SubscriptionIpRangeId>61eda8bb-e573-4926-b094-899f30c3cc9a</SubscriptionIpRangeId>
    <FromAddress>127.0.0.1</FromAddress>
    <ToAddress>127.0.0.1</ToAddress>
    <PoolReservationLink>
      <LinkId>9ada796d-51aa-43f8-b123-5ed843bd2fc4</LinkId>
      <LinkType>Allocation</LinkType>
      <Reservation>
        <ReservationId>3b02ab91-813f-421a-9b31-0341285645b3</ReservationId>
        <Start>127.0.0.1</Start>
        <End>127.0.0.1</End>
      </Reservation>
    </PoolReservationLink>
  </SubscriptionIpRange>
</SubscriptionIpRanges>

Faults

NoSuchItemException

This fault is returned when the subscription does not exist.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription for which to retrieve IP range reservations.

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