winprotocoldoc.blob.core.windows.net... · web view[ms-ipamm]: ip address management (ipam)...

[MS-IPAMM]:

IP Address Management (IPAM) Management Protocol

Intellectual Property Rights Notice for Open Specifications Documentation

Technical Documentation. Microsoft publishes Open Specifications documentation (this documentation) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions.

Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation.

No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.

Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting [email protected].

Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit www.microsoft.com/trademarks.

Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.

Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it.

Revision Summary

Date

Revision History

Revision Class

Comments

3/30/2012

1.0

New

Released new document.

7/12/2012

2.0

Major

Significantly changed the technical content.

10/25/2012

2.0

None

No changes to the meaning, language, or formatting of the technical content.

1/31/2013

2.0

None


8/8/2013

3.0

Major


11/14/2013

3.0

None


2/13/2014

3.0

None


5/15/2014

3.0

None


6/30/2015

4.0

Major


10/16/2015

4.0

None


7/14/2016

4.0

None


Table of Contents

1Introduction29

1.1Glossary29

1.2References33

1.2.1Normative References33

1.2.2Informative References34

1.3Overview35

1.4Relationship to Other Protocols35

1.5Prerequisites/Preconditions36

1.6Applicability Statement36

1.7Versioning and Capability Negotiation36

1.8Vendor-Extensible Fields36

1.9Standards Assignments37

2Messages38

2.1Transport38

2.2Common Message Syntax38

2.2.1Namespaces38

2.2.2Messages39

2.2.2.1Common SOAP Fault39

2.2.2.2Keepalive39

2.2.3Elements40

2.2.4Complex Types40

2.2.4.1ActiveServerV4LogicalGroup57

2.2.4.2ActiveServerV4LogicalGroupNode57

2.2.4.3ActiveServerV6LogicalGroup58

2.2.4.4ActiveServerV6LogicalGroupNode58

2.2.4.5ArrayOfCustomFieldPartialValue58

2.2.4.6ArrayOfCustomFieldValue58

2.2.4.7ArrayOfDhcpExclusionRange59

2.2.4.8ArrayOfDhcpOption59

2.2.4.9ArrayOfDhcpOptionDefinition59

2.2.4.10ArrayOfDhcpServer59

2.2.4.11ArrayOfDhcpServerOperations59

2.2.4.12ArrayOfDhcpUserClass60

2.2.4.13ArrayOfDhcpVendorClass60

2.2.4.14ArrayOfDiscoveryConfig60

2.2.4.15ArrayOfIpamIPAddress60

2.2.4.16ArrayOfIpamObject61

2.2.4.17ArrayOfIPBlock61

2.2.4.18ArrayOfIPRange61

2.2.4.19ArrayOfIPUtilization61

2.2.4.20ArrayOfLogicalGroupField61

2.2.4.21ArrayOfLogicalGroupNode62

2.2.4.22ArrayOfScopeOperations62

2.2.4.23ArrayOfServerInfo62

2.2.4.24ArrayOfServerRole62

2.2.4.25ArrayOfTaskInfo63

2.2.4.26AuditPurgeSettings63

2.2.4.27BaseDnsServerZone63

2.2.4.28BaseDnsZone64

2.2.4.29BaseIpamObject64

2.2.4.30ConfigurationAuditEnumerationParameters65

2.2.4.31ConfigurationAuditRecord68

2.2.4.32ConflictingIPAddressFailureIpamExceptionData69

2.2.4.33ConflictingIPBlockFailureIpamExceptionData69

2.2.4.34ConflictingIPRangeFailureIpamExceptionData69

2.2.4.35CustomField70

2.2.4.36CustomFieldEnumerationParameters70

2.2.4.37CustomFieldPartialValue71

2.2.4.38CustomFieldValue71

2.2.4.39DhcpExclusionRange72

2.2.4.40DhcpExclusionRangeCollection72

2.2.4.41DhcpExclusionRangeV473

2.2.4.42DhcpExclusionRangeV673

2.2.4.43DhcpOption73

2.2.4.44DhcpOptionCollection74

2.2.4.45DhcpOptionDefinition74

2.2.4.46DhcpOptionDefinitionCollection75

2.2.4.47DhcpOptionDefinitionV475

2.2.4.48DhcpOptionDefinitionV676

2.2.4.49DhcpOptionV476

2.2.4.50DhcpOptionV676

2.2.4.51DhcpScope76

2.2.4.52DhcpScopeAllEnumerationParameters78

2.2.4.53DhcpScopeAssociatedWithVendorClassesEnumerationParameters78

2.2.4.54DhcpScopeForIpBlockEnumerationParameters79

2.2.4.55DhcpScopesByDhcpServerIdListEnumerationParameters79

2.2.4.56DhcpScopeUnmappedEnumerationParameters79

2.2.4.57DhcpScopeV480

2.2.4.58DhcpScopeV680

2.2.4.59DhcpServer81

2.2.4.60DhcpServerAllEnumerationParameters82

2.2.4.61DhcpServerByServerInfoIdsEnumerationParameters83

2.2.4.62DhcpServerV483

2.2.4.63DhcpServerV683

2.2.4.64DhcpUserClass84

2.2.4.65DhcpUserClassCollection84

2.2.4.66DhcpUserClassV485

2.2.4.67DhcpUserClassV685

2.2.4.68DhcpVendorClass85

2.2.4.69DhcpVendorClassCollection86

2.2.4.70DhcpVendorClassV486

2.2.4.71DhcpVendorClassV686

2.2.4.72DiscoveryConfig87

2.2.4.73DiscoverySubnetEnumerationParameters87

2.2.4.74DnsReverseLookupZone88

2.2.4.75DnsReverseLookupZoneEnumerationParameters89

2.2.4.76DnsServer89

2.2.4.77DnsServerByServerInfoIdsEnumerationParameters89

2.2.4.78DnsServerEnumerationParameters90

2.2.4.79DnsServerReverseZone90

2.2.4.80DnsServerReverseZoneEnumerationParameters90

2.2.4.81DnsServerZone91

2.2.4.82DnsServerZoneEnumerationParameters91

2.2.4.83DnsZone92

2.2.4.84DnsZoneEnumerationParameters92

2.2.4.85DnsZoneEvent93

2.2.4.86DnsZoneEventEnumerationParameters93

2.2.4.87EnumerationParametersBase94

2.2.4.88ipam1:IpamException94

2.2.4.89IpamAddressObject94

2.2.4.90IpamExceptionData94

2.2.4.91IpamIPAddress95

2.2.4.92IpamIPAddressAllForLogicalGroupEnumerationParameters98

2.2.4.93IpamIPAddressAllForLogicalGroupNodeEnumerationParameters99

2.2.4.94IpamIPAddressByBlockIdEnumerationParameters99

2.2.4.95IpamIPAddressByManagedByAndManagedByEntityEnumerationParameters99

2.2.4.96IpamIPAddressByRangeIdEnumerationParameters100

2.2.4.97IpamIPAddressForUnmappedRangesEnumerationParameters100

2.2.4.98IpamIPAddressGetDuplicateIPAddressesEnumerationParameters101

2.2.4.99IpamIPAddressRootAddressesEnumerationParameters101

2.2.4.100IpamIPAddressUnmappedAddressEnumerationParameters101

2.2.4.101IpamIPv4Address102

2.2.4.102IpamIPv4AddressLogicalGroup102

2.2.4.103IpamIPv4AddressLogicalGroupNode102

2.2.4.104IpamIPv6Address103

2.2.4.105IpamIPv6AddressLogicalGroup103

2.2.4.106IpamIPv6AddressLogicalGroupNode103

2.2.4.107IpamNumberOfRowsObject103

2.2.4.108IpamObject104

2.2.4.109IPAuditEnumerationParameters104

2.2.4.110IPAuditRecord105

2.2.4.111IPBlock106

2.2.4.112IPBlockChildBlockEnumerationParameters108

2.2.4.113IPBlockGetAllBlocksEnumerationParameters108

2.2.4.114IPBlockRootEnumerationParameters108

2.2.4.115IPCumulativeUtilization109

2.2.4.116IPRange109

2.2.4.117IPRangeAllForBlockEnumerationParameter111

2.2.4.118IPRangeAllForDhcpServerEnumerationParameters112

2.2.4.119IPRangeByManagedByAndManagedByEntityEnumerationParameters112

2.2.4.120IPRangeForBlockEnumerationParameters113

2.2.4.121IPRangeRootEnumerationParameters113

2.2.4.122IPRangeUnmappedEnumerationParameters113

2.2.4.123IPUtilization114

2.2.4.124IPv4Block114

2.2.4.125IPv4Range115

2.2.4.126IPv4RangeLogicalGroup115

2.2.4.127IPv4RangeLogicalGroupNode115

2.2.4.128IPv4Utilization116

2.2.4.129IPv6Block116

2.2.4.130IPv6Range116

2.2.4.131IPv6RangeLogicalGroup116

2.2.4.132IPv6RangeLogicalGroupNode117

2.2.4.133IPv6Utilization117

2.2.4.134LogicalGroup117

2.2.4.135LogicalGroupDataForLogicalGroupNodeEnumerationParameters118

2.2.4.136LogicalGroupDataForRootAlternateItemsEnumerationParameters119

2.2.4.137LogicalGroupDataUnmappedItemsEnumerationParameters119

2.2.4.138LogicalGroupField120

2.2.4.139LogicalGroupNode120

2.2.4.140LogicalGroupNodeChildrenEnumerationParameters121

2.2.4.141LogicalGroupNodeRootEnumerationParameters121

2.2.4.142LogicalGroupsEnumerationParameters121

2.2.4.143MACAddress122

2.2.4.144PropertiesCouldNotBeValidatedIpamExceptionData122

2.2.4.145serarr:ArrayOfanyType122

2.2.4.146serarr:ArrayOfKeyValueOfDnsReverseLookupZoneFilterCriteriaanyType2zwQHvQz123

2.2.4.147serarr:ArrayOfKeyValueOfDnsZoneFilterCriteriaanyType2zwQHvQz123

2.2.4.148serarr:ArrayOfKeyValueOfintanyType124

2.2.4.149serarr:ArrayOfKeyValueOflongDhcpScopem1ahUJFx124

2.2.4.150serarr:ArrayOfKeyValueOfServerInfoGetServerFilteranyType2zwQHvQz124

2.2.4.151serarr:ArrayOflong125

2.2.4.152serarr:ArrayOfstring125

2.2.4.153serarr:ArrayOfunsignedByte125

2.2.4.154serarr:ArrayOfunsignedShort125

2.2.4.155ServerInfo126

2.2.4.156ServerInfoEnumerationParameters127

2.2.4.157ServerRole127

2.2.4.158ServerRoleDc128

2.2.4.159ServerRoleDhcp129

2.2.4.160ServerRoleDhcp.Version129

2.2.4.161ServerRoleDns129

2.2.4.162ServerRoleNps130

2.2.4.163sys:Exception130

2.2.4.164sys:Version130

2.2.4.165sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpExclusionRangenTEz2bI_S130

2.2.4.166sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpOptionnTEz2bI_S131

2.2.4.167sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpOptionDefinitionnTEz2bI_S131

2.2.4.168sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpUserClassnTEz2bI_S131

2.2.4.169sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpVendorClassnTEz2bI_S132

2.2.4.170sysgen:ArrayOfKeyValuePairOflongArrayOfIPBlockm1ahUJFx132

2.2.4.171sysgen:ArrayOfKeyValuePairOflongint132

