web view[ms-ipamm2]: ip address management (ipam) management protocol version 2. intellectual...

1569
[MS-IPAMM2]: IP Address Management (IPAM) Management Protocol Version 2 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] . § License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map . § 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. 1 / 1569 [MS-IPAMM2] - v20170601 IP Address Management (IPAM) Management Protocol Version 2 Copyright © 2017 Microsoft Corporation Release: June 1, 2017

Upload: buituong

Post on 08-Feb-2018

239 views

Category:

Documents


9 download

TRANSCRIPT

[MS-IPAMM2]:

IP Address Management (IPAM) Management Protocol Version 2

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].

License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map.

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.

Support. For questions and support, please contact [email protected].

Revision Summary

Date

Revision History

Revision Class

Comments

8/8/2013

1.0

New

Released new document.

11/14/2013

2.0

Major

Significantly changed the technical content.

2/13/2014

3.0

Major

Significantly changed the technical content.

5/15/2014

3.0

None

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

6/30/2015

4.0

Major

Significantly changed the technical content.

10/16/2015

5.0

Major

Significantly changed the technical content.

7/14/2016

6.0

Major

Significantly changed the technical content.

6/1/2017

7.0

Major

Significantly changed the technical content.

Table of Contents

1Introduction50

1.1Glossary50

1.2References56

1.2.1Normative References56

1.2.2Informative References57

1.3Overview58

1.4Relationship to Other Protocols58

1.5Prerequisites/Preconditions59

1.6Applicability Statement59

1.7Versioning and Capability Negotiation59

1.8Vendor-Extensible Fields59

1.9Standards Assignments59

2Messages60

2.1Transport60

2.2Common Message Syntax60

2.2.1Namespaces60

2.2.2Messages61

2.2.2.1Common SOAP Fault61

2.2.2.2Keepalive62

2.2.3Elements62

2.2.4Complex Types62

2.2.4.1AccessScope97

2.2.4.2AccessScopeToUserRoleMapping98

2.2.4.3ActiveServerV4LogicalGroup98

2.2.4.4ActiveServerV4LogicalGroupNode98

2.2.4.5ActiveServerV6LogicalGroup99

2.2.4.6ActiveServerV6LogicalGroupNode99

2.2.4.7AddressSpace99

2.2.4.8AddressSpaceByFilterEnumerationParameters100

2.2.4.9AddressSpaceEnumerationParameters101

2.2.4.10AddScopesToSuperscopeParameters101

2.2.4.11ApplyDhcpScopeConfigurationparameters101

2.2.4.12ApplyDhcpServerConfigurationParameters102

2.2.4.13ArrayOfAccessScopeToUserRoleMapping102

2.2.4.14ArrayOfAddressSpace102

2.2.4.15ArrayOfCustomField103

2.2.4.16ArrayOfCustomFieldAssociation103

2.2.4.17ArrayOfCustomFieldPartialValue103

2.2.4.18ArrayOfCustomFieldValue103

2.2.4.19ArrayOfDhcpExclusionRange104

2.2.4.20ArrayOfDhcpFailoverOperations104

2.2.4.21ArrayOfDhcpFilter104

2.2.4.22ArrayOfDhcpFindAndReplaceOption104

2.2.4.23ArrayOfDhcpOption104

2.2.4.24ArrayOfDhcpOptionDefinition105

2.2.4.25ArrayOfDhcpPolicyRangeV4105

2.2.4.26ArrayOfDhcpPolicyV4105

2.2.4.27ArrayOfDhcpReservation105

2.2.4.28ArrayOfDhcpScope105

2.2.4.29ArrayOfDhcpScopeV4106

2.2.4.30ArrayOfDhcpServer106

2.2.4.31ArrayOfDhcpServerV4106

2.2.4.32ArrayOfDhcpSuperscopeV4106

2.2.4.33ArrayOfDhcpUserClass107

2.2.4.34ArrayOfDhcpVendorClass107

2.2.4.35ArrayOfDiscoveryConfig107

2.2.4.36ArrayOfDnsConditionalForwarder107

