SubscriptionIpRangesUpdated
Smile emits this message when the IP addresses associated with the subscription change. In
particular when one of the following occurs:
- addIpRange(), addIpRangeReservation(), removeIpRange() or removePoolReservationLink() is called
- a pool reservation is removed when Smile receives a LinkDeallocation message
- all reservation links are removed when Smile receives a SubscriptionClosed message
- a pool reservation link is removed
Message header
The following table lists the parameters in the SubscriptionIpRangesUpdated message header.
Parameter | Type | Values |
---|---|---|
sid | integer | The service ID |
usn | string | The unique subscription ID number for the subscription |
smileMessageType | string | "SubscriptionIpRangesUpdated" |
Message body
The message body contains the <SubscriptionIpRangesUpdated> element
and has the following format:
{http://xml.inomial.com/smile/2.xsd}SubscriptionIpRangesUpdated
Example: The <SubscriptionIpRangesUpdated> element
This example shows a SubscriptionIpRangesUpdated XML document for a subscription that has 4 ranges of IP addresses allocated to it: one from an IP Pool reservation, one IPv6 range, and 2 IPv4 ranges that are not managed by an IP Pool.
<SubscriptionIpRangesUpdated xmlns="http://xml.inomial.com/smile/2.xsd">
<Subscription>
<USN>2142425772</USN>
<SID>725</SID>
<ServiceName>Test service 725</ServiceName>
<Parent>2142425764</Parent>
<Properties>
<Object>
<String name="abn"/>
<String name="billAddress"/>
<String name="billBuildingName"/>
<String name="billCountry"/>
<String name="billFloorNumber"/>
<String name="billLotNumber"/>
<String name="billName"/>
<String name="billNumber"/>
<String name="billPostCode"/>
<String name="billPostalDeliveryType"/>
<String name="billState"/>
<String name="billSubUnit"/>
<String name="billSuburb"/>
<String name="billType"/>
<String name="comments"/>
<String name="companyPosition"/>
<String name="contactFamily"/>
<String name="contactGiven"/>
<String name="contactTitle"/>
<String name="emailAddress"/>
<String name="fax"/>
<String name="homePhone"/>
<String name="jabberAddress"/>
<String name="mobilePhone"/>
<String name="name"/>
<String name="secretAnswer"/>
<String name="secretQuestion"/>
<String name="sex"/>
<String name="streetAddress"/>
<String name="streetBuildingName"/>
<String name="streetCountry"/>
<String name="streetFloorNumber"/>
<String name="streetLotNumber"/>
<String name="streetName"/>
<String name="streetNumber"/>
<String name="streetPostalDeliveryType"/>
<String name="streetPostcode"/>
<String name="streetState"/>
<String name="streetSubUnit"/>
<String name="streetSuburb"/>
<String name="streetType"/>
<String name="tradingName"/>
<String name="workPhone"/>
<String name="username">test1422428588258@example.com</String>
<String name="description"/>
<String name="filterId"/>
<String name="framedInterfaceId"/>
<String name="framedIpAddress"/>
<String name="framedIpNetmask"/>
<String name="framedIpv6Pool"/>
<String name="framedIpv6Route"/>
<String name="framedNetworkPrefix"/>
<String name="framedRoute"/>
<Integer name="preferredHomeContactTime"/>
<Integer name="preferredMobileContactTime"/>
<Integer name="preferredWorkContactTime"/>
<Integer name="framedProtocol"/>
<Integer name="radiusServiceType"/>
<Boolean name="billPrintName">false</Boolean>
<Boolean name="streetPrintName">true</Boolean>
<Timestamp name="dob"/>
</Object>
</Properties>
<ProvisionStatus>Provisioned</ProvisionStatus>
<SuspendStatus>Active</SuspendStatus>
<ActivateStatus>Activated</ActivateStatus>
<EnableStatus>Enabled</EnableStatus>
<InvoicingCycle>
<CycleType>Anniversary</CycleType>
<CycleDay>31</CycleDay>
</InvoicingCycle>
<RatingCycle>
<CycleType>Anniversary</CycleType>
<CycleDay>31</CycleDay>
</RatingCycle>
<Timezone key="13">Australia/Melbourne</Timezone>
<Company key="1">Example Internet</Company>
</Subscription>
<IPRanges>
<SubscriptionIpRange>
<SubscriptionIpRangeId>46799d37-4fde-4fb0-8450-060dd64b5666</SubscriptionIpRangeId>
<FromAddress>127.0.0.6</FromAddress>
<ToAddress>127.0.0.10</ToAddress>
<PoolReservationLink>
<LinkId>3bcb7026-6143-4507-88da-3bf656d3a9fe</LinkId>
<LinkType>Allocation</LinkType>
<Reservation>
<ReservationId>dc82d419-5ffd-4bcf-9b73-4b59957d1590</ReservationId>
<Start>127.0.0.6</Start>
<End>127.0.0.10</End>
</Reservation>
</PoolReservationLink>
</SubscriptionIpRange>
<SubscriptionIpRange>
<SubscriptionIpRangeId>f186f259-cbe9-4bb9-b806-991795438c07</SubscriptionIpRangeId>
<FromAddress>abcd:1234:0:0:0:0:0:1</FromAddress>
<ToAddress>abcd:1234:0:0:0:0:0:2</ToAddress>
</SubscriptionIpRange>
<SubscriptionIpRange>
<SubscriptionIpRangeId>d9f38e4c-8589-413f-84ab-f5b721150353</SubscriptionIpRangeId>
<FromAddress>127.1.1.15</FromAddress>
<ToAddress>127.1.1.16</ToAddress>
</SubscriptionIpRange>
<SubscriptionIpRange>
<SubscriptionIpRangeId>9d11ff6e-f26e-4713-8355-e6cf786a5612</SubscriptionIpRangeId>
<FromAddress>127.1.1.17</FromAddress>
<ToAddress>127.1.1.19</ToAddress>
</SubscriptionIpRange>
</IPRanges>
</SubscriptionIpRangesUpdated>