2.2.4.172sysgen:ArrayOfKeyValuePairOflongIpamExceptionmhTjmZB3132

2.2.4.173sysgen:KeyValuePairOfCollectionOperationsDhcpExclusionRangenTEz2bI_S133

2.2.4.174sysgen:KeyValuePairOfCollectionOperationsDhcpOptionnTEz2bI_S133

2.2.4.175sysgen:KeyValuePairOfCollectionOperationsDhcpOptionDefinitionnTEz2bI_S133

2.2.4.176sysgen:KeyValuePairOfCollectionOperationsDhcpUserClassnTEz2bI_S134

2.2.4.177sysgen:KeyValuePairOfCollectionOperationsDhcpVendorClassnTEz2bI_S134

2.2.4.178sysgen:KeyValuePairOflongint135

2.2.4.179sysgen:KeyValuePairOflongIpamExceptionmhTjmZB3135

2.2.4.180sysnet:ArrayOfIPAddress136

2.2.4.181sysnet:IPAddress136

2.2.4.182TaskInfo136

2.2.4.183UnmappedIpamIPAddressForLogicalGroupEnumerationParameters137

2.2.5Simple Types137

2.2.5.1ADDomainConfigurationStatus137

2.2.5.2AddressAssignment138

2.2.5.3AddressCategory138

2.2.5.4BuiltInCustomField139

2.2.5.5BuiltInLogicalGroup139

2.2.5.6CollectionOperations140

2.2.5.7CommonProperties140

2.2.5.8CustomFieldOrigin143

2.2.5.9CustomFieldType143

2.2.5.10DhcpOptionCollectionType143

2.2.5.11DhcpLeaseDurationType144

2.2.5.12DhcpDnsUpdateType144

2.2.5.13DhcpDnsNotRequestingClientsUpdateType145

2.2.5.14DhcpDnsNameProtectionStatus145

2.2.5.15DhcpDiscardDnsRecordOnLeaseDeletionStatus146

2.2.5.16DhcpAuditLoggingStatus146

2.2.5.17DhcpOptionOwnerType146

2.2.5.18DhcpOptionType147

2.2.5.19DhcpScopeStatus148

2.2.5.20DhcpReservationSyncStatus148

2.2.5.21DhcpStatelessClientInventoryStatus149

2.2.5.22DhcpServingClientsType149

2.2.5.23DhcpServerOperations149

2.2.5.24DnsReverseLookupZoneFilterCriteria150

2.2.5.25DnsSyncStatus150

2.2.5.26DnsZoneFilterCriteria151

2.2.5.27EnumerationObjectType151

2.2.5.28EventLevel153

2.2.5.29HealthStatus153

2.2.5.30IPAddressExpiryStatus154

2.2.5.31ipam1:IpamExceptionId154

2.2.5.32IpamTaskState192

2.2.5.33IpamTaskType192

2.2.5.34IPAuditEventType193

2.2.5.35IPUtilizationCalculationType194

2.2.5.36IPUtilizationType194

2.2.5.37LogicalGroupOrigin195

2.2.5.38LogicalGroupType195

2.2.5.39LogicalGroupUsers196

2.2.5.40ScopeOperations197

2.2.5.41ManagementStatus197

2.2.5.42ser:char198

2.2.5.43ser:duration198

2.2.5.44ser:guid198

2.2.5.45ServerAuditType198

2.2.5.46ServerInfoConfigRetrievalStatus199

2.2.5.47ServerInfoGetServerFilter199

2.2.5.48ServerInfoNewFlag200

2.2.5.49ServerMultipleRole200

2.2.5.50ServerRoleAuditFileAccess201

2.2.5.51ServerRoleEventViewerAccess201

2.2.5.52ServerRoleRpcAccess201

2.2.5.53ServerRoleType202

2.2.5.54ServiceRunningStatus202

2.2.5.55syssock:AddressFamily203

2.2.5.56UtilizationStatus207

2.2.5.57ZoneConfiguration208

2.2.5.58ZoneHostingDnsServerType208

2.2.6Attributes209

2.2.7Groups209

2.2.8Attribute Groups209

2.2.9Common Data Structures209

3Protocol Details210

3.1Common Server Details210

3.1.1Abstract Data Model210

3.1.1.1ADM_IPAMDataStore210

3.1.1.1.1ADM_IPRangeTable211

3.1.1.1.1.1Data Model211

3.1.1.1.1.2Procedures212

3.1.1.1.1.2.1GetIPRangeFromTable212

3.1.1.1.1.2.2GetOverlappingRanges213

3.1.1.1.1.2.3MapIPRangeToBlock214

3.1.1.1.1.2.4ResetCurrentIPRangeMapping215

3.1.1.1.1.2.5AdjustChildRangesForBlock216

3.1.1.1.1.2.6MapUnmappedRangesToBlock217

3.1.1.1.1.2.7AdjustChildRangesForBlockDelete218

3.1.1.1.1.2.8GetUtilizationForLogicalGroup220

3.1.1.1.1.2.9GetUtilizationForLogicalGroupNode221

3.1.1.1.1.2.10GetUtilizationTrendForLogicalGroupNode221

3.1.1.1.2ADM_CustomFieldValuesAssociationTable222

3.1.1.1.2.1Data Model222


3.1.1.1.2.2.1GetCustomFieldValues223

3.1.1.1.2.2.2SetCustomFieldValues224

3.1.1.1.2.2.3DeleteCustomFieldValuesForObject225

3.1.1.1.2.2.4GetObjectIdsForLogicalGroupNode225

3.1.1.1.2.2.5GetObjectIdsForLogicalGroup226

3.1.1.1.2.2.6GetUnmappedObjectIdsForLogicalGroup227

3.1.1.1.2.2.7GetObjectForLogicalGroupObjectId228

3.1.1.1.3ADM_IPAddressTable229

3.1.1.1.3.1Data Model229


3.1.1.1.3.2.1AdjustIPAddressRangeMapping230

3.1.1.1.3.2.2GetIPAddressFromTable231

3.1.1.1.4ADM_IPBlocksTable233

3.1.1.1.4.1Data Model233


3.1.1.1.4.2.1GetParentBlockIdForRange234

3.1.1.1.4.2.2GetIPBlockFromTable235

3.1.1.1.4.2.3GetIPBlockParentAndChildDepth236

3.1.1.1.4.2.4GetOverlappingBlocks236

3.1.1.1.4.2.5CalculateParentForIPBlock237

3.1.1.1.4.2.6AdjustChildIPBlocks238

3.1.1.1.4.2.7DeleteBlockTree239

3.1.1.1.5ADM_DHCPReservationTable239

3.1.1.1.5.1Data Model239


3.1.1.1.5.2.1AddOrUpdateReservation240

3.1.1.1.6ADM_AddressDNSForwardLookupTable241

3.1.1.1.6.1Data Model241


3.1.1.1.6.2.1AddOrUpdateAddressDNSForwardLookupTable241

3.1.1.1.7ADM_AddressDNSReverseLookupTable242

3.1.1.1.7.1Data Model242


3.1.1.1.7.2.1AddOrUpdateAddressDNSReverseLookup242

3.1.1.1.8ADM_DNSForwardLookupTable243

3.1.1.1.8.1Data Model243


3.1.1.1.8.2.1GetDnsZoneFromTable243

3.1.1.1.9ADM_DNSReverseLookupTable244

3.1.1.1.9.1Data Model244


3.1.1.1.9.2.1GetDnsReverseLookupZoneFromTable244

3.1.1.1.10ADM_DNSServerForwardLookupZoneTable245

3.1.1.1.10.1Data Model245


3.1.1.1.10.2.1GetDnsServerZoneFromTable245

3.1.1.1.11ADM_DNSServerReverseLookupZoneTable246

3.1.1.1.11.1Data Model246


3.1.1.1.11.2.1GetDnsServerReverseLookupZoneFromTable246

3.1.1.1.12ADM_DHCPScopesTable247

3.1.1.1.12.1Data Model247


3.1.1.1.12.2.1GetScopeInformationForRange248

3.1.1.1.12.2.2GetScopeFromTable249

3.1.1.1.13ADM_CustomFieldsTable250

3.1.1.1.13.1Data Model250


3.1.1.1.13.2.1GetCustomField251

3.1.1.1.14ADM_CustomFieldValuesTable251

3.1.1.1.14.1Data Model251


3.1.1.1.14.2.1GetCustomFieldValuesForCustomField253

3.1.1.1.15ADM_LogicalGroupsTable254

3.1.1.1.15.1Data Model254


3.1.1.1.15.2.1GetLogicalGroupFromTable254

3.1.1.1.15.2.2GetRootLogicalGroupNodesForLogicalGroup255

3.1.1.1.15.2.3GetNextLevelLogicalGroupNodes256

3.1.1.1.16ADM_DHCPServersTable258

3.1.1.1.16.1Data Model258


3.1.1.1.16.2.1GetDHCPServerFromTable259

3.1.1.1.16.2.2GetUserClassFromServer260

3.1.1.1.16.2.3GetVendorClassFromServer261

3.1.1.1.16.2.4GetOptionDefinitionFromServer262

3.1.1.1.17ADM_DhcpOptionsTable263

3.1.1.1.17.1Data Model263


3.1.1.1.17.2.1GetDhcpOptions263

3.1.1.1.18ADM_DnsServersTable264

3.1.1.1.18.1Data Model264


3.1.1.1.18.2.1GetDnsServerFromTable265

3.1.1.1.19ADM_DnsZoneEventsTable265

3.1.1.1.19.1Data Model265


3.1.1.1.19.2.1GetDnsZoneEventFromTable266

3.1.1.1.20ADM_ServerRolesTable266

3.1.1.1.20.1Data Model266


3.1.1.1.20.2.1GetServerRoleInfoFromTable267

3.1.1.1.20.2.2GetServerRolesForServer267

3.1.1.1.21ADM_ServersTable268

3.1.1.1.21.1Data Model268


3.1.1.1.21.2.1GetServerInfoFromTable268

3.1.1.1.21.2.2GetFilteredServerInfoFromTable269

3.1.1.1.22ADM_IPv4AddressRangeUtilizationTable270

3.1.1.1.22.1Data Model270


3.1.1.1.22.2.1GetRangeUtilization271

3.1.1.1.23ADM_IPv4AddressBlockUtilizationTable272

3.1.1.1.23.1Data Model272


3.1.1.1.23.2.1GetAddressBlockUtilization272

3.1.1.1.24ADM_IPAddressAuditTable273

3.1.1.1.24.1Data Model273


3.1.1.1.24.2.1SearchIPAddressAuditByIPAddress273

3.1.1.1.24.2.2SearchIPAddressAuditByMacAddress274

3.1.1.1.24.2.3SearchIPAddressAuditByUserName275

3.1.1.1.24.2.4SearchIPAddressAuditByHostName276

3.1.1.1.25ADM_ConfigurationAuditTable276

3.1.1.1.25.1Data Model276


3.1.1.1.25.2.1SearchConfigurationAuditTable277

3.1.1.1.26ADM_DiscoveryConfigurationTable278

3.1.1.1.27ADM_CommonProperties279

3.1.1.1.28ADM_Tasks280

3.1.1.2ADM_IPAMSecurityGroups280

3.1.1.3Miscellaneous Global States281

3.1.1.4Miscellaneous Per-Session States281

3.1.2Timers282

3.1.3Initialization282

3.1.4Message Processing Events and Sequencing Rules282

