Cisco Cisco Prime Network Registrar 8.1 Technical References
ImportChildBlock
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide
165
ImportChildBlock
Overview
The
ImportChildBlock
API enables the web service client to import child blocks into
Cisco Prime Network Registrar IPAM. This API is used to define sub-allocations of
address space, taken from parent address space. This space is allocated from the parent,
and then marked with the status that is specified in the request. The name of the block
allocated is returned to the client application in the response.
Request and Response Messages
Below is the portion of
Imports.wsdl that describes the
importChildBlock
request and
response messages.
<wsdl:message name="importChildBlockResponse">
<wsdl:part name="importChildBlockReturn" type="soapenc:string" />
</wsdl:message>
<wsdl:message name="importChildBlockRequest">
<wsdl:part name="inpChildBlock" type="tns1:WSChildBlock" />
<wsdl:part name="inpBlockPolicy" type="tns1:WSSubnetPolicy" />
</wsdl:message>
<wsdl:part name="importChildBlockReturn" type="soapenc:string" />
</wsdl:message>
<wsdl:message name="importChildBlockRequest">
<wsdl:part name="inpChildBlock" type="tns1:WSChildBlock" />
<wsdl:part name="inpBlockPolicy" type="tns1:WSSubnetPolicy" />
</wsdl:message>
Response
The string returned in the response contains the name of the block allocated, for example,
10.0.0.128/28
.
Request
The complex types
WSChildBlock
and
WSSubnetPolicy
, which are passed as input
from the client to the web service, are described in the next section.
Parameters
WSChildBlock
Below is the portion of
Imports.wsdl that describes
WSChildBlock
, the first parameter
structure passed to
importChildBlock
. The elements are described in the table that
follows.
<complexType name="WSChildBlock">
<sequence>
<element name="SWIPname" nillable="true" type="xsd:string" />
<element name="allocationReason" nillable="true" type="xsd:string" />
<element name="allocationReasonDescription" nillable="true" type="xsd:string" />
<element name="allocationTemplate" nillable="true" type="xsd:string" />
<element name="blockAddr" nillable="true" type="xsd:string" />
<element name="blockName" nillable="true" type="xsd:string" />
<element name="blockSize" nillable="true" type="xsd:string" />
<element name="blockStatus" nillable="true" type="xsd:string" />
<element name="blockType" nillable="true" type="xsd:string" />
<element name="container" nillable="true" type="xsd:string" />
<element name="createReverseDomains" nillable="true" type="xsd:string" />
<element name="description" nillable="true" type="xsd:string" />
<element name="domainType" nillable="true" type="xsd:string" />
<element name="interfaceAddress" nillable="true" type="xsd:string" />
<element name="interfaceName" nillable="true" type="xsd:string" />
<element name="ipv6" type="xsd:boolean"/>
<element name="userDefinedFields" nillable="true" type="impl:ArrayOf_xsd_string" />
<sequence>
<element name="SWIPname" nillable="true" type="xsd:string" />
<element name="allocationReason" nillable="true" type="xsd:string" />
<element name="allocationReasonDescription" nillable="true" type="xsd:string" />
<element name="allocationTemplate" nillable="true" type="xsd:string" />
<element name="blockAddr" nillable="true" type="xsd:string" />
<element name="blockName" nillable="true" type="xsd:string" />
<element name="blockSize" nillable="true" type="xsd:string" />
<element name="blockStatus" nillable="true" type="xsd:string" />
<element name="blockType" nillable="true" type="xsd:string" />
<element name="container" nillable="true" type="xsd:string" />
<element name="createReverseDomains" nillable="true" type="xsd:string" />
<element name="description" nillable="true" type="xsd:string" />
<element name="domainType" nillable="true" type="xsd:string" />
<element name="interfaceAddress" nillable="true" type="xsd:string" />
<element name="interfaceName" nillable="true" type="xsd:string" />
<element name="ipv6" type="xsd:boolean"/>
<element name="userDefinedFields" nillable="true" type="impl:ArrayOf_xsd_string" />