Cisco Cisco Prime Network Registrar 8.1 Technical References
ExportDeviceResourceRecord
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide
258
ExportDeviceResourceRecord
Overview
The
exportDeviceResourceRecord
API enables the web service client to issue a
request to retrieve a list of resource records for a device or list of devices from Cisco
Prime Network Registrar IPAM. This service enables the client to filter the list of resource
records retrieved by device.
Initialization
Before the
exportDeviceResourceRecord
API is called, the web service client
must
call
initExportDeviceResourceRec
to initialize the API. The portion of
Exports.wsdl that describes the
initExportDeviceResourceRec
request and response
messages is shown following.
<wsdl:message name="initExportDeviceResourceRecRequest">
<wsdl:part name="filter" type="soapenc:string"/>
<wsdl:part name="options" type="impl:ArrayOf_soapenc_string"/>
</wsdl:message>
<wsdl:message name="initExportDeviceResourceRecResponse">
<wsdl:part name="initExportDeviceResourceRecReturn" type="tns2:WSContext"/>
</wsdl:message>
<wsdl:part name="filter" type="soapenc:string"/>
<wsdl:part name="options" type="impl:ArrayOf_soapenc_string"/>
</wsdl:message>
<wsdl:message name="initExportDeviceResourceRecResponse">
<wsdl:part name="initExportDeviceResourceRecReturn" type="tns2:WSContext"/>
</wsdl:message>
Request
The query string is passed as input from the client to the
initExportDeviceResourceRec
web service in the filter parameter. The query
string syntax is defined previously. Supported selectors for exporting device resource
records by device are defined in the following table.
In addition, the
In addition, the
initExportDeviceResourceRec
service accepts an option that
specifies that recursively all devices within all child containers specified within the
Container Selector filter should be selected. Specify the option parameter as
recurseContainerHierarchy
.
Selector
Description
Example
Name
Select device by hostname.
Name=’host;
Name ends ‘ost’
Name begins ‘hos’
Name contains ‘os’
Name ends ‘ost’
Name begins ‘hos’
Name contains ‘os’
Container
Select device by Container name.
Container=’Exton’;
Container ends ‘ton’
Container begins ‘Ext
Container contains ‘xto’
Container ends ‘ton’
Container begins ‘Ext
Container contains ‘xto’
IP Address
Select device by IP Address.
Note, this filter should not be used on a
Note, this filter should not be used on a
multi-homed device, unless the desired
result is to export the device with
only
the IP Address specified in the Selector
filter. Instead, use IPAddressRange,
Name, or multiple IPAddress (separated
IPAddress=10.0.0.1