3.1.4.1Session Established282

3.1.4.2Pre-Operation Processing282

3.1.4.3User Authorization Data Computation283

3.1.4.4ValidateIPBlock284

3.1.4.5ValidateIPRange285

3.1.4.6ValidateCustomFieldValues286

3.1.4.7SetIPRangeMapping286

3.1.4.8ValidateIpamIPAddress287

3.1.4.9ValidateDhcpScope289

3.1.4.10ValidateDhcpServer289

3.1.4.11ValidateCustomField289

3.1.4.12ValidateServerInfo289

3.1.4.13ValidateLogicalGroup290

3.1.5Timer Events291

3.1.6Other Local Events291

3.2Common Client Details291


3.2.2Timers291



3.2.4.1Session Established292

3.2.4.2Message Sent292



3.3IIpamServer Server Details292


3.3.2Timers292



3.3.4.1BulkUpdateBlocks292

3.3.4.1.1Messages293

3.3.4.1.1.1IIpamServer_BulkUpdateBlocks_InputMessage293

3.3.4.1.1.2IIpamServer_BulkUpdateBlocks_OutputMessage293

3.3.4.1.2Elements294

3.3.4.1.2.1BulkUpdateBlocks294

3.3.4.1.2.2BulkUpdateBlocksResponse294

3.3.4.2BulkUpdateIPAddresses294


3.3.4.2.1.1IIpamServer_BulkUpdateIPAddresses_InputMessage295

3.3.4.2.1.2IIpamServer_BulkUpdateIPAddresses_OutputMessage295


3.3.4.2.2.1BulkUpdateIPAddresses296

3.3.4.2.2.2BulkUpdateIPAddressesResponse296

3.3.4.3BulkUpdateRanges296


3.3.4.3.1.1IIpamServer_BulkUpdateRanges_InputMessage297

3.3.4.3.1.2IIpamServer_BulkUpdateRanges_OutputMessage297


3.3.4.3.2.1BulkUpdateRanges297

3.3.4.3.2.2BulkUpdateRangesResponse298

3.3.4.4BulkUpdateServers298


3.3.4.4.1.1IIpamServer_BulkUpdateServers_InputMessage298

3.3.4.4.1.2IIpamServer_BulkUpdateServers_OutputMessage299


3.3.4.4.2.1BulkUpdateServers299

3.3.4.4.2.2BulkUpdateServersResponse299

3.3.4.5CheckIfDnsServerReverseZoneHostedOnServer299


3.3.4.5.1.1IIpamServer_CheckIfDnsServerReverseZoneHostedOnServer_InputMessage300

3.3.4.5.1.2IIpamServer_CheckIfDnsServerReverseZoneHostedOnServer_OutputMessage300


3.3.4.5.2.1CheckIfDnsServerReverseZoneHostedOnServer301

3.3.4.5.2.2CheckIfDnsServerReverseZoneHostedOnServerResponse301

3.3.4.6CheckIfDnsServerZoneHostedOnServer301


3.3.4.6.1.1IIpamServer_CheckIfDnsServerZoneHostedOnServer_InputMessage302

3.3.4.6.1.2IIpamServer_CheckIfDnsServerZoneHostedOnServer_OutputMessage302


3.3.4.6.2.1CheckIfDnsServerZoneHostedOnServer302

3.3.4.6.2.2CheckIfDnsServerZoneHostedOnServerResponse303

3.3.4.7DBCreateOrUpdateScope303


3.3.4.7.1.1IIpamServer_DBCreateOrUpdateScope_InputMessage306

3.3.4.7.1.2IIpamServer_DBCreateOrUpdateScope_OutputMessage306


3.3.4.7.2.1DBCreateOrUpdateScope307

3.3.4.7.2.2DBCreateOrUpdateScopeResponse307

3.3.4.8DBDeleteScope307


3.3.4.8.1.1IIpamServer_DBDeleteScope_InputMessage308

3.3.4.8.1.2IIpamServer_DBDeleteScope_OutputMessage308


3.3.4.8.2.1DBDeleteScope308

3.3.4.8.2.2DBDeleteScopeResponse308

3.3.4.9DBGetDhcpServerFromRecordId309


3.3.4.9.1.1IIpamServer_DBGetDhcpServerFromRecordId_InputMessage309

3.3.4.9.1.2IIpamServer_DBGetDhcpServerFromRecordId_OutputMessage309


3.3.4.9.2.1DBGetDhcpServerFromRecordId310

3.3.4.9.2.2DBGetDhcpServerFromRecordIdResponse310

3.3.4.10DBGetDhcpServerFromServerInfoRecordId310

3.3.4.10.1Messages311

3.3.4.10.1.1IIpamServer_DBGetDhcpServerFromServerInfoRecordId_InputMessage311

3.3.4.10.1.2IIpamServer_DBGetDhcpServerFromServerInfoRecordId_OutputMessage311

3.3.4.10.2Elements312

3.3.4.10.2.1DBGetDhcpServerFromServerInfoRecordId312

3.3.4.10.2.2DBGetDhcpServerFromServerInfoRecordIdResponse312

3.3.4.11DBGetScopeFromNetworkIDAndServer312

3.3.4.11.1Messages313

3.3.4.11.1.1IIpamServer_DBGetScopeFromNetworkIDAndServer_InputMessage313

3.3.4.11.1.2IIpamServer_DBGetScopeFromNetworkIDAndServer_OutputMessage313

3.3.4.11.2Elements313

3.3.4.11.2.1DBGetScopeFromNetworkIDAndServer313

3.3.4.11.2.2DBGetScopeFromNetworkIDAndServerResponse314

3.3.4.12DBGetScopeFromRecordId314

3.3.4.12.1Messages314

3.3.4.12.1.1IIpamServer_DBGetScopeFromRecordId_InputMessage314

3.3.4.12.1.2IIpamServer_DBGetScopeFromRecordId_OutputMessage315

3.3.4.12.2Elements315

3.3.4.12.2.1DBGetScopeFromRecordId315

3.3.4.12.2.2DBGetScopeFromRecordIdResponse315

3.3.4.13DBUpdateDhcpServer315

3.3.4.13.1Messages318

3.3.4.13.1.1IIpamServer_DBUpdateDhcpServer_InputMessage318

3.3.4.13.1.2IIpamServer_DBUpdateDhcpServer_OutputMessage318

3.3.4.13.2Elements319

3.3.4.13.2.1DBUpdateDhcpServer319

3.3.4.13.2.2DBUpdateDhcpServerResponse319

3.3.4.14DeleteBlock319

3.3.4.14.1Messages320

3.3.4.14.1.1IIpamServer_DeleteBlock_InputMessage320

3.3.4.14.1.2IIpamServer_DeleteBlock_OutputMessage320

3.3.4.14.2Elements320

3.3.4.14.2.1DeleteBlock320

3.3.4.14.2.2DeleteBlockResponse321

3.3.4.15DeleteCustomField321

3.3.4.15.1Messages322

3.3.4.15.1.1IIpamServer_DeleteCustomField_InputMessage322

3.3.4.15.1.2IIpamServer_DeleteCustomField_OutputMessage322

3.3.4.15.2Elements322

3.3.4.15.2.1DeleteCustomField322

3.3.4.15.2.2DeleteCustomFieldResponse322

3.3.4.16DeleteDiscoveryConfig323

3.3.4.16.1Messages323

3.3.4.16.1.1IIpamServer_DeleteDiscoveryConfig_InputMessage323

3.3.4.16.1.2IIpamServer_DeleteDiscoveryConfig_OutputMessage323

3.3.4.16.2Elements324

3.3.4.16.2.1DeleteDiscoveryConfig324

3.3.4.16.2.2DeleteDiscoveryConfigResponse324

3.3.4.17DeleteIpamIPAddress324

3.3.4.17.1Messages325

3.3.4.17.1.1IIpamServer_DeleteIpamIPAddress_InputMessage325

3.3.4.17.1.2IIpamServer_DeleteIpamIPAddress_OutputMessage325

3.3.4.17.2Elements326

3.3.4.17.2.1DeleteIpamIPAddress326

3.3.4.17.2.2DeleteIpamIPAddressResponse326

3.3.4.18DeleteLogicalGroup326

3.3.4.18.1Messages326

3.3.4.18.1.1IIpamServer_DeleteLogicalGroup_InputMessage326

3.3.4.18.1.2IIpamServer_DeleteLogicalGroup_OutputMessage327

3.3.4.18.2Elements327

3.3.4.18.2.1DeleteLogicalGroup327

3.3.4.18.2.2DeleteLogicalGroupResponse327

3.3.4.19DeleteRange328

3.3.4.19.1Messages329

3.3.4.19.1.1IIpamServer_DeleteRange_InputMessage329

3.3.4.19.1.2IIpamServer_DeleteRange_OutputMessage329

3.3.4.19.2Elements330

3.3.4.19.2.1DeleteRange330

3.3.4.19.2.2DeleteRangeResponse330

3.3.4.20DeleteServer330

3.3.4.20.1Messages331

3.3.4.20.1.1IIpamServer_DeleteServer_InputMessage331

3.3.4.20.1.2IIpamServer_DeleteServer_OutputMessage331

3.3.4.20.2Elements331

3.3.4.20.2.1DeleteServer331

3.3.4.20.2.2DeleteServerResponse331

3.3.4.21FetchDnsServerReverseZoneById332

3.3.4.21.1Messages332

3.3.4.21.1.1IIpamServer_FetchDnsServerReverseZoneById_InputMessage332

3.3.4.21.1.2IIpamServer_FetchDnsServerReverseZoneById_OutputMessage332

3.3.4.21.2Elements333

3.3.4.21.2.1FetchDnsServerReverseZoneById333

3.3.4.21.2.2FetchDnsServerReverseZoneByIdResponse333

3.3.4.22FetchDnsServerZoneById333

3.3.4.22.1Messages334

3.3.4.22.1.1IIpamServer_FetchDnsServerZoneById_InputMessage334

3.3.4.22.1.2IIpamServer_FetchDnsServerZoneById_OutputMessage334

3.3.4.22.2Elements334

3.3.4.22.2.1FetchDnsServerZoneById334

3.3.4.22.2.2FetchDnsServerZoneByIdResponse334

3.3.4.23FetchIpamIPAddress335

3.3.4.23.1Messages336

3.3.4.23.1.1IIpamServer_FetchIpamIPAddress_InputMessage336

3.3.4.23.1.2IIpamServer_FetchIpamIPAddress_OutputMessage336

3.3.4.23.2Elements336

3.3.4.23.2.1FetchIpamIPAddress336

3.3.4.23.2.2FetchIpamIPAddressResponse337

3.3.4.24FetchIpamIPAddressByManagedByAndManagedByEntity337

3.3.4.24.1Messages338

3.3.4.24.1.1IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntity_InputMessage338

3.3.4.24.1.2IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntity_OutputMessage339

3.3.4.24.2Elements339

3.3.4.24.2.1FetchIpamIPAddressByManagedByAndManagedByEntity339

3.3.4.24.2.2FetchIpamIPAddressByManagedByAndManagedByEntityResponse339

3.3.4.25FindAvailableDhcpServersForReservation340

3.3.4.25.1Messages341

3.3.4.25.1.1IIpamServer_FindAvailableDhcpServersForReservation_InputMessage341

3.3.4.25.1.2IIpamServer_FindAvailableDhcpServersForReservation_OutputMessage341

3.3.4.25.2Elements341

