4.2 Creating an Address Range

  • Article

The following request and response messages specify an example exchange for creating a static address range 192.168.1.0/24.

  
 <s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">  <s:Header>    <a:Action s:mustUnderstand="1">http://Microsoft.Windows.Ipam/IIpamServer/SaveRange</a:Action>    <a:MessageID>urn:uuid:d1b717e7-2527-4c6a-a802-c3c9fc6b786e</a:MessageID>    <a:ReplyTo>      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>    </a:ReplyTo>  </s:Header>  <s:Body>    <SaveRange xmlns="http://Microsoft.Windows.Ipam">      <range xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" i:type="IPv4Range" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">        <ModifiedProperties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">          <d5p1:string>SubnetId</d5p1:string>          <d5p1:string>StartIPAddress</d5p1:string>          <d5p1:string>EndIPAddress</d5p1:string>          <d5p1:string>PrefixLength</d5p1:string>          <d5p1:string>CustomFieldValues</d5p1:string>          <d5p1:string>UtilizationStatistics</d5p1:string>        </ModifiedProperties>        <SetProperties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">          <d5p1:string>AddressAssignment</d5p1:string>          <d5p1:string>UtilizationCalculationType</d5p1:string>          <d5p1:string>SubnetId</d5p1:string>          <d5p1:string>StartIPAddress</d5p1:string>          <d5p1:string>EndIPAddress</d5p1:string>          <d5p1:string>PrefixLength</d5p1:string>          <d5p1:string>CustomFieldValues</d5p1:string>          <d5p1:string>UtilizationStatistics</d5p1:string>        </SetProperties>        <AddressAssignment>Static</AddressAssignment>        <AddressCategory>Private</AddressCategory>        <CustomFieldValues>          <CustomFieldValue z:Id="i2">            <ModifiedProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />            <SetProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />            <BuiltInCustomFieldValueId>0</BuiltInCustomFieldValueId>            <ParentCustomFieldName>Region</ParentCustomFieldName>            <ParentCustomFieldNumber>2</ParentCustomFieldNumber>            <ParentCustomFieldRecordId>2</ParentCustomFieldRecordId>            <RecordId i:nil="true" />            <Value>Asia</Value>          </CustomFieldValue>          <CustomFieldValue z:Id="i3">            <ModifiedProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">              <d7p1:string>ParentCustomFieldRecordId</d7p1:string>              <d7p1:string>ParentCustomFieldName</d7p1:string>              <d7p1:string>ParentCustomFieldNumber</d7p1:string>              <d7p1:string>Value</d7p1:string>            </ModifiedProperties>            <SetProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">              <d7p1:string>ParentCustomFieldRecordId</d7p1:string>              <d7p1:string>ParentCustomFieldName</d7p1:string>              <d7p1:string>ParentCustomFieldNumber</d7p1:string>              <d7p1:string>Value</d7p1:string>            </SetProperties>            <BuiltInCustomFieldValueId>1</BuiltInCustomFieldValueId>            <ParentCustomFieldName>Managed by Service</ParentCustomFieldName>            <ParentCustomFieldNumber>8</ParentCustomFieldNumber>            <ParentCustomFieldRecordId>8</ParentCustomFieldRecordId>            <RecordId>298</RecordId>            <Value>IPAM</Value>          </CustomFieldValue>          <CustomFieldValue z:Id="i4">            <ModifiedProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">              <d7p1:string>ParentCustomFieldRecordId</d7p1:string>              <d7p1:string>ParentCustomFieldName</d7p1:string>              <d7p1:string>ParentCustomFieldNumber</d7p1:string>              <d7p1:string>Value</d7p1:string>            </ModifiedProperties>            <SetProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">              <d7p1:string>ParentCustomFieldRecordId</d7p1:string>              <d7p1:string>ParentCustomFieldName</d7p1:string>              <d7p1:string>ParentCustomFieldNumber</d7p1:string>              <d7p1:string>Value</d7p1:string>            </SetProperties>            <BuiltInCustomFieldValueId>1</BuiltInCustomFieldValueId>            <ParentCustomFieldName>Service Instance</ParentCustomFieldName>            <ParentCustomFieldNumber>9</ParentCustomFieldNumber>            <ParentCustomFieldRecordId>9</ParentCustomFieldRecordId>            <RecordId>303</RecordId>            <Value>Localhost</Value>          </CustomFieldValue>        </CustomFieldValues>        <DefaultGateway xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Net" i:nil="true" />        <Description i:nil="true" />        <DhcpScopeName i:nil="true" />        <DhcpServerGuid i:nil="true" />        <DhcpServerName i:nil="true" />        <EndIPAddress xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Net">          <d5p1:m_Address>4261521600</d5p1:m_Address>          <d5p1:m_Family>InterNetwork</d5p1:m_Family>          <d5p1:m_HashCode>0</d5p1:m_HashCode>          <d5p1:m_Numbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>          </d5p1:m_Numbers>          <d5p1:m_ScopeId>0</d5p1:m_ScopeId>        </EndIPAddress>        <ExclusionRanges />        <IsOverlapping>false</IsOverlapping>        <LastAssignedDate i:nil="true" />        <LastChangeDate i:nil="true" />        <LastReclaimRuntime i:nil="true" />        <NumberOfChildAddresses>0</NumberOfChildAddresses>        <Owner i:nil="true" />        <ParentIPBlockRecordId i:nil="true" />        <PartialCustomFieldValues />        <PrefixLength>24</PrefixLength>        <RecordId i:nil="true" />        <ScopeRecordId i:nil="true" />        <StartIPAddress xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Net">          <d5p1:m_Address>16885952</d5p1:m_Address>          <d5p1:m_Family>InterNetwork</d5p1:m_Family>          <d5p1:m_HashCode>0</d5p1:m_HashCode>          <d5p1:m_Numbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>          </d5p1:m_Numbers>          <d5p1:m_ScopeId>0</d5p1:m_ScopeId>        </StartIPAddress>        <SubnetId xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Net">          <d5p1:m_Address>108736</d5p1:m_Address>          <d5p1:m_Family>InterNetwork</d5p1:m_Family>          <d5p1:m_HashCode>0</d5p1:m_HashCode>          <d5p1:m_Numbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>          </d5p1:m_Numbers>          <d5p1:m_ScopeId>0</d5p1:m_ScopeId>        </SubnetId>        <SubnetMask xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Net">          <d5p1:m_Address>16777215</d5p1:m_Address>          <d5p1:m_Family>InterNetwork</d5p1:m_Family>          <d5p1:m_HashCode>0</d5p1:m_HashCode>          <d5p1:m_Numbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>            <d6p1:unsignedShort>0</d6p1:unsignedShort>          </d5p1:m_Numbers>          <d5p1:m_ScopeId>0</d5p1:m_ScopeId>        </SubnetMask>        <UtilizationCalculationType>Auto</UtilizationCalculationType>        <UtilizationEventLogStatus>None</UtilizationEventLogStatus>        <UtilizationStatistics i:nil="true" />      </range>    </SaveRange>  </s:Body></s:Envelope>
 

The following is a sample response message for the above request returning the record identifier of the newly created range instance.

 <s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">  <s:Header>    <a:Action s:mustUnderstand="1">http://Microsoft.Windows.Ipam/IIpamServer/SaveRangeResponse</a:Action>    <a:RelatesTo>urn:uuid:d1b717e7-2527-4c6a-a802-c3c9fc6b786e</a:RelatesTo>    <a:To s:mustUnderstand="1">http://www.w3.org/2005/08/addressing/anonymous</a:To>  </s:Header>  <s:Body>    <SaveRangeResponse xmlns="http://Microsoft.Windows.Ipam">      <SaveRangeResult>451</SaveRangeResult>    </SaveRangeResponse>  </s:Body></s:Envelope>