2.2.4.37ArrayOfDnsResourceRecord107

2.2.4.38ArrayOfDnsReverseLookupZone108

2.2.4.39ArrayOfDnsZone108

2.2.4.40ArrayOfEntityStatus108

2.2.4.41ArrayOfGatewayAddress108

2.2.4.42ArrayOfIpamAdminOperation109

2.2.4.43ArrayOfIpamForest109

2.2.4.44ArrayOfIpamGpoError109

2.2.4.45ArrayOfIpamGpoErrorInfo109

2.2.4.46ArrayOfIpamIPAddress109

2.2.4.47ArrayOfIpamObject110

2.2.4.48ArrayOfIpamUpgradeValidationRuleStatus110

2.2.4.49ArrayOfIPBlock110

2.2.4.50ArrayOfIPRange110

2.2.4.51ArrayOfIPSubnet110

2.2.4.52ArrayOfIPUtilization111

2.2.4.53ArrayOfLogicalGroupField111

2.2.4.54ArrayOfLogicalGroupNode111

2.2.4.55ArrayOfPolicyOperations112

2.2.4.56ArrayOfReservationOperations112

2.2.4.57ArrayOfServerInfo112

2.2.4.58ArrayOfServerRole112

2.2.4.59ArrayOfSuperscopeOperations113

2.2.4.60ArrayOfTaskInfo113

2.2.4.61AuditPurgeSettings113

2.2.4.62BaseDnsServerZone113

2.2.4.63BaseDnsZone115

2.2.4.64BaseIpamObject116

2.2.4.65ChangeDatabaseSettingsNotAllowedForDBTypesIpamExceptionData116

2.2.4.66ConfigurationAuditEnumerationParameters116

2.2.4.67ConfigurationAuditRecord119

2.2.4.68ConflictingIPAddressFailureIpamExceptionData120

2.2.4.69ConflictingIPBlockFailureIpamExceptionData121

2.2.4.70ConflictingIPRangeFailureIpamExceptionData121

2.2.4.71CreateDhcpFiltersParameters122

2.2.4.72CreateDhcpReservationParameters122

2.2.4.73CreateDhcpScopeParameters122

2.2.4.74CreateDhcpScopePolicyParameters123

2.2.4.75CreateDhcpServerPolicyParameters123

2.2.4.76CreateDnsResourceRecordsParameters123

2.2.4.77CreateDnsZoneParameters124

2.2.4.78CreateIpamIPAddressParameters124

2.2.4.79CustomerAddressSpace125

2.2.4.80CustomField125

2.2.4.81CustomFieldAssociation126

2.2.4.82CustomFieldAssociationEnumerationParameters126

2.2.4.83CustomFieldEnumerationParameters126

2.2.4.84CustomFieldPartialValue127

2.2.4.85CustomFieldValue127

2.2.4.86DatabaseLocaleMismatchIpamExceptionData128

2.2.4.87DatabaseSchemaVersionMismatchIpamExceptionData128

2.2.4.88DatabaseServerEditionNotSupportedIpamExceptionData129

2.2.4.89DatabaseServerVersionNotSupportedIpamExceptionData129

2.2.4.90DeleteDhcpFiltersParameters130

2.2.4.91DeleteDhcpReservationCollectionParameters130

2.2.4.92DeleteDhcpReservationParameters130

2.2.4.93DeleteDhcpScopeParameters131

2.2.4.94DeleteDnsResourceRecordsParameters131

2.2.4.95DeleteDnsZonesParameters132

2.2.4.96DeletePolicyParameters132

2.2.4.97DeleteSuperscopesParameters132

2.2.4.98DhcpEffectiveScopePoliciesEnumerationParameters133

2.2.4.99DhcpEffectiveServerPoliciesEnumerationParameters133

2.2.4.100DhcpExclusionRange133

2.2.4.101DhcpExclusionRangeCollection134

2.2.4.102DhcpExclusionRangeV4134

2.2.4.103DhcpExclusionRangeV6135

2.2.4.104DhcpFailover135

2.2.4.105DhcpFailoverAl