3.3.4.25.2.1FindAvailableDhcpServersForReservation341

3.3.4.25.2.2FindAvailableDhcpServersForReservationResponse341

3.3.4.26FindAvailableScopeForReservationInDhcpServer342

3.3.4.26.1Messages342

3.3.4.26.1.1IIpamServer_FindAvailableScopeForReservationInDhcpServer_InputMessage342

3.3.4.26.1.2IIpamServer_FindAvailableScopeForReservationInDhcpServer_OutputMessage343

3.3.4.26.2Elements343

3.3.4.26.2.1FindAvailableScopeForReservationInDhcpServer343

3.3.4.26.2.2FindAvailableScopeForReservationInDhcpServerResponse343

3.3.4.27GetBlockById344

3.3.4.27.1Messages344

3.3.4.27.1.1IIpamServer_GetBlockById_InputMessage344

3.3.4.27.1.2IIpamServer_GetBlockById_OutputMessage344

3.3.4.27.2Elements345

3.3.4.27.2.1GetBlockById345

3.3.4.27.2.2GetBlockByIdResponse345

3.3.4.28GetBlockByIPAddressAndPrefixLength345

3.3.4.28.1Messages346

3.3.4.28.1.1IIpamServer_GetBlockByIPAddressAndPrefixLength_InputMessage346

3.3.4.28.1.2IIpamServer_GetBlockByIPAddressAndPrefixLength_OutputMessage346

3.3.4.28.2Elements347

3.3.4.28.2.1GetBlockByIPAddressAndPrefixLength347

3.3.4.28.2.2GetBlockByIPAddressAndPrefixLengthResponse347

3.3.4.29GetBlockHierarchy347

3.3.4.29.1Messages348

3.3.4.29.1.1IIpamServer_GetBlockHierarchy_InputMessage348

3.3.4.29.1.2IIpamServer_GetBlockHierarchy_OutputMessage348

3.3.4.29.2Elements348

3.3.4.29.2.1GetBlockHierarchy349

3.3.4.29.2.2GetBlockHierarchyResponse349

3.3.4.30GetBlockHierarchyForRangeId349

3.3.4.30.1Messages350

3.3.4.30.1.1IIpamServer_GetBlockHierarchyForRangeId_InputMessage350

3.3.4.30.1.2IIpamServer_GetBlockHierarchyForRangeId_OutputMessage350

3.3.4.30.2Elements350

3.3.4.30.2.1GetBlockHierarchyForRangeId351

3.3.4.30.2.2GetBlockHierarchyForRangeIdResponse351

3.3.4.31GetBlocksByIds351

3.3.4.31.1Messages351

3.3.4.31.1.1IIpamServer_GetBlocksByIds_InputMessage351

3.3.4.31.1.2IIpamServer_GetBlocksByIds_OutputMessage352

3.3.4.31.2Elements352

3.3.4.31.2.1GetBlocksByIds352

3.3.4.31.2.2GetBlocksByIdsResponse352

3.3.4.32GetBlockUtilization353

3.3.4.32.1Messages353

3.3.4.32.1.1IIpamServer_GetBlockUtilization_InputMessage353

3.3.4.32.1.2IIpamServer_GetBlockUtilization_OutputMessage354

3.3.4.32.2Elements354

3.3.4.32.2.1GetBlockUtilization354

3.3.4.32.2.2GetBlockUtilizationResponse354

3.3.4.33GetBuiltInCustomField354

3.3.4.33.1Messages355

3.3.4.33.1.1IIpamServer_GetBuiltInCustomField_InputMessage355

3.3.4.33.1.2IIpamServer_GetBuiltInCustomField_OutputMessage355

3.3.4.33.2Elements356

3.3.4.33.2.1GetBuiltInCustomField356

3.3.4.33.2.2GetBuiltInCustomFieldResponse356

3.3.4.34GetBuiltInLogicalGroup356

3.3.4.34.1Messages357

3.3.4.34.1.1IIpamServer_GetBuiltInLogicalGroup_InputMessage357

3.3.4.34.1.2IIpamServer_GetBuiltInLogicalGroup_OutputMessage357

3.3.4.34.2Elements357

3.3.4.34.2.1GetBuiltInLogicalGroup357

3.3.4.34.2.2GetBuiltInLogicalGroupResponse357

3.3.4.35GetCommonPropertyValue358

3.3.4.35.1Messages358

3.3.4.35.1.1IIpamServer_GetCommonPropertyValue_InputMessage358

3.3.4.35.1.2IIpamServer_GetCommonPropertyValue_OutputMessage358

3.3.4.35.2Elements359

3.3.4.35.2.1GetCommonPropertyValue359

3.3.4.35.2.2GetCommonPropertyValueResponse359

3.3.4.36GetCustomFieldById359

3.3.4.36.1Messages360

3.3.4.36.1.1IIpamServer_GetCustomFieldById_InputMessage360

3.3.4.36.1.2IIpamServer_GetCustomFieldById_OutputMessage360

3.3.4.36.2Elements360

3.3.4.36.2.1GetCustomFieldById360

3.3.4.36.2.2GetCustomFieldByIdResponse360

3.3.4.37GetDiscoveryConfig361

3.3.4.37.1Messages362

3.3.4.37.1.1IIpamServer_GetDiscoveryConfig_InputMessage362

3.3.4.37.1.2IIpamServer_GetDiscoveryConfig_OutputMessage362

3.3.4.37.2Elements362

3.3.4.37.2.1GetDiscoveryConfig362

3.3.4.37.2.2GetDiscoveryConfigResponse362

3.3.4.38GetFreeIPAddresses363

3.3.4.38.1Messages363

3.3.4.38.1.1IIpamServer_GetFreeIPAddresses_InputMessage364

3.3.4.38.1.2IIpamServer_GetFreeIPAddresses_OutputMessage364

3.3.4.38.2Elements364

3.3.4.38.2.1GetFreeIPAddresses364

3.3.4.38.2.2GetFreeIPAddressesResponse364

3.3.4.39GetIPAddressById365

3.3.4.39.1Messages365

3.3.4.39.1.1IIpamServer_GetIPAddressById_InputMessage365

3.3.4.39.1.2IIpamServer_GetIPAddressById_OutputMessage365

3.3.4.39.2Elements366

3.3.4.39.2.1GetIPAddressById366

3.3.4.39.2.2GetIPAddressByIdResponse366

3.3.4.40GetIPAddressesByIds366

3.3.4.40.1Messages367

3.3.4.40.1.1IIpamServer_GetIPAddressesByIds_InputMessage367

3.3.4.40.1.2IIpamServer_GetIPAddressesByIds_OutputMessage367

3.3.4.40.2Elements367

3.3.4.40.2.1GetIPAddressesByIds368

3.3.4.40.2.2GetIPAddressesByIdsResponse368

3.3.4.41GetIpamTasksInfo368

3.3.4.41.1Messages368

3.3.4.41.1.1IIpamServer_GetIpamTasksInfo_InputMessage368

3.3.4.41.1.2IIpamServer_GetIpamTasksInfo_OutputMessage369

3.3.4.41.2Elements369

3.3.4.41.2.1GetIpamTasksInfo369

3.3.4.41.2.2GetIpamTasksInfoResponse369

3.3.4.42GetIpamVersion369

3.3.4.42.1Messages370

3.3.4.42.1.1IIpamServer_GetIpamVersion_InputMessage370

3.3.4.42.1.2IIpamServer_GetIpamVersion_OutputMessage370

3.3.4.42.2Elements370

3.3.4.42.2.1GetIpamVersion370

3.3.4.42.2.2GetIpamVersionResponse370

3.3.4.43GetIPRangeById371

3.3.4.43.1Messages371

3.3.4.43.1.1IIpamServer_GetIPRangeById_InputMessage371

3.3.4.43.1.2IIpamServer_GetIPRangeById_OutputMessage371

3.3.4.43.2Elements372

3.3.4.43.2.1GetIPRangeById372

3.3.4.43.2.2GetIPRangeByIdResponse372

3.3.4.44GetIPRangesByIds372

3.3.4.44.1Messages373

3.3.4.44.1.1IIpamServer_GetIPRangesByIds_InputMessage373

3.3.4.44.1.2IIpamServer_GetIPRangesByIds_OutputMessage373

3.3.4.44.2Elements373

3.3.4.44.2.1GetIPRangesByIds373

3.3.4.44.2.2GetIPRangesByIdsResponse374

3.3.4.45GetLogicalGroupById374

3.3.4.45.1Messages375

3.3.4.45.1.1IIpamServer_GetLogicalGroupById_InputMessage375

3.3.4.45.1.2IIpamServer_GetLogicalGroupById_OutputMessage375

3.3.4.45.2Elements375

3.3.4.45.2.1GetLogicalGroupById375

3.3.4.45.2.2GetLogicalGroupByIdResponse376

3.3.4.46GetLogicalGroupUtilizationByPeriod376

3.3.4.46.1Messages376

3.3.4.46.1.1IIpamServer_GetLogicalGroupUtilizationByPeriod_InputMessage376

3.3.4.46.1.2IIpamServer_GetLogicalGroupUtilizationByPeriod_OutputMessage377

3.3.4.46.2Elements377

3.3.4.46.2.1GetLogicalGroupUtilizationByPeriod377

3.3.4.46.2.2GetLogicalGroupUtilizationByPeriodResponse377

3.3.4.47GetLogicalGroupUtilizationByType378

3.3.4.47.1Messages378

3.3.4.47.1.1IIpamServer_GetLogicalGroupUtilizationByType_InputMessage378

3.3.4.47.1.2IIpamServer_GetLogicalGroupUtilizationByType_OutputMessage379

3.3.4.47.2Elements379

3.3.4.47.2.1GetLogicalGroupUtilizationByType379

3.3.4.47.2.2GetLogicalGroupUtilizationByTypeResponse379

3.3.4.48GetNumberOfForwardLookupZonesForServers379

3.3.4.48.1Messages380

3.3.4.48.1.1IIpamServer_GetNumberOfForwardLookupZonesForServers_InputMessage380

3.3.4.48.1.2IIpamServer_GetNumberOfForwardLookupZonesForServers_OutputMessage380

3.3.4.48.2Elements381

3.3.4.48.2.1GetNumberOfForwardLookupZonesForServers381

3.3.4.48.2.2GetNumberOfForwardLookupZonesForServersResponse381

3.3.4.49GetRangeByIPAddress381

3.3.4.49.1Messages382

3.3.4.49.1.1IIpamServer_GetRangeByIPAddress_InputMessage382

3.3.4.49.1.2IIpamServer_GetRangeByIPAddress_OutputMessage382

3.3.4.49.2Elements382

3.3.4.49.2.1GetRangeByIPAddress382

3.3.4.49.2.2GetRangeByIPAddressResponse383

3.3.4.50GetRangeByIPAddressAndManagedByManagedByEntity383

3.3.4.50.1Messages384

3.3.4.50.1.1IIpamServer_GetRangeByIPAddressAndManagedByManagedByEntity_InputMessage384

3.3.4.50.1.2IIpamServer_GetRangeByIPAddressAndManagedByManagedByEntity_OutputMessage384

3.3.4.50.2Elements385

3.3.4.50.2.1GetRangeByIPAddressAndManagedByManagedByEntity385

3.3.4.50.2.2GetRangeByIPAddressAndManagedByManagedByEntityResponse385

3.3.4.51GetRangeByScopeRecordId385

3.3.4.51.1Messages386

3.3.4.51.1.1IIpamServer_GetRangeByScopeRecordId_InputMessage386

3.3.4.51.1.2IIpamServer_GetRangeByScopeRecordId_OutputMessage386

3.3.4.51.2Elements386

3.3.4.51.2.1GetRangeByScopeRecordId386

3.3.4.51.2.2GetRangeByScopeRecordIdResponse386

3.3.4.52GetRangeUtilization387

3.3.4.52.1Messages388

3.3.4.52.1.1IIpamServer_GetRangeUtilization_InputMessage388

3.3.4.52.1.2IIpamServer_GetRangeUtilization_OutputMessage388

3.3.4.52.2Elements389

3.3.4.52.2.1GetRangeUtilization389

3.3.4.52.2.2GetRangeUtilizationResponse389

3.3.4.53GetScopesByIds389

3.3.4.53.1Messages390

3.3.4.53.1.1IIpamServer_GetScopesByIds_InputMessage390

3.3.4.53.1.2IIpamServer_GetScopesByIds_OutputMessage390

3.3.4.53.2Elements390

3.3.4.53.2.1GetScopesByIds390

3.3.4.53.2.2GetScopesByIdsResponse391

3.3.4.54GetServersForMultipleId391

3.3.4.54.1Messages391

3.3.4.54.1.1IIpamServer_GetServersForMultipleId_InputMessage391

3.3.4.54.1.2IIpamServer_GetServersForMultipleId_OutputMessage392

3.3.4.54.2Elements392

3.3.4.54.2.1GetServersForMultipleId392

3.3.4.54.2.2GetServersForMultipleIdResponse392

3.3.4.55GetTotalUnmappedRanges392

3.3.4.55.1Messages393

3.3.4.55.1.1IIpamServer_GetTotalUnmappedRanges_InputMessage393

3.3.4.55.1.2IIpamServer_GetTotalUnmappedRanges_OutputMessage393

3.3.4.55.2Elements393

3.3.4.55.2.1GetTotalUnmappedRanges393

3.3.4.55.2.2GetTotalUnmappedRangesResponse394

3.3.4.56IsIPAddressMapped394

3.3.4.56.1Messages394

3.3.4.56.1.1IIpamServer_IsIPAddressMapped_InputMessage394

3.3.4.56.1.2IIpamServer_IsIPAddressMapped_OutputMessage395

3.3.4.56.2Elements395

3.3.4.56.2.1IsIPAddressMapped395

3.3.4.56.2.2IsIPAddressMappedResponse395

3.3.4.57IsIpamConfigured395

3.3.4.57.1Messages396

3.3.4.57.1.1IIpamServer_IsIpamConfigured_InputMessage396

3.3.4.57.1.2IIpamServer_IsIpamConfigured_OutputMessage396

3.3.4.57.2Elements396

3.3.4.57.2.1IsIpamConfigured396

3.3.4.57.2.2IsIpamConfiguredResponse396

3.3.4.58IsPurgeTaskRunning397

3.3.4.58.1Messages397

3.3.4.58.1.1IIpamServer_IsPurgeTaskRunning_InputMessage397

3.3.4.58.1.2IIpamServer_IsPurgeTaskRunning_OutputMessage397

3.3.4.58.2Elements398

3.3.4.58.2.1IsPurgeTaskRunning398

3.3.4.58.2.2IsPurgeTaskRunningResponse398

3.3.4.59IsSchemaConversionInProgress398

3.3.4.59.1Messages398

3.3.4.59.1.1IIpamServer_IsSchemaConversionInProgress_InputMessage398

3.3.4.59.1.2IIpamServer_IsSchemaConversionInProgress_OutputMessage399

3.3.4.59.2Elements399

3.3.4.59.2.1IsSchemaConversionInProgress399

3.3.4.59.2.2IsSchemaConversionInProgressResponse399

3.3.4.60IsSchemaConversionRequired399

3.3.4.60.1Messages400

3.3.4.60.1.1IIpamServer_IsSchemaConversionRequired_InputMessage400

3.3.4.60.1.2IIpamServer_IsSchemaConversionRequired_OutputMessage400

3.3.4.60.2Elements400

3.3.4.60.2.1IsSchemaConversionRequired400

3.3.4.60.2.2IsSchemaConversionRequiredResponse401

3.3.4.61IsTaskRunning401

3.3.4.61.1Messages401

3.3.4.61.1.1IIpamServer_IsTaskRunning_InputMessage401

3.3.4.61.1.2IIpamServer_IsTaskRunning_OutputMessage402

3.3.4.61.2Elements402

3.3.4.61.2.1IsTaskRunning402

3.3.4.61.2.2IsTaskRunningResponse402

3.3.4.62ManuallyAddServer402

3.3.4.62.1Messages403

3.3.4.62.1.1IIpamServer_ManuallyAddServer_InputMessage403

3.3.4.62.1.2IIpamServer_ManuallyAddServer_OutputMessage403

3.3.4.62.2Elements404

3.3.4.62.2.1ManuallyAddServer404

3.3.4.62.2.2ManuallyAddServerResponse404

3.3.4.63ManuallyUpdateServer404

3.3.4.63.1Messages405

3.3.4.63.1.1IIpamServer_ManuallyUpdateServer_InputMessage405

3.3.4.63.1.2IIpamServer_ManuallyUpdateServer_OutputMessage405

3.3.4.63.2Elements406

3.3.4.63.2.1ManuallyUpdateServer406

3.3.4.63.2.2ManuallyUpdateServerResponse406

3.3.4.64PurgeAuditData406

3.3.4.64.1Messages407

3.3.4.64.1.1IIpamServer_PurgeAuditData_InputMessage407

3.3.4.64.1.2IIpamServer_PurgeAuditData_OutputMessage407

3.3.4.64.2Elements408

3.3.4.64.2.1PurgeAuditData408

3.3.4.64.2.2PurgeAuditDataResponse408

3.3.4.65RemapRange408

3.3.4.65.1Messages409

3.3.4.65.1.1IIpamServer_RemapRange_InputMessage409

3.3.4.65.1.2IIpamServer_RemapRange_OutputMessage409

3.3.4.65.2Elements410

3.3.4.65.2.1RemapRange410

3.3.4.65.2.2RemapRangeResponse410

3.3.4.66ResetZoneHealth410

3.3.4.66.1Messages411

3.3.4.66.1.1IIpamServer_ResetZoneHealth_InputMessage411

3.3.4.66.1.2IIpamServer_ResetZoneHealth_OutputMessage411

3.3.4.66.2Elements412

3.3.4.66.2.1ResetZoneHealth412

3.3.4.66.2.2ResetZoneHealthResponse412

3.3.4.67SaveBlock412

3.3.4.67.1Messages413

3.3.4.67.1.1IIpamServer_SaveBlock_InputMessage413

3.3.4.67.1.2IIpamServer_SaveBlock_OutputMessage414

3.3.4.67.2Elements414

3.3.4.67.2.1SaveBlock414

3.3.4.67.2.2SaveBlockResponse414

3.3.4.68SaveCustomField414

3.3.4.68.1Messages415

3.3.4.68.1.1IIpamServer_SaveCustomField_InputMessage416

3.3.4.68.1.2IIpamServer_SaveCustomField_OutputMessage416

3.3.4.68.2Elements416

3.3.4.68.2.1SaveCustomField416

3.3.4.68.2.2SaveCustomFieldResponse416

3.3.4.69SaveDiscoveryConfig417

3.3.4.69.1Messages417

3.3.4.69.1.1IIpamServer_SaveDiscoveryConfig_InputMessage417

3.3.4.69.1.2IIpamServer_SaveDiscoveryConfig_OutputMessage417

3.3.4.69.2Elements418

3.3.4.69.2.1SaveDiscoveryConfig418

3.3.4.69.2.2SaveDiscoveryConfigResponse418

3.3.4.70SaveIpamIPAddress418

3.3.4.70.1Messages421

3.3.4.70.1.1IIpamServer_SaveIpamIPAddress_InputMessage421

3.3.4.70.1.2IIpamServer_SaveIpamIPAddress_OutputMessage421

3.3.4.70.2Elements421

3.3.4.70.2.1SaveIpamIPAddress421

3.3.4.70.2.2SaveIpamIPAddressResponse422

3.3.4.71SaveLogicalGroup422

3.3.4.71.1Messages422

3.3.4.71.1.1IIpamServer_SaveLogicalGroup_InputMessage422

3.3.4.71.1.2IIpamServer_SaveLogicalGroup_OutputMessage423

3.3.4.71.2Elements423

3.3.4.71.2.1SaveLogicalGroup423

3.3.4.71.2.2SaveLogicalGroupResponse423

3.3.4.72SaveRange424

3.3.4.72.1Messages424

3.3.4.72.1.1IIpamServer_SaveRange_InputMessage424

3.3.4.72.1.2IIpamServer_SaveRange_OutputMessage424

3.3.4.72.2Elements425

3.3.4.72.2.1SaveRange425

3.3.4.72.2.2SaveRangeResponse425

3.3.4.73SetCommonPropertyValue425

3.3.4.73.1Messages426

3.3.4.73.1.1IIpamServer_SetCommonPropertyValue_InputMessage426

3.3.4.73.1.2IIpamServer_SetCommonPropertyValue_OutputMessage426

3.3.4.73.2Elements426

3.3.4.73.2.1SetCommonPropertyValue426

3.3.4.73.2.2SetCommonPropertyValueResponse426

3.3.4.74StartTask427

3.3.4.74.1Messages427

3.3.4.74.1.1IIpamServer_StartTask_InputMessage427

3.3.4.74.1.2IIpamServer_StartTask_OutputMessage427

3.3.4.74.2Elements428

3.3.4.74.2.1StartTask428

3.3.4.74.2.2StartTaskResponse428

3.3.4.75TaskLastRunResult428

3.3.4.75.1Messages429

3.3.4.75.1.1IIpamServer_TaskLastRunResult_InputMessage429

3.3.4.75.1.2IIpamServer_TaskLastRunResult_OutputMessage429

3.3.4.75.2Elements429

3.3.4.75.2.1TaskLastRunResult429

3.3.4.75.2.2TaskLastRunResultResponse429

3.3.4.76TaskLastRuntime430

3.3.4.76.1Messages430

3.3.4.76.1.1IIpamServer_TaskLastRuntime_InputMessage430

3.3.4.76.1.2IIpamServer_TaskLastRuntime_OutputMessage430

3.3.4.76.2Elements431

3.3.4.76.2.1TaskLastRuntime431

3.3.4.76.2.2TaskLastRuntimeResponse431

3.3.4.77TaskNextRuntime431

3.3.4.77.1Messages432

3.3.4.77.1.1IIpamServer_TaskNextRuntime_InputMessage432

3.3.4.77.1.2IIpamServer_TaskNextRuntime_OutputMessage432

3.3.4.77.2Elements432

3.3.4.77.2.1TaskNextRuntime432

3.3.4.77.2.2TaskNextRuntimeResponse432

3.3.4.78TaskRecurrenceDuration433

3.3.4.78.1Messages433

3.3.4.78.1.1IIpamServer_TaskRecurrenceDuration_InputMessage433

3.3.4.78.1.2IIpamServer_TaskRecurrenceDuration_OutputMessage433

3.3.4.78.2Elements434

3.3.4.78.2.1TaskRecurrenceDuration434

3.3.4.78.2.2TaskRecurrenceDurationResponse434

3.3.4.79UpdateBlock434

3.3.4.79.1Messages436

3.3.4.79.1.1IIpamServer_UpdateBlock_InputMessage436

3.3.4.79.1.2IIpamServer_UpdateBlock_OutputMessage436

3.3.4.79.2Elements436

3.3.4.79.2.1UpdateBlock436

3.3.4.79.2.2UpdateBlockResponse437

3.3.4.80UpdateCustomField437

3.3.4.80.1Messages438

3.3.4.80.1.1IIpamServer_UpdateCustomField_InputMessage438

3.3.4.80.1.2IIpamServer_UpdateCustomField_OutputMessage439

3.3.4.80.2Elements439

3.3.4.80.2.1UpdateCustomField439

3.3.4.80.2.2UpdateCustomFieldResponse439

3.3.4.81UpdateDiscoveryConfig439

3.3.4.81.1Messages440

3.3.4.81.1.1IIpamServer_UpdateDiscoveryConfig_InputMessage440

3.3.4.81.1.2IIpamServer_UpdateDiscoveryConfig_OutputMessage440

3.3.4.81.2Elements441

3.3.4.81.2.1UpdateDiscoveryConfig441

3.3.4.81.2.2UpdateDiscoveryConfigResponse441

3.3.4.82UpdateIpamIPAddress441

3.3.4.82.1Messages444

3.3.4.82.1.1IIpamServer_UpdateIpamIPAddress_InputMessage444

3.3.4.82.1.2IIpamServer_UpdateIpamIPAddress_OutputMessage444

3.3.4.82.2Elements445

3.3.4.82.2.1UpdateIpamIPAddress445

3.3.4.82.2.2UpdateIpamIPAddressResponse445

3.3.4.83UpdateLogicalGroup445

3.3.4.83.1Messages446

3.3.4.83.1.1IIpamServer_UpdateLogicalGroup_InputMessage446

3.3.4.83.1.2IIpamServer_UpdateLogicalGroup_OutputMessage446

3.3.4.83.2Elements446

3.3.4.83.2.1UpdateLogicalGroup446

3.3.4.83.2.2UpdateLogicalGroupResponse446

3.3.4.84UpdateRange447

3.3.4.84.1Messages448

3.3.4.84.1.1IIpamServer_UpdateRange_InputMessage448

3.3.4.84.1.2IIpamServer_UpdateRange_OutputMessage448

3.3.4.84.2Elements449

3.3.4.84.2.1UpdateRange449

3.3.4.84.2.2UpdateRangeResponse449



3.3.6.1User Authorization449

3.4IIpamServer Client Details453


3.4.2Timers453





3.5IIpamEnumerator Server Details454


3.5.1.1State Machine455

3.5.1.2Other Miscellaneous States456

3.5.2Timers457



3.5.4.1New Session Indication457

3.5.4.2Session Closed or Faulted457

3.5.4.3EnumeratedRowsCallback457


3.5.4.3.1.1IIpamEnumerator_EnumeratedRowsCallback_OutputCallbackMessage457


3.5.4.3.2.1EnumeratedRowsCallback457

3.5.4.4InitializeEnumeration458


3.5.4.4.1.1IIpamEnumerator_InitializeEnumeration_InputMessage458

3.5.4.4.1.2IIpamEnumerator_InitializeEnumeration_OutputMessage459


3.5.4.4.2.1InitializeEnumeration459

3.5.4.4.2.2InitializeEnumerationResponse459

3.5.4.5NotifyEnumerationComplete459


3.5.4.5.1.1IIpamEnumerator_NotifyEnumerationComplete_OutputCallbackMessage459


3.5.4.5.2.1NotifyEnumerationComplete460

3.5.4.6NotifyEnumerationStart460


3.5.4.6.1.1IIpamEnumerator_NotifyEnumerationStart_OutputCallbackMessage460


3.5.4.6.2.1NotifyEnumerationStart461

3.5.4.7StartEnumeration461

3.5.4.7.1Enumeration Processing Logic461

3.5.4.7.1.1ConfigurationAuditEnumerationParameters463

3.5.4.7.1.2CustomFieldEnumerationParameters463

3.5.4.7.1.3DhcpScopeAllEnumerationParameters463

3.5.4.7.1.4DhcpScopeAssociatedWithVendorClassesEnumerationParameters464

3.5.4.7.1.5DhcpScopeForIpBlockEnumerationParameters465

3.5.4.7.1.6DhcpScopesByDhcpServerIdListEnumerationParameters466

3.5.4.7.1.7DhcpScopeUnmappedEnumerationParameters466

3.5.4.7.1.8DhcpServerAllEnumerationParameters466

3.5.4.7.1.9DhcpServerByServerInfoIdsEnumerationParameters467

3.5.4.7.1.10DiscoverySubnetEnumerationParameters467

3.5.4.7.1.11DnsReverseLookupZoneEnumerationParameters468

3.5.4.7.1.12DnsServerByServerInfoIdsEnumerationParameters469

3.5.4.7.1.13DnsServerEnumerationParameters469

3.5.4.7.1.14DnsServerReverseZoneEnumerationParameters470

3.5.4.7.1.15DnsServerZoneEnumerationParameters470

3.5.4.7.1.16DnsZoneEnumerationParameters470

3.5.4.7.1.17DnsZoneEventEnumerationParameters471

3.5.4.7.1.18IpamIPAddressAllForLogicalGroupEnumerationParameters471

3.5.4.7.1.19IpamIPAddressAllForLogicalGroupNodeEnumerationParameters472

3.5.4.7.1.20IpamIPAddressByBlockIdEnumerationParameters473

3.5.4.7.1.21IpamIPAddressByManagedByAndManagedByEntityEnumerationParameters473

3.5.4.7.1.22IpamIPAddressByRangeIdEnumerationParameters474

3.5.4.7.1.23IpamIPAddressForUnmappedRangesEnumerationParameters474

3.5.4.7.1.24IpamIPAddressGetDuplicateIPAddressesEnumerationParameters475

3.5.4.7.1.25IpamIPAddressRootAddressesEnumerationParameters475

3.5.4.7.1.26IpamIPAddressUnmappedAddressEnumerationParameters476

3.5.4.7.1.27IPBlockChildBlockEnumerationParameters476

3.5.4.7.1.28IPBlockGetAllBlocksEnumerationParameters476

3.5.4.7.1.29IPBlockRootEnumerationParameters477

3.5.4.7.1.30IPRangeAllForBlockEnumerationParameter477

3.5.4.7.1.31IPRangeByManagedByAndManagedByEntityEnumerationParameters478

3.5.4.7.1.32IPRangeForBlockEnumerationParameters478

3.5.4.7.1.33IPRangeRootEnumerationParameters479

3.5.4.7.1.34IPRangeUnmappedEnumerationParameters479

3.5.4.7.1.35LogicalGroupDataForLogicalGroupNodeEnumerationParameters479

3.5.4.7.1.36LogicalGroupDataForRootAlternateItemsEnumerationParameters480

3.5.4.7.1.37LogicalGroupDataUnmappedItemsEnumerationParameters481

3.5.4.7.1.38LogicalGroupNodeChildrenEnumerationParameters482

3.5.4.7.1.39LogicalGroupNodeRootEnumerationParameters483

3.5.4.7.1.40LogicalGroupsEnumerationParameters483

3.5.4.7.1.41ServerInfoEnumerationParameters483

3.5.4.7.1.42UnmappedIpamIPAddressForLogicalGroupEnumerationParameters484


3.5.4.7.2.1IIpamEnumerator_StartEnumeration_InputMessage484


3.5.4.7.3.1StartEnumeration485




3.6IIpamEnumerator Client Details485


3.6.2Timers486



3.6.4.1Enumeration Completed486



3.7IIpamEnumeratorCallback Server Details487




3.7.2Timers488



3.7.4.1Session Faulted or Closed488



3.7.4.2.1.1IIpamEnumeratorCallback_EnumeratedRowsCallback_InputMessage489





3.7.4.3.1.1IIpamEnumeratorCallback_NotifyEnumerationComplete_InputMessage490





3.7.4.4.1.1IIpamEnumeratorCallback_NotifyEnumerationStart_InputMessage490






3.8IIpamEnumeratorCallback Client Details491


3.8.2Timers491





3.9IIpamIPAuditEnumerator Server Details492


3.9.2Timers492





3.9.4.1.1.1IIpamIPAuditEnumerator_EnumeratedRowsCallback_OutputCallbackMessage493



3.9.4.2IPAuditInitializeEnumeration493


3.9.4.2.1.1IIpamIPAuditEnumerator_IPAuditInitializeEnumeration_InputMessage493

3.9.4.2.1.2IIpamIPAuditEnumerator_IPAuditInitializeEnumeration_OutputMessage494


3.9.4.2.2.1IPAuditInitializeEnumeration494

3.9.4.2.2.2IPAuditInitializeEnumerationResponse494

3.9.4.3IPAuditStartEnumeration494

3.9.4.3.1Enumeration Processing Logic495

3.9.4.3.1.1IPAuditEnumerationParameters495


3.9.4.3.2.1IIpamIPAuditEnumerator_IPAuditStartEnumeration_InputMessage496


3.9.4.3.3.1IPAuditStartEnumeration497



3.9.4.4.1.1IIpamIPAuditEnumerator_NotifyEnumerationComplete_OutputCallbackMessage497





3.9.4.5.1.1IIpamIPAuditEnumerator_NotifyEnumerationStart_OutputCallbackMessage498






3.10IIpamIPAuditEnumerator Client Details499


3.10.2Timers499





3.11IIpamAsyncProvision Server Details500



3.11.2Timers502





3.11.4.3InitializeAsyncProvisioning503

3.11.4.3.1Messages503

3.11.4.3.1.1IIpamAsyncProvision_InitializeAsyncProvisioning_InputMessage503

3.11.4.3.1.2IIpamAsyncProvision_InitializeAsyncProvisioning_OutputMessage503

3.11.4.3.2Elements503

3.11.4.3.2.1InitializeAsyncProvisioning504

3.11.4.3.2.2InitializeAsyncProvisioningResponse504

3.11.4.4NotifyAsyncProvisionCheckpoint504

3.11.4.4.1Messages504

3.11.4.4.1.1IIpamAsyncProvision_NotifyAsyncProvisionCheckpoint_OutputCallbackMessage504

3.11.4.4.2Elements504

3.11.4.4.2.1NotifyAsyncProvisionCheckpoint504

3.11.4.5NotifyAsyncProvisionComplete505

3.11.4.5.1Messages505

3.11.4.5.1.1IIpamAsyncProvision_NotifyAsyncProvisionComplete_OutputCallbackMessage505

3.11.4.5.2Elements505

3.11.4.5.2.1NotifyAsyncProvisionComplete505

3.11.4.6NotifyAsyncProvisionStart506

3.11.4.6.1Messages506

3.11.4.6.1.1IIpamAsyncProvision_NotifyAsyncProvisionStart_OutputCallbackMessage506

3.11.4.6.2Elements506

3.11.4.6.2.1NotifyAsyncProvisionStart506

3.11.4.7StartAsyncProvisioning506

3.11.4.7.1Messages507

3.11.4.7.1.1IIpamAsyncProvision_StartAsyncProvisioning_InputMessage507

3.11.4.7.2Elements507

3.11.4.7.2.1StartAsyncProvisioning507




3.12IIpamAsyncProvision Client Details508


3.12.2Timers509



3.12.4.1Provisioning Completed509



3.13IIpamAsyncProvisionCallback Server Details509




3.13.2Timers511




3.13.4.2NotifyAsyncProvisionCheckpoint511

3.13.4.2.1Messages511

3.13.4.2.1.1IIpamAsyncProvisionCallback_NotifyAsyncProvisionCheckpoint_InputMessage511

3.13.4.2.2Elements512

3.13.4.2.2.1NotifyAsyncProvisionCheckpoint512

3.13.4.3NotifyAsyncProvisionComplete512

3.13.4.3.1Messages512

3.13.4.3.1.1IIpamAsyncProvisionCallback_NotifyAsyncProvisionComplete_InputMessage512

3.13.4.3.2Elements513

3.13.4.3.2.1NotifyAsyncProvisionComplete513

3.13.4.4NotifyAsyncProvisionStart513

3.13.4.4.1Messages513

3.13.4.4.1.1IIpamAsyncProvisionCallback_NotifyAsyncProvisionStart_InputMessage513

3.13.4.4.2Elements513

3.13.4.4.2.1NotifyAsyncProvisionStart513




3.14IIpamAsyncProvisionCallback Client Details514


3.14.2Timers514





3.15IIpamAsyncSchemaConversion Server Details514



3.15.2Timers517





3.15.4.3InitializeAsyncSchemaConversion518

3.15.4.3.1Messages518

3.15.4.3.1.1IIpamAsyncSchemaConversion_InitializeAsyncSchemaConversion_InputMessage518

3.15.4.3.1.2IIpamAsyncSchemaConversion_InitializeAsyncSchemaConversion_OutputMessage518

3.15.4.3.2Elements519

3.15.4.3.2.1InitializeAsyncSchemaConversion519

3.15.4.3.2.2InitializeAsyncSchemaConversionResponse519

3.15.4.4NotifyAsyncSchemaConversionCheckpoint519

3.15.4.4.1Messages519

3.15.4.4.1.1IIpamAsyncSchemaConversion_NotifyAsyncSchemaConversionCheckpoint_OutputCallbackMessage519

3.15.4.4.2Elements520

3.15.4.4.2.1NotifyAsyncSchemaConversionCheckpoint520

3.15.4.5NotifyAsyncSchemaConversionComplete520

3.15.4.5.1Messages520

3.15.4.5.1.1IIpamAsyncSchemaConversion_NotifyAsyncSchemaConversionComplete_OutputCallbackMessage520

3.15.4.5.2Elements520

3.15.4.5.2.1NotifyAsyncSchemaConversionComplete521

3.15.4.6NotifyAsyncSchemaConversionStart521

3.15.4.6.1Messages521

3.15.4.6.1.1IIpamAsyncSchemaConversion_NotifyAsyncSchemaConversionStart_OutputCallbackMessage521

3.15.4.6.2Elements521

3.15.4.6.2.1NotifyAsyncSchemaConversionStart521

3.15.4.7StartAsyncSchemaConversion522

3.15.4.7.1Messages523

3.15.4.7.1.1IIpamAsyncSchemaConversion_StartAsyncSchemaConversion_InputMessage523

3.15.4.7.2Elements523

3.15.4.7.2.1StartAsyncSchemaConversion523




3.16IIpamAsyncSchemaConversion Client Details524


3.16.2Timers524



3.16.4.1Conversion Completed524



3.17IIpamAsyncSchemaCallback Server Details525




3.17.2Timers526




3.17.4.2NotifyAsyncSchemaConversionCheckpoint527

3.17.4.2.1Messages527

3.17.4.2.1.1IIpamAsyncSchemaCallback_NotifyAsyncSchemaConversionCheckpoint_InputMessage527

3.17.4.2.2Elements527

3.17.4.2.2.1NotifyAsyncSchemaConversionCheckpoint527

3.17.4.3NotifyAsyncSchemaConversionComplete527

3.17.4.3.1Messages528

3.17.4.3.1.1IIpamAsyncSchemaCallback_NotifyAsyncSchemaConversionComplete_InputMessage528

3.17.4.3.2Elements528

3.17.4.3.2.1NotifyAsyncSchemaConversionComplete528

3.17.4.4NotifyAsyncSchemaConversionStart528

3.17.4.4.1Messages529

3.17.4.4.1.1IIpamAsyncSchemaCallback_NotifyAsyncSchemaConversionStart_InputMessage529

3.17.4.4.2Elements529

3.17.4.4.2.1NotifyAsyncSchemaConversionStart529




3.18IIpamAsyncSchemaCallback Client Details529


3.18.2Timers530





4Protocol Examples531

4.1Querying the Common Property531

4.2Creating an Address Range531

4.3Enumerating the Address Ranges533

5Security539

5.1Security Considerations for Implementers539

5.2Index of Security Parameters539

6Appendix A: Full WSDL540

7Appendix B: Full XML Schema579

7.1Microsoft.Windows.Ipam.xsd Schema579

7.2Microsoft.Windows.Ipam1.xsd Schema634

7.3schemas.microsoft.com.2003.10.Serialization.Arrays.xsd Schema642

7.4schemas.microsoft.com.2003.10.Serialization.xsd Schema644

7.5System.Collections.Generic.xsd Schema645

7.6System.Net.Sockets.xsd Schema648

7.7System.Net.xsd Schema652

7.8System.xsd Schema652

8Appendix C: Product Behavior653

9Change Tracking654

10Index655

Introduction

This document specifies the IP Address Management (IPAM) Management Protocol. This protocol is used to remotely retrieve and manage the data in the IPAM data store. The IPAM data store consists of the data pertaining to the address space management, which includes the configuration data available with the DHCP and DNS server instances in the network.

Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.

Glossary

This document uses the following terms:

Active Directory domain: A domain hosted on Active Directory. For more information, see [MS-ADTS].

Active Directory forest: See forest.

address category: The categorization of an IP address or an address space based on the communication that it enables. An address (or an address space) can be public when it is globally unique and can be used for communication over the Internet. [IANA-IPV4] specifies the address ranges that belong to this category. An address (or an address space) can be private, in which case it is unique within an enterprise or an autonomous network and cannot be used to communicate with the public network. [RFC1918] specifies the address ranges that belong to this category. For IPv6, the equivalent term for the public address category is the global unicast address space as specified by [RFC4291].

address space management: The activities that manage the IP address space of a network. Management activities include, but are not limited to, reserving and allocating addresses and address ranges to various hosts or portions of the network, or network planning based on current address space utilization.

audit log: A record of activities performed by the Dynamic Host Configuration Protocol (DHCP) server. The name of the audit log file is based on the current day of the week. For example, on Monday the name of the audit log file is DhcpSrvLog-Mon.

audit purge: The maintenance activity of purging the audit data such as DHCP configuration change events, IPAM configuration change events, and IP address tracking events.

binary large object (BLOB): A collection of binary data stored as a single entity in a database.

built-in custom field: A custom field that is predefined in the IPAM data store.

built-in logical group: A logical group that is predefined in the IPAM data store.

configuration audit: The system activity of logging configuration changes initiated by users on an entity in a secure data store to create a record of the configuration change.

configuration audit event: A specific event in the configuration change data store containing information about a configuration change.

custom field: An extensible name-value property that can be tagged as additional metadata with IP address ranges, IP addresses, and servers in IPAM.

custom field value: A value of the custom field.

DHCP configuration audit: The configuration audit generated by the DHCP server to track DHCP configuration change events. Conditions can be specified based on a set of fields that are present in the DHCP client request. The settings are the network configuration parameters (IP address, options, lease duration) that are provided to clients in the DHCP server response.

DHCPv6 stateless client inventory: An inventory of stateless clients being serviced by the DHCPv6 server, maintained in the persistent store.

DUID: A DHCP unique identifier that is used to identify DHCPv6 clients and servers, as specified in [RFC3315] section 9.

event: A discrete unit of historical data that an application exposes that may be relevant to other applications. An example of an event would be a particular user logging on to the computer.

event descriptor: A structure indicating the kind of event. For example, a user logging on to the computer could be one kind of event, while a user logging off would be another, and these events could be indicated by using distinct event descriptors.

event log: A collection of records, each of which corresponds to an event.

EventID: An integer indicating the type of event. For example, a user logging on to the computer could be one type of event while a user logging off would be another type; and these events could be indicated by using distinct EventIDs.

exclusion range: The range of IP addresses in a scope that are not given out to DHCP clients.

forward lookup DNS zone: A zone that consists of pointer (PTR) resource records that provide a mapping of DNS host names to their corresponding IP addresses.

fully qualified domain name (FQDN): An unambiguous domain name (2) that gives an absolute location in the Domain Name System's (DNS) hierarchy tree, as defined in [RFC1035] section 3.1 and [RFC2181] section 11.

globally unique identifier (GUID): A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the GUID. See also universally unique identifier (UUID).

group object: A database object that represents a collection of user and group objects and has a security identifier (SID) value.

initiating operation: A WSDL operation that is the first operation sent by the client.

IP address audit: The information that provides the various activities pertaining to the usage of an IP address on a device or a host.

IP address block: A container defined using the network number as defined in [RFC1519], and prefix length that can be used to organize the overall IP address space in any network. An IP address block can have other IP address blocks as child blocks to define smaller containers that can be used to organize a smaller portion of the same address space.

IP address block utilization: The utilization information calculated as the aggregate size of the assigned address space and utilized address space belonging to an IP address block.

IP address range: A range of contiguous IP address that is part of an IP address space and is assigned for use in various elements of the network in the form of assigned address space. An IP address range is typically configured as a DHCP scope on a DHCP server or as a static address pool for static address assignment to devices and hosts.

IP address range utilization: The size of the utilized address space of an IP address range.

IP address space: The set of all possible Internet addresses or any contiguous subset of Internet addresses.

IPAM Administrators: Users who have the privileges to view all IPAM data and perform all IPAM tasks.

IPAM ASM Administrators: Users who are in the IPAM Users IPAM security group and have the privileges to perform the add and modify address space management operations. Such users are Address Space Management (ASM) Administrators.

IPAM configuration audit: The configuration audit generated for the IPAM-specific configuration changes performed on the IPAM server.

IPAM data store: The database used by the IPAM server to store data relevant for address space management, including information from DHCP and DNS server instances.

IPAM IP Audit Administrators: Users who are in the IPAM Users IPAM security group and have the privileges to view IP address audit information.

IPAM MSM Administrators: Users who are in the IPAM Users IPAM security group and have the privileges to manage DHCP and DNS server instance-specific information. Such users are Multi Server Management (MSM) Administrators.

IPAM security groups: The security principals, as groups of users segregated by role. The IPAM server uses these groups to provide role-based access control over various features of IPAM. The IPAM security groups include IPAM Administrators, IPAM ASM Administrators, IPAM MSM Administrators, IPAM IP Audit Administrators, and IPAM Users.

IPAM server: The machine implementing the IPAM management protocol server.

IPAM task: Any of a set of tasks on the IPAM server which retrieve data from managed servers and IPAM servers to update IPAM views for tracking, monitoring, and managing those servers. These tasks include server discovery for automatic discovery of domain controllers, DHCP servers, and DNS servers; server configuration for collecting configuration information from DHCP and DNS servers; address utilization for collecting address utilization data from DHCP servers; event collection for collecting configuration audit events from DHCP and IPAM servers, user logon events from domain controllers and Network Policy Server (NPS) servers, and IP address audit information from DHCP servers; server availability for collecting service status information from DHCP and DNS servers; service monitoring for collecting DNS zone status events from DNS servers; and address expiry for calculating the expiration state of the addresses in the IPAM data store and logging expiration events.

IPAM Users: Users who have the privileges to view all information in IPAM data store except the IP address audit information.

lease record: An entry in the DHCP server database that defines the IP address that is leased out to a client. The record includes details about the IP address bound to the client, and also contains a collection of other configuration parameters.

logical group: A user-defined hierarchical classification of objects such as IP addresses, IP address ranges, and active servers in the IPAM data store. It is a collection of multivalued custom fields that form the various levels of the hierarchy. Each level of the hierarchy contains the possible values of the custom field at that level.

logical group hierarchy: A hierarchy of custom field values generated from a logical group definition. The logical group defines the custom field used to generate a particular level in the hierarchy. The values of the custom field form the nodes at that particular level.

logical group node: A specific node in the logical group hierarchy. The set of custom field values in the logical group hierarchy from the node to the root of the hierarchy form a criteria. The data that have custom fields associated with them, such as addresses, address ranges, and servers, can be queried for a logical group node. The data that contains all of the custom field values that form the hierarchy for the logical group node are considered to meet the criteria for the logical group node.

management server: The server endpoint of the IPAM Management Protocol.

option definition: Defines an option for a vendor class. The definition consists of two parts: an option ID and an option name.

option ID: A unique integer value used to identify a specific option [RFC2132].

option type: The data format type used for the value of a specific DHCP option value, as specified in [MS-DHCPM] section 2.2.1.1.10. The option definition can contain option values in various format types. Options can be of type BYTE, WORD, DWORD, DWORD_DWORD, IP Address, Unicode String, Binary, or Encapsulated binary format.

provisioning: The process of initially configuring the IPAM data store, which includes configuring the IPAM database, creating IPAM security groups, and configuring IPAM tasks.

reservation: An IP address that is reserved on the DHCP server for assignment to a specific client based on its hardware address. A reservation is used to ensure that a specific DHCP client is always assigned the same IP address.

reverse lookup DNS zone: A zone consisting of pointer (PTR) records that provide a mapping of host IP addresses to their corresponding DNS host names.

schema conversion: The process of changing or upgrading the IPAM data store schema when the version of the IPAM server or the IPAM data store changes.

scope: A range of IP addresses and associated configuration options that are allocated to DHCP clients in a specific subnet.

security account manager (SAM) built-in database: Microsoft-specific terminology for the part of the user account database that contains account information (such as account names and passwords) for accounts and groups that are pre-created at the database installation.

server role: Any of the services that can be provided by a host, including DHCP server, DNS server, Network Policy Server (NPS), and domain controllers.

site: A collection of one or more well-connected (reliable and fast) TCP/IP subnets. By defining sites (represented by site objects) an administrator can optimize both Active Directory access and Active Directory replication with respect to the physical network. When users log in, Active Directory clients find domain controllers (DCs) that are in the same site as the user, or near the same site if there is no DC in the site. See also Knowledge Consistency Checker (KCC). For more information, see [MS-ADTS].

SOAP action: The HTTP request header field used to indicate the intent of the SOAP request, using a URI value. See [SOAP1.1] section 6.1.1 for more information.

SOAP fault: A container for error and status information within a SOAP message. See [SOAP1.2-1/2007] section 5.4 for more information.

SOAP message: An XML document consisting of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. See [SOAP1.2-1/2007] section 5 for more information.

subnet ID: An ID generated by the Dynamic Host Configuration Protocol (DHCP) server. The IPv4 subnet ID is generated by the DHCP server by performing the binary AND operation on the subnet IPv4 address and the IPv4 subnet mask. The IPv6 prefix ID is generated by the DHCP server by converting the least significant 64 bits of the IPv6 address to 0.

trigger: A change of state (for example, reaching a specific time of day) that signals when a task is to run. A task runs when any of its triggers and all of its conditions are satisfied.

Uniform Resource Identifier (URI): A string that identifies a resource. The URI is an addressing mechanism defined in Internet Engineering Task Force (IETF) Uniform Resource Identifier (URI): Generic Syntax [RFC3986].

Uniform Resource Locator (URL): A string of characters in a standardized format that identifies a document or resource on the World Wide Web. The format is as specified in [RFC1738].

user class: User defined classes which contain user specific DHCP options. A default user class is implementation dependent.

vendor class: User defined classes that contain vendor-specific DHCP options. A default vendor class is implementation defined.

WSDL port type: A named set of logically-related, abstract Web Services Description Language (WSDL) operations and messages.

zone: A domain namespace is divided up into several sections called zones [RFC1034] and [RFC2181]. A zone represents authority over a portion of the DNS namespace, excluding any subzones that are below delegations.

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.

References

Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata.

Normative References

We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact [email protected]. We will assist you in finding the relevant information.

[ISO-8601] International Organization for Standardization, "Data Elements and Interchange Formats - Information Interchange - Representation of Dates and Times", ISO/IEC 8601:2004, December 2004, http://www.iso.org/iso/en/CatalogueDetailPage.CatalogueDetail?CSNUMBER=40874&ICS1=1&ICS2=140&ICS3=30

Note There is a charge to download the specification.

[MS-DTYP] Microsoft Corporation, "Windows Data Types".

[MS-EVEN6] Microsoft Corporation, "EventLog Remoting Protocol Version 6.0".

[MS-NMFTB] Microsoft Corporation, ".NET Message Framing TCP Binding Protocol".

[MS-NRTP] Microsoft Corporation, ".NET Remoting: Core Protocol".

[MS-WSPOL] Microsoft Corporation, "Web Services: Policy Assertions and WSDL Extensions".

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt

[SOAP1.2-1/2007] Gudgin, M., Hadley, M., Mendelsohn, N., et al., "SOAP Version 1.2 Part 1: Messaging Framework (Second Edition)", W3C Recommendation 27, April 2007, http://www.w3.org/TR/2007/REC-soap12-part1-20070427/

[SOAP1.2-2/2007] Gudgin, M., Hadley, M., Mendelsohn, N., et al., "SOAP Version 1.2 Part 2: Adjuncts (Second Edition)", W3C Recommendation, April 2007, http://www.w3.org/TR/2007/REC-soap12-part2-20070427

[WSADDCore1.0] Gudgin, M., Hadley, M., and Rogers, T., Eds., "Web Services Addressing 1.0 - Core", W3C Recommendation, May 2006, http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/ws-addr-core.pdf

[WSADDSoapBind1.0] Gudgin, M., Hadley, M., and Rogers, T., Eds., "Web Services Addressing 1.0 - SOAP Binding", W3C Recommendation, May 2006, http://www.w3.org/TR/2006/REC-ws-addr-soap-20060509/ws-addr-soap.pdf

[WSAWSDL] World Wide Web Consortium, "Web Services Addressing 1.0 - WSDL Binding", May 2006, http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/

[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315

[XMLNS-2ED] World Wide Web Consortium, "Namespaces in XML 1.0 (Second Edition)", August 2006, http://www.w3.org/TR/2006/REC-xml-names-20060816/

[XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part 1: Structures", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/

[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/

Informative References

[IANA-IPV4] IANA, "IANA IPv4 Address Space Registry", February 2011, http://www.iana.org/assignments/ipv4-address-space/ipv4-address-space.txt

[ISO-3166] International Organization for Standardization, "Codes for the representation of names of countries and their subdivisions -- Part1: Country codes", ISO 3166-1:2013, November 2013, http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=63545

Note There is a charge to download the specification.

[MS-IPAMM2] Microsoft Corporation, "IP Address Management (IPAM) Management Protocol Version 2".

[MSDN-Tables] Microsoft Corporation, "Tables", http://msdn.microsoft.com/en-us/library/ms737220(VS.85).aspx

[RFC1918] Rekhter, Y., Moskowitz, B., Karrenberg, D., et al., "Address Allocation for Private Internets", BCP 5, RFC 1918, February 1996, http://www.ietf.org/rfc/rfc1918.txt

[RFC2131] Droms, R., "Dynamic Host Configuration Protocol", RFC 2131, March 1997, http://www.ietf.org/rfc/rfc2131.txt

[RFC2132] Alexander, S., and Droms, R., "DHCP Options and BOOTP Vendor Extensions", RFC 2132, March 1997, http://www.ietf.org/rfc/rfc2132.txt

[RFC3315] Droms, R., Bound, J., Volz, B., et al., "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)", RFC 3315, July 2003, http://www.ietf.org/rfc/rfc3315.txt

[RFC3330] IANA, "Special-Use IPv4 Addresses", RFC 3330, September 2002, http://www.rfc-editor.org/rfc/rfc3330.txt

[RFC3513] Hinden, R. and Deering, S., "Internet Protocol Version 6 (IPv6) Addressing Architecture", RFC 3513, April 2003, http://www.ietf.org/rfc/rfc3513.txt

[RFC4291] Hinden, R. and Deering, S., "IP Version 6 Addressing Architecture", RFC 4291, February 2006, http://www.ietf.org/rfc/rfc4291.txt

[RFC4701] Stapp, M., Lemon, T., and Gustafsson, A., "A DNS Resource Record (RR) for Encoding Dynamic Host Configuration Protocol (DHCP) Information (DHCID RR)", RFC 4701, October 2006, http://www.ietf.org/rfc/rfc4701.txt

[RFC4862] Thomson, S., Narten, T., and Jinmei, T., "IPv6 Stateless Address Autoconfiguration", RFC 4862, September 2007, http://www.rfc-editor.org/rfc/rfc4862.txt

Overview

This protocol consists of management client and the management server roles. The client and server form the end-points of the protocol. The management client performs remote management of the data in the IPAM data store by communicating with the management server using this protocol. The management server performs the management operations on the data in the IPAM data store on behalf of the management client. As shown in the following figure, the IPAM tasks entity is not part of this protocol. IPAM tasks interact with the DHCP and DNS servers in the network to gather information from the address space management in an implementation specific manner and add them to the IPAM data store.

Figure 1: Overview

Relationship to Other Protocols

The IPAM Management Protocol uses SOAP message for formatting the requests and responses as specified in [SOAP1.2-1/2007] and [SOAP1.2-2/2007]. These SOAP messages are sent over the .NET Message Framing TCP Binding Protocol ([MS-NMFTB]) which is built on top of TCP/IP protocol.

The following diagram shows the underlying messaging and transport stack that is being used by this protocol.

Figure 2: Protocol Stack Diagram

Prerequisites/Preconditions

It is assumed that the protocol client already knows the URL of the protocol server for connecting to the various port types exposed by the protocol server.

The protocol also assumes that the authentication has been performed by the underlying protocols.

Applicability Statement

This protocol is only applicable for the operations between the management client and the management server.

The functioning of the IPAM tasks and the IPAM data store are implementation specific and are outside the scope of this protocol.

The host(s) that form the protocol client or the server have to be part of an Active Directory domain belonging to the same Active Directory forest.

Versioning and Capability Negotiation

This document covers versioning issues in the following areas:

Localization: This protocol includes text strings in various messages. Localization considerations for such strings are specified in section 2.2 and section 3.

Protocol Versions: This protocol is not versioned.

Capability Negotiation: This protocol does not support version negotiation or any other means of negotiating capabilities.

This document specifies IPAM Management Protocol Version 1. It is not interoperab

winprotocoldoc.blob.core.windows.net... · web view[ms-ipamm]: ip address management (ipam)...

Documents