Share via

2.2.4 Complex Types

The following summarizes the set of common XML schema complex types defined in this specification. XML schema complex type definitions that are specific to a particular operation are described with the operation.

Complex type/Description

  • AccessScope
    Allows extended attributes on a BaseIpamObject type. It defines the scope of entities in IPAM data store that a user can access. It also defines the hierarchy of access scopes in IPAM.

  • AccessScopeToUserRoleMapping
    Allows extended attributes on a BaseIpamObject type. It describes an access policy, which is an association between a user role and an access scope.

  • ActiveServerV4LogicalGroup
    Allows extended attributes on a LogicalGroup type. It contains the definition of the logical group on server instances with IPv4-specific details, which are enabled for management in the IPAM data store.

  • ActiveServerV4LogicalGroupNode
    Allows extended attributes on a LogicalGroupNode. It defines the custom field value at a specific level in the logical group hierarchy. It defines the criteria for categorizing server instances with IPv4-specific details, which are enabled for management.

  • ActiveServerV6LogicalGroup
    Allows extended attributes on a LogicalGroup type. It contains the definition of the logical group on server instances with IPv6-specific details, which are enabled for management in the IPAM data store.

  • ActiveServerV6LogicalGroupNode
    Allows extended attributes on a LogicalGroupNode type. It defines the custom field value at a specific level in the logical group hierarchy. It defines the criteria for categorizing server instances with IPv6-specific details that are enabled for management.

  • AddressSpace
    A set of connected networks that are reachable (routable) from one another. In IPAM, all IP blocks, subnets, ranges, and IP addresses that belong to such a set of networks are grouped together within an AddressSpace container. To support network virtualization, IPAM provides two types of address spaces: Provider and Customer. By default, all IPAM entities reside in a built-in address space called DefaultIPAddressSpace. Any conventional (nonvirtualized) network entity such as a subnet or IP address range are in the default address space.

  • AddressSpaceByFilterEnumerationParameters
    Extends EnumerationParametersBase and specifies the criteria used to filter the list of address spaces before enumeration.

  • AddressSpaceEnumerationParameters
    Extends EnumerationParametersBase and specifies the parameters to be used for enumerating the address spaces.

  • AddScopesToSuperscopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameter. It creates objects whose OperationId is AddScopesToSuperscope. It is used to associate a collection of DHCP scopes to a DhcpSuperscopeV4 type.

  • ApplyDhcpScopeConfigurationparameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ApplyScopeConfigurationTemplate. It associates the DhcpScopeTemplateConfiguration details with a list of scope IDs belonging to the same AddressFamily.

  • ApplyDhcpServerConfigurationParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ApplyServerConfigurationTemplate. It associates the DhcpServerTemplateConfiguration details with a list of server IDs belonging to the same AddressFamily.

  • ArrayOfAccessScopeToUserRoleMapping
    Defines a list of AccessScopeToUserRoleMapping complex type.

  • ArrayOfAddressSpace
    Defines an array of AddressSpace complex type.

  • ArrayOfCustomField
    Defines an array of CustomField complex type.

  • ArrayOfCustomFieldAssociation
    Defines an array of CustomFieldAssociation complex types.

  • ArrayOfCustomFieldPartialValue
    Defines an array of CustomFieldPartialValue complex type.

  • ArrayOfCustomFieldValue
    Defines an array of CustomFieldValue complex type.

  • ArrayOfDhcpExclusionRange
    Defines an array of DhcpExclusionRange complex type. The elements in the array MUST be either a DhcpExclusionRangeV4 complex type or a DhcpExclusionRangeV6 complex type.

  • ArrayOfDhcpFailoverOperations
    Defines an array of DhcpFailoverOperations.

  • ArrayOfDhcpFilter
    Defines an array of DhcpFilter.

  • ArrayOfDhcpFindAndReplaceOption
    Defines an array of DhcpFindAndReplaceOptions.

  • ArrayOfDhcpOption
    Defines an array of DhcpOption complex type. The elements in the array MUST be either a DhcpOptionV4 or a DhcpOptionV6 complex type.

  • ArrayOfDhcpOptionDefinition
    Defines an array of DhcpOptionDefinitions. The elements in the array MUST be either DhcpOptionDefinitionV4 or DhcpOptionDefinitionV6 complex type.

  • ArrayOfDhcpPolicyRangeV4
    Defines an array of DhcpPolicyRangeV4 complex type.

  • ArrayOfDhcpPolicyV4
    Defines an array of DhcpPolicyV4 complex type.

  • ArrayOfDhcpReservation
    Defines an array of DhcpReservation complex type. The elements in the array MUST be of type DhcpReservation.

  • ArrayOfDhcpScope
    Defines an array of DhcpScope complex type.

  • ArrayOfDhcpScopeV4
    Defines an array of DhcpScopeV4 complex types.

  • ArrayOfDhcpServer
    Defines an array of DhcpServer complex type. The elements in the array MUST be either a DhcpServerV4 or a DhcpServerV6 complex type.

  • ArrayOfDhcpServerV4
    Defines an array of DhcpServerV4 complex type.

  • ArrayOfDhcpSuperscopeV4
    Defines an array of DhcpSuperscopeV4 complex type.

  • ArrayOfDhcpUserClass
    Defines an array of DhcpUserClass complex type. The elements in the array MUST be either a DhcpUserClassV4 or a DhcpUserClassV6 complex type.

  • ArrayOfDhcpVendorClass
    Defines an array of DhcpVendorClass complex type. The elements in the array MUST be either a DhcpVendorClassV4 or a DhcpVendorClassV6 complex type.

  • ArrayOfDiscoveryConfig
    Defines an array of DiscoveryConfig complex type.

  • ArrayOfDnsConditionalForwarder
    Defines an array of DnsConditionalForwarders.

  • ArrayOfDnsResourceRecord
    Defines an array of DnsResourceRecord types.

  • ArrayOfDnsReverseLookupZone
    Defines an array of DnsReverseLookupZones.

  • ArrayOfDnsZone
    Defines an array of DnsZones.

  • ArrayOfEntityStatus
    Defines an array of EntityStatus complex type.

  • ArrayOfGatewayAddress
    Defines an array of GatewayAddress complex type.

  • ArrayOfIpamAdminOperation
    Defines an array of IpamAdminOperation complex type.

  • ArrayOfIpamForest
    Defines an array of an IpamForest complex type.

  • ArrayOfIpamGpoError
    Defines an array of IpamGpoError complex type.

  • ArrayOfIpamGpoErrorInfo
    Defines an array of IpamGpoErrorInfo complex type.

  • ArrayOfIpamIPAddress
    Defines an array of IpamIPAddress complex type. The elements in the array MUST be either an IpamIPv4Address or an IpamIPv6Address complex type.

  • ArrayOfIpamObject
    Defines an array of IpamObject complex type. The elements in the array MUST be of a complex type that either directly or indirectly extends IpamObject.

  • ArrayOfIpamUpgradeValidationRuleStatus
    Defines an array of IpamUpgradeValidationRuleStatus complex type.

  • ArrayOfIPBlock
    Defines an array of IPBlock. The elements in the array MUST be either IPv4Block or IPv6Block complex types.

  • ArrayOfIPRange
    Defines an array of IPRange. The elements in the array MUST be either an IPv4Range or an IPv6Range complex type.

  • ArrayOfIPSubnet
    Defines an array of IPSubnet complex type. The elements in the array MUST be either an IPv4Subnet or an IPv6Subnet complex type.

  • ArrayOfIPUtilization
    Defines an array of IPUtilization complex type. The elements in the array MUST be either an IPv4Utilization or IPv6Utilization complex type.

  • ArrayOfLogicalGroupField
    Defines an array of LogicalGroupField complex type.

  • ArrayOfLogicalGroupNode
    Defines an array of LogicalGroupNode complex type. The elements in the array MUST extend LogicalGroupNode.

  • ArrayOfPolicyOperations
    Defines an array of PolicyOperations complex type.

  • ArrayOfReservationOperations
    Specifies an array of simple type ReservationOperations that specifies the operations that can be performed for DHCP reservations. This is used by the management server as a part of MsmDhcpScopeCreateOrEditAddress Reservation to identify the changes that have to be committed to the IPAM data store for the specified DhcpReservation value.

  • ArrayOfServerInfo
    Defines an array of ServerInfo complex type.

  • ArrayOfServerRole
    Defines an array of ServerRole complex type or the complex types that extend the ServerRole complex type.

  • ArrayOfSuperscopeOperations
    Defines an array of SuperscopeOperations complex type.

  • ArrayOfTaskInfo
    Defines an array of TaskInfo complex type

  • AuditPurgeSettings
    Specifies the configuration to be used for performing the audit purge operation.

  • BaseDnsServerZone
    Specifies the properties of a zone hosted on a DNS server. This consists of the properties common to both DnsServerZone as well as DnsServerReverseZone complex types that extend the BaseDnsServerZone.

  • BaseDnsZone
    Specifies the properties of a DNS zone. This consists of the properties common to both DnsZone as well as DnsReverseLookupZone complex types that extend the BaseDnsZone.

  • BaseIpamObject
    Contains the common properties that are applicable to most of the complex types defined in this protocol. BaseIpamObject allows extended attributes on the IpamObject that it extends.

  • ChangeDatabaseSettingsNotAllowedForDBTypesIpamExceptionData
    Extends the IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorChangeDatabaseSettingsNotAllowedForDBTypes.

  • ConfigurationAuditEnumerationParameters
    Specifies the enumeration criteria for the configuration audit information.

  • ConfigurationAuditRecord
    Specifies a single configuration audit event information. The configuration audit record can be used to represent both an IPAM configuration audit as well as a DHCP configuration audit event.

  • ConflictingIPAddressFailureIpamExceptionData
    Specifies the information pertaining to the IP address instance overlap. This is used as the IpamExceptionData to provide more fault-specific information when an operation fails because of IP address instance overlap.

  • ConflictingIPBlockFailureIpamExceptionData
    Specifies the information pertaining to the IP address block instance overlap.

  • ConflictingIPRangeFailureIpamExceptionData
    Specifies the information pertaining to the IP address range instance overlap.

  • CreateDhcpFiltersParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is CreateDhcpFilters. It associates a list of DhcpFilter instances to the list of DhcpServer's on which they have been created.

  • CreateDhcpReservationParameters
    Specifies the set of parameters to be used in creating a new DHCP reservation.

  • CreateDhcpScopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is CreateDhcpScope and associates them to an DhcpScope.

  • CreateDhcpScopePolicyParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is CreateDhcpScopePolicy. It associates a policy of type DhcpPolicyV4 to a collection of scopes of type DhcpScopev4.

  • CreateDhcpServerPolicyParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is CreateDhcpServerPolicy. It associates a policy of type DhcpPolicyV4 to a collection of servers of type DhcpServerv4.

  • CreateDnsResourceRecordsParameters
    Specifies the DNS resource record to be created and the DNS server and DNS zone on which it is to be created.

  • CreateDnsZoneParameters
    Specifies the DNS zone to be created and the DNS server on which it is to be created.

  • CreateIpamIPAddressParameters
    Specifies the information pertaining to the operation CreateIpamIpAddress. This is used as a callback.

  • CustomerAddressSpace
    Extends the AddressSpace type to include information specific to a Customer address space.

  • CustomField
    Specifies a single custom field information.

  • CustomFieldAssociation
    Specifies an association between two custom fields defined in IPAM.

  • CustomFieldAssociationEnumerationParameters
    Extends the EnumerationParametersBase complex type. It specifies the parameters used to enumerate custom field associations that exist in IPAM data store.

  • CustomFieldEnumerationParameters
    Specifies the parameters to be used for enumerating the custom fields.

  • CustomFieldPartialValue
    Specifies the custom field value with minimum information when compared to that of CustomFieldValue. The management server uses this to return the custom field values during the enumeration operations.

  • CustomFieldValue
    Specifies a custom field value.

  • DatabaseLocaleMismatchIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorDatabaseLocaleMismatch.

  • DatabaseSchemaVersionMismatchIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorDatabaseSchemaVersionMismatch.

  • DatabaseServerEditionNotSupportedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorDatabaseServerEditionNotSupported.

  • DatabaseServerVersionNotSupportedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whoseIpamExceptionId is IpamApiErrorDatabaseServerVersionNotSupported.

  • DeleteDhcpFiltersParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is DeleteDhcpFilters. It identifies the DhcpFilter instances to be deleted on a server.

  • DeleteDhcpReservationCollectionParameters
    Specifies the set of parameters to be used in deleting a collection of DHCP reservations.

  • DeleteDhcpReservationParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objectswhose OperationId is DeleteDhcpReservationCollection. It identifies a collection of DHCP reservations to be deleted and the post processing to be done after deleting them.

  • DeleteDhcpScopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objectswhose OperationId is DeleteDhcpScope and associates them to an DhcpScope.

  • DeleteDnsResourceRecordsParameters
    Specifies the DNS resource record to be deleted and the DNS server and DNS zone from which it is tobe deleted.

  • DeleteDnsZonesParameters
    Specifies the DNS zones to be deleted and their zone type.

  • DeletePolicyParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is DeletePolicy and associates them to a collection of policies of type DhcpPolicyV4.

  • DeleteSuperscopesParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is DeleteSuperscopes. It identifies the collection of DhcpSuperscopeV4 instances to be deleted.

  • DhcpEffectiveScopePoliciesEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpPolicy and associates them to a scope of type DhcpScopeV4.

  • DhcpEffectiveServerPoliciesEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpPolicy and associates them to an DhcpServerV4 object.

  • DhcpExclusionRange
    Used to specify the DHCP exclusion range.

  • DhcpExclusionRangeCollection
    Specifies a collection of DHCP exclusion ranges.

  • DhcpExclusionRangeV4
    Specifies a DHCP exclusion range for an IPv4-specific DHCP scope.

  • DhcpExclusionRangeV6
    Specifies a DHCP exclusion range for an IPv6-specific DHCP scope.

  • DhcpFailover
    Allows extended attributes on a BaseIpamObject and models a DHCP Failover relationship.

  • DhcpFailoverAllEnumerationParameters
    Extends EnumerationParametersBase type. It creates objects whose ObjectType is DhcpFailover.

  • DhcpFailoverByServerIdsEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpFailover and associates them to a list of ServerIds whose type is long int.

  • DhcpFailoverDeleteParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It associates a DhcpFailover object with a force delete flag. The force delete flag identifies whether the failover relationship deletion can be attempted on the selected server even if it fails on the partner server.

  • DhcpFailoverEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpFailover and associates a DhcpFailover object to the same.

  • DhcpFailoverParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It associates an DhcpFailover object to an object of this type.

  • DhcpFailoverRemoveScopesParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It associates its objects with a list of DhcpScope type objects and a bool member, Force. The Force parameter identifies whether the failover config removal can be attempted on the selected scopes.

  • DhcpFailoverScopesEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpScope and associates them to an DhcpFailover object.

  • DhcpFailoverWithScopesParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It associates its objects with a list of DhcpScope objects and an DhcpFailover object.

  • DhcpFilter
    Describes a DHCP filter and associates its various properties into one instance.

  • DhcpFilterAllEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpFilter. It is used to get the filter details of a DHCP server.

  • DhcpFilterByServerIdsEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpFilter. It is used to get the details of filters of server IDs.

  • DhcpFindAndReplaceOption
    Creates an association between the DhcpOption and its old value and the new value with which it is to be replaced. The old and new values are represented by Object types.

  • DhcpFindAndReplaceOptionV4
    This is a simple derivation of DhcpFindAndReplaceOption with no new attributes.

  • DhcpFindAndReplaceOptionV6
    This is a simple derivation of DhcpFindAndReplaceOption with no new attributes.

  • DhcpMsmOverallCompletionStatus
    Allows extended attributes on an IpamObject type.

  • DhcpOption
    Specifies the common information pertaining to a DHCP option which is independent of whether the option is IPv4-specific or IPv6-specific.

  • DhcpOptionCollection
    Specifies a collection of DHCP options.

  • DhcpOptionDefinition
    Specifies the various properties of a DHCP option definition.

  • DhcpOptionDefinitionCollection
    Specifies a collection of DhcpOptionDefinition complex type.

  • DhcpOptionDefinitionV4
    Allows extension of the DhcpOptionDefinition complex type. Specifies the option definitions associated with the IPv4-specific DHCP server instance.

  • DhcpOptionDefinitionV6
    Allows extension of the DhcpOptionDefinition complex type. Specifies the option definitions associated with the IPv6-specific DHCP server instance.

  • DhcpOptionV4
    Allows extension of the DhcpOption complex type. Specifies the DHCP option associated with the IPv4-specific DHCP server or scope instance.

  • DhcpOptionV6
    Allows extension of the DhcpOption complex type. Specifies the DHCP option associated with the IPv6-specific DHCP server or scope instance.

  • DhcpPoliciesByDhcpServerIdListEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpPolicy and associates them to a collection of DhcpServerV4 objects.

  • DhcpPoliciesEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpPolicy.

  • DhcpPolicyConditionV4
    Allows extended attributes on a BaseIpamObject type.

  • DhcpPolicyRangeV4
    Allows extended attributes on a BaseIpamObject type. It creates an association between the record Id of the range and its start and end IPAddress objects.

  • DhcpPolicyV4
    Allows extended attributes on a BaseIpamObject type.

  • DhcpReservation
    Specifies the details associated with a DHCP reservation.

  • DhcpReservationDataFormatter
    Used to format the fields of a DHCP reservation into a string used to display the result of operations. The string is formatted to include the scope ID and the server name.

  • DhcpReservationForIpBlockEnumerationParameters
    Specifies the criteria for enumerating the DHCP reservations belonging to a particular address block.

  • DhcpReservationTemplateConfiguration
    Used for editing operations on a collection of DHCP reservations. It specifies the properties of the reservation that need to be changed for the collection in a multiselect edit operation.

  • DhcpReservationV4
    Extends the DhcpReservation complex type and specifies the properties associated with an IPv4 reservation.

  • DhcpReservationV4TemplateConfiguration
    Extends the DhcpReservationTemplateConfiguration complex type and is used for editing operations on a collection of DHCP IPV4 reservations. It specifies the properties of the IPv4 reservation to be changed for the collection in a multiselect edit operation.

  • DhcpReservationV6
    Extends the DhcpReservation complex type. Specifies the properties associated with an IPv6 reservation.

  • DhcpReservationV6TemplateConfiguration
    Extends the DhcpReservationTemplateConfiguration complex type and is used for editing operations on a collection of DHCP IPV6 reservations. It specifies the properties of the IPv6 reservation that need to be changed for the collection in a multiselect edit operation.

  • DhcpScope
    Specifies the details associated with a DHCP scope.

  • DhcpScopeAllEnumerationParameters
    Specifies the criteria to be used for enumerating the DHCP scopes.

  • DhcpScopeAssociatedWithVendorClassesEnumerationParameters
    Specifies the criteria to use for enumerating the scopes that are associated with a given set of vendor classes.

  • DhcpScopeByPrefixAndServerNameEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase. Specifies the criteria to use for enumerating the scopes with a specified prefix and belonging to a particular DHCP server.

  • DhcpScopeForIpBlockEnumerationParameters
    Specifies the criteria to use for enumerating the scopes belonging to a particular address block.

  • DhcpScopeObjectSpecificEnumerationParameters
    Specifies the criteria to be used for enumerating the scopes that are associated with a given set of DHCP Reservations or DHCP Policies.

  • DhcpScopePoliciesWithoutRangesEnumerationParameters
    Specifies the criteria to be used for enumerating the policies that do not have ranges, in a given DHCP scope.

  • DhcpScopesByDhcpServerIdListEnumerationParameters
    Specifies the criteria for enumerating the scopes that belong to a set of DHCP servers.

  • DhcpScopeTemplateConfiguration
    Used for editing operations on a collection of DHCP scopes. It specifies the properties of the scope that need to be changed in a multiselect edit operation.

  • DhcpScopeUnmappedEnumerationParameters
    Specifies the criteria to be used to enumerate the scopes that are not mapped to any address block.

  • DhcpScopeV4
    Allows the extension of the section DhcpScope complex type. Specifies a scope for specifying an IPv4 address assignment with DHCP.

  • DhcpScopeV4TemplateConfiguration
    Used for editing operations on a collection of DHCP IPv4 Scopes. It specifies the properties of the scope that need to be changed for the collection in a multiselect edit operation.

  • DhcpScopeV6
    Allows the extension of the DhcpScope complex type. Specifies a scope for specifying IPv6 address assignment with DHCP.

  • DhcpScopeV6TemplateConfiguration
    Used for editing a collection of DHCP IPv6 Scopes. It specifies the properties of the scope that need to be changed in a multiselect edit operation.

  • DhcpServer
    Specifies the common details of a DHCP server instance.

  • DhcpServerAllEnumerationParameters
    Specifies the parameters used for enumerating the DhcpServer instances.

  • DhcpServerByServerInfoIdsEnumerationParameters
    Specifies the record identifiers of ServerInfo instances for which the DhcpServer instances are to be enumerated.

  • DhcpServerTemplateConfiguration
    Allows extended attributes on a section BaseIpamObject type.

  • DhcpServerV4
    Allows specifying extensions to the DhcpServer complex type. Specifies the IPv4-specific information of the DHCP server instance.

  • DhcpServerV4TemplateConfiguration
    Allows extended attributes on a DhcpServerTemplateConfiguration type. It creates objects whose dnsNotRequestingClientsUpdateType is DhcpDnsNotRequestingClientsUpdateType.None.

  • DhcpServerV6
    Extends the DhcpServer complex type. Specifies the IPv6-specific information of the DHCP server instance.

  • DhcpServerV6TemplateConfiguration
    Allows extended attributes on a DhcpServerTemplateConfiguration type.

  • DhcpSuperscopeByDhcpServerIdListEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpSuperscope.

  • DhcpSuperscopeBySuperscopeAndServerNameEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase. Specifies the criteria to use for enumerating the superscope with a specified name and belonging to a particular DHCP server.

  • DhcpSuperscopeEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is DhcpSuperscope.

  • DhcpSuperscopeV4
    Allows extended attributes on a section BaseIpamObject type. This defines the properties of a DHCP superscope.

  • DhcpUserClass
    Specifies the common properties of a user class.

  • DhcpUserClassCollection
    Specifies a collection of section DhcpUserClass complex types.

  • DhcpUserClassV4
    Allows the extension of the DhcpUserClass complex type. Specifies the DhcpUserClass instance associated with the IPv4-specific DhcpServer instance.

  • DhcpUserClassV6
    Allows the extension of the DhcpUserClass complex type. Specifies the DhcpUserClass instance associated with the IPv6- specific DhcpServer instance.

  • DhcpVendorClass
    Specifies the common properties of a vendor class.

  • DhcpVendorClassCollection
    Specifies a collection of section DhcpVendorClass complex types.

  • DhcpVendorClassV4
    Allows the extension of the DhcpVendorClass complex type. Specifies the DhcpVendorClass instance associated with the IPv4-specific DhcpServer instance.

  • DhcpVendorClassV6
    Allows the extension of the DhcpVendorClass complex type. Specifies the DhcpVendorClass instance associated with the IPv6-specific DhcpServer instance.

  • DiscoveryConfig
    Describes the discovery configuration for a specific domain.

  • DiscoverySubnetEnumerationParameters
    Specifies the criteria based on which the subnets for grouping the discovered servers are to be enumerated.

  • DnsConditionalForwarder
    Allows extended attributes on a BaseIpamObject type. Specifies the properties of a DNS conditional forwarder.

  • DnsConditionalForwarderByFiltersEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase. Specifies the filter criteria for enumerating DNS conditional forwarders.

  • DnsConditionalForwarderEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase. Specifies the criteria for enumerating DNS conditional forwarders.

  • DnsConditionalForwarderFormatter
    Allows extended attributes on an IpamObject type. It represents the formatted DNS conditional forwarder name and server name.

  • DnsConditionalForwardersParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It represents the input parameters for DNS conditional forwarder operations.

  • DnsResourceRecord
    Specifies the properties of a DNS resource record. This consists of the properties common to all DNS resource record types.

  • DnsResourceRecordAsmFormatter
    Allows extended attributes on an IpamObject type. It represents the DNS resource record name and zone name in a formatted manner.

  • DnsResourceRecordData
    A base class that can be extended by various DNS resource record complex types to specify the DNS resource record information.

  • DnsResourceRecordDataA
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type A.

  • DnsResourceRecordDataAaaa
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type AAAA.

  • DnsResourceRecordDataAfsdb
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type AFSDB.

  • DnsResourceRecordDataAtma
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type ATMA.

  • DnsResourceRecordDataCname
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type CNAME.

  • DnsResourceRecordDataDhcid
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type DHCID.

  • DnsResourceRecordDataDname
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type DNAME.

  • DnsResourceRecordDataHinfo
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type HINFO.

  • DnsResourceRecordDataIsdn
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type ISDN.

  • DnsResourceRecordDataMx
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type MX.

  • DnsResourceRecordDataNs
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type NS.

  • DnsResourceRecordDataPtr
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type PTR.

  • DnsResourceRecordDataRp
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type RP.

  • DnsResourceRecordDataRt
    Extends the  DnsResourceRecordData . It specifies the details associated with a DNS resource record of type RT.

  • DnsResourceRecordDataSoa
    Extends the  DnsResourceRecordData. It specifies the details associated with a DNS resource record of type SOA.

  • DnsResourceRecordDataSrv
    Extends the  DnsResourceRecordData. It specifies the details associated with a DNS resource record of type SRV.

  • DnsResourceRecordDataTxt
    Extends the  DnsResourceRecordData. It specifies the details associated with a DNS resource record of type TXT.

  • DnsResourceRecordDataWins
    Extends the  DnsResourceRecordData. It specifies the details associated with a DNS resource record of type WINS.

  • DnsResourceRecordDataWinsr
    Extends the  DnsResourceRecordData. It specifies the details associated with a DNS resource record of type WINS-R.

  • DnsResourceRecordDataWks
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type WKS.

  • DnsResourceRecordDataX25
    Extends the DnsResourceRecordData. It specifies the details associated with a DNS resource record of type X.25.

  • DnsResourceRecordEnumerationParameters
    Specifies the criteria for enumerating DNS resource records.

  • DnsResourceRecordFilterEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase. Specifies the filter criteria for enumerating DNS resource records.

  • DnsResourceRecordFormatter
    Used to format the fields of a DNS resource record into a string used to display the result of operations. The string is formatted to include the record name, server name and zone name of the DNS resource record to uniquely identify it.

  • DnsResourceRecordIsAlreadyMappedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiDnsResourceRecordIsAlreadyMapped.

  • DnsReverseLookupZone
    Specifies the information pertaining to a single instance of a reverse lookup DNS zone. It allows extending the BaseDnsZone complex type.

  • DnsReverseLookupZoneEnumerationParameters
    Specifies the criteria to be used for enumerating the reverse lookup DNS zones.

  • DnsServer
    Specifies the DNS server instance properties.

  • DnsServerByServerInfoIdsEnumerationParameters
    Specifies the parameters to enumerate the DnsServer instances based on the record identifiers of the ServerInfo instances.

  • DnsServerEnumerationParameters
    Specifies the criteria to be used for enumerating the DNS servers.

  • DnsServerReverseZone
    Specifies the information regarding a specific reverse lookup DNS zone hosted on a particular server. It allows the extension of attributes for the BaseDnsServerZone complex type.

  • DnsServerReverseZoneEnumerationParameters
    Specifies the criteria to be used for enumerating the DNS server hosting of the reverse lookup DNS zones.

  • DnsServerZone
    Specifies the information regarding the forward lookup DNS zone hosting on a DNS server. It allows extending the attributes of the BaseDnsServerZone complex type.

  • DnsServerZoneEnumerationParameters
    Specifies the criteria to enumerate the DNS server hosting the forward lookup DNS zones.

  • DnsSetPreferredServerInvalidZoneTypeExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiInvalidDnsZoneTypeForPreferredServer.

  • DnsZone
    Specifies the information pertaining to a forward lookup DNS zone. It allows extension of attributes of the BaseDnsZone complex type.

  • DnsZoneEnumerationParameters
    Specifies the filter criteria to be used for enumerating the forward lookup DNS zones from the IPAM data store.

  • DnsZoneEvent
    Specifies an instance of the DNS zone related event.

  • DnsZoneEventEnumerationParameters
    Specifies the criteria for enumerating the DnsZoneEvent rows from the IPAM data store.

  • DnsZoneFormatter
    Allows extended attributes on an IpamObject type. It represents the formatted server name and zone name.

  • DnsZonesTransferParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It represents the input parameters for DNS zone transfer operation.

  • EntityStatus
    Describes the operation and its outcome on an IPAM object.

  • EntityStatusCollection
    Allows extended attributes on an IpamObject type. It is used to keep track of a list of EntityStatus complex types and to keep track of related operations through one object.

  • EntityStatusForDnsResourceRecord
    A complex type that is used to describe the operation and its outcome on an IPAM DNS resource record object.

  • EnumerationParametersBase
    Forms the base element that all other complex types extend to specify enumeration parameters.

  • ExclusionRangeDataFormatter
    Formats the fields of an exclusion range into a string used to display the result of operations. The string includes the scope ID, server name, and the start and end IP addresses of the exclusion range to uniquely identify it.

  • FailoverDataFormatter
    Allows extended attributes on an IpamObject type. It is used to create a formatted string that contains the name of the failover relationship and the partner servers.

  • FilterDataFormatter
    Allows extended attributes on an IpamObject type. It is used to create a formatted string that contains the server name and the MAC address.

  • GatewayAddress
    Allows extended attributes on an IpamObject type. It defines Gateway configuration on a DHCP scope.

  • InvalidDBConfigDatabaseTypeNotValidIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidDBConfigDatabaseTypeNotValid.

  • InvalidSQLDBConfigAuthNotSupportedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidSQLDBConfigAuthNotSupported.

  • InvalidSQLDBConfigInvalidPortIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidSQLDBConfigInvalidPort.

  • InvalidWIDDBConfigAuthNotSupportedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigAuthNotSupported.

  • InvalidWIDDBConfigDirectoryDoesNotExistIpamExceptionData
    Extends the IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigDirectoryDoesNotExist.

  • InvalidWIDDBConfigInvalidCredentialIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigInvalidCredential.

  • InvalidWIDDBConfigNameMustBeIPAMIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigNameMustBeIPAM.

  • InvalidWIDDBConfigPortNotAllowedIpamExceptionData
    Allows extended attributes on an  IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigPortNotAllowed.

  • InvalidWIDDBConfigServerNotAllowedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorInvalidWIDDBConfigServerNotAllowed.

  • ipam1:ArrayOfOperationGroup
    Specifies the list of operation groups.

  • ipam1:DhcpReservationAllEnumerationParameters
    Specifies the criteria to be used for enumerating the reservations.

  • ipam1:DhcpReservationScopeBasedEnumerationParameters
    Specifies the criteria to be used for enumerating the reservations from a given set of scopes.

  • ipam1:IIpamRemotingModule
    Specifies the base type to provide abstraction for remote calls from the IPAM server.

  • ipam1:IpamException
    Specifies the base type for providing the fault information from the management server to the
    management client.

  • IpamAddressObject
    Specifies an IP address object that extends the IpamObject so that it can be used with port types that allow enumeration of data from the server.

  • IpamAdminOperation
    Allows extended attributes on a section BaseIpamObject type. Specifies an administration operation in IPAM.

  • IpamCredential
    Allows extended attributes on a BaseIpamObject type. Specifies a set of credentials in IPAM.

  • IpamDatabaseConfiguration
    Allows extended attributes on a BaseIpamObject type. It represents the configuration for an IPAM database.

  • IpamExceptionData
    Specifies the details of the fault specified by using IpamException instance.

  • IpamForest
    Allows extended attributes on a BaseIpamObject type. It represents an Active Directory forest managed by IPAM.

  • IpamGenericExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiGenericErrorOccurred.

  • IpamGpoError
    Extends attributes on a BaseIpamObject type. This is used to encapsulate errors while creating GPOs for a particular domain.

  • IpamGpoErrorInfo
    Allows extended attributes on an IpamExceptionData type.

  • IpamIPAddress
    Specifies the common address object information in the IPAM data store.

  • IpamIPAddressAllForLogicalGroupEnumerationParameters
    Specifies the parameters for enumerating the IP address instances that map to a specified logical group.

  • IpamIPAddressAllForLogicalGroupNodeEnumerationParameters
    Specifies the criteria to be used for enumerating the addresses that map to a logical group node.

  • IpamIPAddressByAddressSpaceAndVirtualizationTypeParameters
    Specifies the criteria used for enumerating the address instances that are associated with a particular AddressSpace, are of a given IPVirtualizationType, and belong to a given AddressFamily.

  • IpamIPAddressByBlockIdEnumerationParameters
    Specifies the criteria used for enumerating the address instances that map to a specified address block.

  • IpamIPAddressByFilterEnumerationParameters
    Specifies the criteria used for enumerating the address instances that belong to a particular address family and also meet the conditions defined by a set of filter criteria.

  • IpamIPAddressByManagedByAndManagedByEntityEnumerationParameters
    Specifies the criteria to be used for enumerating the address instances that have a specified value for ManagedBy and ManagedByEntity built-in custom field values.

  • IpamIPAddressByRangeIdEnumerationParameters
    Specifies the filter criteria to be used for enumerating the address instances that map to a specific address range.

  • IpamIPAddressBySubnetIdEnumerationParameters
    Specifies the criteria to be used for enumerating the address instances that map to a specified IP subnet.

  • IpamIPAddressByVirtualizationTypeParameters
    Specifies the criteria to be used for enumerating the address instances that are of a given virtualization type.

  • IpamIPAddressDataFormatter
    Used to format error entities in operations relating to IPAddress.

  • IpamIPAddressForUnmappedRangesEnumerationParameters
    Retrieves the list of addresses in address ranges that are not already mapped to an address block.

  • IpamIPAddressRootAddressesEnumerationParameters
    Specifies the filter criteria to be used for enumerating the address instances belonging to a specified address category.

  • IpamIPAddressUnmappedAddressEnumerationParameters
    Specifies the criteria to be used for enumerating the unmapped address instances. Unmapped address instances are those that are not mapped to any address range instances.

  • IpamIPSubnetByFilterEnumerationParameters
    Specifies the criteria to be used for filtering the enumerated list of IP subnets.

  • IpamIPSubnetsByAddressCategoryEnumerationParameters
    Specifies the criteria to be used for enumerating IP subnets that belong to a given address category and a given address family.

  • IpamIPSubnetsByAddressSpaceAndVirtualizationTypeEnumerationParameters
    Specifies the criteria to be used for enumerating IP subnets that map to a given address space and are of a given virtualization type.

  • IpamIPSubnetsByBlockIdEnumerationParameters
    Specifies the criteria to be used for enumerating IP subnets that map to a given address block.

  • IpamIPSubnetsByUnmappedEnumerationParameters
    Specifies the criteria to be used for enumerating unmapped IP subnets of a given address family and virtualization type.

  • IpamIPSubnetsByVirtualizationTypeEnumerationParameters
    Specifies the criteria to be used for enumerating IP subnets of a given address family and virtualization type.

  • IpamIPSubnetsDirectChildrenByBlockIdEnumerationParameters
    Specifies the criteria to be used for enumerating the IP subnet instances of a given address family that map directly to the given address block.

  • IpamIPv4Address
    Enables extension of attributes of the IpamIPAddress complex type. This is used to specify the details pertaining to the IPv4 address instance.

  • IpamIPv4AddressLogicalGroup
    Allows extensions to the LogicalGroup complex type. Specifies the LogicalGroup to be used to enumerate IPv4 address instances using the logical group hierarchy.

  • IpamIPv4AddressLogicalGroupNode
    Allows extension of the LogicalGroupNode complex type. It defines the custom field value at a specific level in the logical group hierarchy.

  • IpamIPv6Address
    Enables extension of attributes of the IpamIPAddress complex type. This is used to specify the details pertaining to the IPv6 address instance.

  • IpamIPv6AddressLogicalGroup
    Allows extensions to the LogicalGroup complex type. Specifies the LogicalGroup that can be used to enumerate IPv6 address instances using the logical group hierarchy.

  • IpamIPv6AddressLogicalGroupNode
    Allows extension of the LogicalGroupNode complex type. It defines the custom field value at a specific level in the logical group hierarchy.

  • IpamNumberOfRowsObject
    Defines the type to be used to return an integer value specifying the number of rows as a result from the IPAM enumeration port types.

  • IpamObject
    Used to identify and provide certain common functionality for types that are IPAM-specific.

  • IpamOperationWithProgressParameters
    Extends IpamObject base type with an additional member of enum type ipam:IpamAdminOperationId, which identifies the type of operation being performed.

  • IpamProvisioningEnumerationParameters
    Allows extended attributes on an EnumerationParametersBase type.

  • IpamProvisioningSetting
    Allows extended attributes on an EnumerationParametersBase type. It creates objects whose ObjectType is AsyncProvision.

  • IpamSchemaVersion
    Allows extended attributes on a BaseIpamObject type. It defines the schema version of IPAM server.

  • IpamUpgradeValidationRuleInfo
    Allows extended attributes on a BaseIpamObject type. It defines the schema version of IPAM server.

  • IpamUpgradeValidationRuleStatus
    Allows extended attributes on a BaseIpamObject type. It defines rules for validating whether an instance of IPAM can be upgraded, along with the status for each rule.

  • IpamUpgradeWarningInfo
    Allows extended attributes on a BaseIpamObject type. It represents warnings during an upgrade.

  • IPAuditEnumerationParameters
    Used to specify the enumeration parameters for the IP address audit.

  • IPAuditRecord
    Used to specify single IP address audit.

  • IPBlock
    Specifies the address block information that is common to both IPv4Block and IPv6Block.

  • IPBlockChildBlockEnumerationParameters
    Specifies the criteria for enumerating the child blocks of a specified address block.

  • IPBlockDataFormatter
    Extends ipam:IpamObject and encapsulates the properties of an IP block to be formatted.

  • IPBlockGetAllBlocksEnumerationParameters
    Specifies the criteria for enumerating all the address blocks in the IPAM data store.

  • IPBlockRootEnumerationParameters
    Specifies the criteria for enumerating the rows that form the first level of address blocks.

  • IPCumulativeUtilization
    Specifies the address utilization statistics or trend information.

  • IPRange
    Specifies the common information pertaining to the address range.

  • IPRangeAllForBlockEnumerationParameter
    Used to specify the criteria on which ranges corresponding to an address block instance can be retrieved.

  • IPRangeAllForDhcpServerEnumerationParameters
    Used to specify the criteria on which address ranges corresponding to the DHCP scope instances of a particular DHCP server are enumerated.

  • IPRangeAllForLogicalGroupNodeEnumerationParameters
    Used to specify the parameters for enumerating the IP range instances corresponding to a specified logical group node in the logical group hierarchy.

  • IPRangeByAddressSpaceAndVirtualizationTypeParameters
    Specifies the criteria to be used for enumerating IP range instances that map to a given address space and are of a given virtualization type.

  • IPRangeByFilterEnumerationParameters
    Specifies the criteria to be used for enumerating the IP range instances that belong to a particular address family and that meet the conditions defined by a set of filter criteria.

  • IPRangeByManagedByAndManagedByEntityEnumerationParameters
    Specifies the criteria required to enumerate the address ranges for which the built-in custom fields ManagedBy and ManagedByEntity have a specific value.

  • IPRangeByVirtualizationTypeParameters
    Specifies the criteria for enumerating the IP range instances of a given virtualization type.

  • IPRangeDataFormatter
    Specifies the key properties of an IP range that is formatted for display.

  • IPRangeForBlockEnumerationParameters
    Specifies the criteria for enumerating the address ranges that map directly onto an address block and don't include the address ranges that map to a child block for the specified address block.

  • IPRangeForSubnetEnumerationParameter
    Extends EnumerationParametersBase and specifies the parameters used to enumerate all ranges for a given subnet.

  • IPRangeRootEnumerationParameters
    Used to specify the criteria for enumerating the address ranges that have a specific address category.

  • IPRangeUnmappedEnumerationParameters
    Used to specify the criteria for enumerating the address ranges that are unmapped.

  • IPSubnet
    Allows extending the attributes of the IPBlock complex type to represent information pertaining to an IP subnet.

  • IPUtilization
    Used to specify the address utilization data for a specific time range.

  • IPv4Block
    Allows extending the attributes of the IPBlock complex type. This is used to specify the IPv4-specific address block.

  • IPv4Range
    Allows extending the attributes of IPRange complex type. Specifies the details of IPv4-specific address range details.

  • IPv4RangeLogicalGroup
    Allows extending the attributes of LogicalGroup complex type. Specifies a logical group definition to be used for enumerating the address ranges.

  • IPv4RangeLogicalGroupNode
    Allows extending the attributes of LogicalGroupNode complex type. Specifies the criteria for a specific level in the logical group hierarchy that can be used to enumerate the address ranges that meet that level.

  • IPv4Subnet
    Allows extending the attributes of a IPSubnet complex type. This is used to specify the IPv4-specific subnet.

  • IPv4SubnetLogicalGroup
    Allows extending the attributes of LogicalGroup complex type. Specifies a logical group definition that can be used for enumerating the IP subnets.

  • IPv4SubnetLogicalGroupNode
    Allows extending the attributes of LogicalGroupNode complex type. It defines the value of the custom field that occurs at the specific level in logical group hierarchy.

  • IPv4Utilization
    Allows extending the attributes of an IPUtilization complex type. This is used to specify the address utilization corresponding to IPv4-specific address space.

  • IPv6Block
    Allows extending the attributes of the IPBlock complex type. This is used to specify the IPv6-specific address block.

  • IPv6Range
    Allows extending the attributes of IPRange complex type. Specifies the details of IPv6-specific address range details.

  • IPv6RangeLogicalGroup
    Allows extending the attributes of LogicalGroup complex type. Specifies a logical group definition that can be used for enumerating the address ranges.

  • IPv6RangeLogicalGroupNode
    Allows extending the attributes of LogicalGroupNode complex type. Specifies the criteria for a specific level in the logical group hierarchy that can be used to enumerate the address ranges that meet that level.

  • IPv6Subnet
    Allows extending the attributes of a IPSubnet complex type. This is used to specify the IPv6-specific subnet.

  • IPv6SubnetLogicalGroup
    Allows extending the attributes of LogicalGroup complex type. Specifies a logical group definition that can be used for enumerating the IP subnets.

  • IPv6SubnetLogicalGroupNode
    Allows extending the attributes of LogicalGroupNode complex type. It defines the value of the custom field that occurs at the specific level in logical group hierarchy.

  • IPv6Utilization
    Allows extending the attributes of an IPUtilization complex type. This is used to specify the address utilization corresponding to IPv6-specific address space.

  • LogicalGroup
    Specifies the definition of a logical group.

  • LogicalGroupDataForLogicalGroupNodeEnumerationParameters
    Specifies the logical group node information that form the criteria for enumerating the data.

  • LogicalGroupDataForRootAlternateItemsEnumerationParameters
    Specifies the criteria for enumerating the data which map to the specified logical group.

  • LogicalGroupDataUnmappedItemsEnumerationParameters
    Specifies the criteria used to enumerate the data that do not map to a specified logical group.

  • LogicalGroupField
    Specifies one level of the multivalued custom field that forms the logical group hierarchy.

  • LogicalGroupNode
    Specifies the actual custom field values that form the criteria for the data to be satisfied to match at a particular level in the logical group hierarchy.

  • LogicalGroupNodeChildrenEnumerationParameters
    Specifies the criteria to be used for enumerating the logical group nodes that form the next level of logical group nodes in a logical group hierarchy.

  • LogicalGroupNodeRootEnumerationParameters
    Specifies the criteria for enumerating the LogicalGroupNode that form the first level of LogicalGroupHierarchy.

  • LogicalGroupsEnumerationParameters
    Specifies the criteria for enumerating the logical groups from the IPAM data store.

  • MACAddress
    Used to specify the MAC address.

  • MovePolicyProcessingOrderParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is MovePolicyProcessingOrder and associates them to a DhcpPolicyV4 policy and an ipam:PolicyProcessingOrderDirection.

  • MultiUpdateDnsResourceRecordParameters
    Specifies the DNS resource records to be modified and the properties of the DNS resource records to be modified. It also specifies the DNS server and DNS zone on which they are to be modified.

  • OptionDefinitionDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name, vendor class name, and the associated option ID.

  • PropertiesCouldNotBeValidatedIpamExceptionData
    Allows extended attributes on an ipam1:IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiValidationFailure.

  • ProviderAddressSpace
    Extends the complex type AddressSpace. A particular Provider address space contains provider or fabric/physical networks on top of which virtual networks can be built.

  • ReloadDnsZonesParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It represents the input parameters from the reload DNS zones operation.

  • RemoveScopesFromSuperscopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is RemoveScopesFromSuperscope and associates them to a list of DHCP scope IDs that this operation is to be performed upon.

  • RenameSuperscopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is RenameSuperscope and associates them to a DhcpSuperscopeV4 that is to be renamed and the name it is to be given.

  • ReplicateRelationDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name from which the replication is initiated and the relationship name.

  • ReplicateRelationParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ReplicateRelation and associates them to an ipam:DhcpFailover object.

  • ReplicateScopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ReplicateScope and associates them to a list of ipam:DhcpScope objects.

  • ReplicateScopesDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name from which the replication is initiated and the scopes in the server that are to be replicated.

  • ReplicateServerDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name from which the replication is performed.

  • ReplicateServerParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ReplicateServer and associates them to an ipam:DhcpServerV4 object.

  • ReservationDataFormatter
    Used to format the fields of a DHCP reservation into a string used to display the result of operations. The string is formatted such that the DHCP reservation is identifiable uniquely.

  • ReservationOptionDataFormatter
    Used to format the fields of a DHCP option corresponding to a DHCP reservation into a string used to display the result of operations. The string is formatted such that the DHCP option and reservation are identifiable uniquely.

  • ResetConfigSyncStatusDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the list of DhcpScope objects' scope IDs for which this reset is applied.

  • ResetConfigSyncStatusParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is ResetConfigSyncStatus and associates them to a list of ipam:DhcpScope objects on which this operation is to be performed.

  • ScopeDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name and the scope ID of the relevant scope.

  • ScopeOptionDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name, scope ID, vendor class name, user class name and associated optionID.

  • ScopePolicyDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name, scope ID, and the policy name.

  • ScopePolicyIpRangeDataFormatter
    Allows extended attributes on an ipam:IpamObject type. It creates formatted strings with data about the policy name, server name, scope ID, and the policy range.

  • ScopePolicyOptionDataFormatter
    Allows extended attributes on an ipam:IpamObject type. It creates formatted strings with data about the server name, scope ID, vendor class name, policy name, and the associated option ID.

  • serarr:ArrayOfanyType
    Specifies an array whose elements can be of any type.

  • serarr:ArrayOfint
    Specifies an array whose elements are of type int.

  • serarr:ArrayOfKeyValueOfDnsResourceRecordAsmFormatterIpamException0cupfWA8
    Specifies an array of key value pairs where the key of the element is of type DnsResourceRecordAsmFormatter and the value of the element is of type ipam1:IpamException. No two elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfDnsResourceRecordFormatterIpamException0cupfWA8
    Specifies an array of key value pairs where the key of the element is of type DnsResourceRecordFormatter and the value of the element is of type ipam1:IpamException. No elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfDnsReverseLookupZoneFilterCriteriaanyType2zwQHvQz
    Specifies an array of key value pairs where the key of the element has the DnsReverseLookupZoneFilterCriteria and the value of the element can be any value appropriate for the key specified. No elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfDnsZoneFilterCriteriaanyType2zwQHvQz
    Specifies an array of key value pairs where the key of the element has the DnsZoneFilterCriteria and the value of the element can be any value appropriate for the key specified. No elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfintanyType
    Specifies an array of key value pairs where the key of the element has an integer and the value of the element can be any value appropriate for the key specified. No elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfIPBlockDataFormatterIpamException0cupfWA8
    Specifies an array of key value pairs where the key of the element is of type ipam:IPBlockDataFormatter and the value of the element is of type ipam1:IpamException. Each key MUST be unique; no elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfIPRangeDataFormatterIpamException0cupfWA8
    Specifies an array of key value pairs where the key of the element is of type ipam:IPRangeDataFormatter and the value of the element is of type ipam1:IpamException. Each key in the array MUST be unique; no elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOflongDhcpScopem1ahUJFx
    Specifies an array of key value pairs where the key of the element has the DHCP scope instance record identifier and the value is the corresponding DHCP scope instance.

  • serarr:ArrayOfKeyValueOflongIpamExceptionmhTjmZB3
    Specifies an array of key value pairs where the key of the element is a record identifier and the value of the element is the ipam1:IpamException instance having the record identifier specified in the key. Each key in the array MUST be unique; no elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfOperationGroupArrayOfOperationGroupxXhs3_PxJ
    Specifies an array of key value pairs where the key of the element is an OperationGroup and the value of the element is of type ArrayOfOperationGroup. The keys in the array MUST be unique so that no elements in the array have the same key.

  • serarr:ArrayOfKeyValueOfServerInfoGetServerFilteranyType2zwQHvQz
    Specifies an array of key value pairs where the key of the element has the ServerInfoGetServerFilter type and the value of the element can be any value appropriate for the key specified. The keys in the array MUST be unique; no elements in the array can have the same key.

  • serarr:ArrayOfKeyValueOfTupleOflongDnsResourceRecordTypem1ahUJFxIpamExceptionVfr71_PXs
    Specifies an array of key value pairs where the key of the element has the TupleOflongDnsResourceRecordTypem1ahUJFx type and the value of the element is of type IpamException. The keys in the array MUST be unique; no elements in the array can have the same key.

  • serarr:ArrayOflong
    Specifies an array of elements of type xsd:long.

  • serarr:ArrayOfstring
    Specifies an array of elements of type xsd:string.

  • serarr:ArrayOfunsignedByte
    Specifies an array of elements of type xsd:unsignedByte.

  • serarr:ArrayOfunsignedShort
    Specifies an array of elements of type xsd:unsignedShort.

  • ServerDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name.

  • ServerInfo
    Specifies the information pertaining to the server instances in the IPAM data store.

  • ServerInfoEnumerationParameters
    Specifies the criteria for enumerating the server instances from the IPAM data store.

  • ServerOptionDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name, vendor class name, user class name, and option ID.

  • ServerPolicyDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name and policy name.

  • ServerPolicyOptionDataFormatter
    Allows extended attributes on an ipam:IpamObject type. It creates formatted strings with data about the server name, vendor class name, policy name, and the associated option ID.

  • ServerRole
    Specifies the common access status information pertaining to an individual server role.

  • ServerRoleDc
    Allows the extension of attributes of the ServerRole complex type. The ServerRoleFlag MUST be set to ServerRoleType.Dc.

  • ServerRoleDhcp
    Allows the extension of the ServerRole complex type. The ServerRoleFlag MUST be set to ServerRoleType.Dhcp.

  • ServerRoleDhcp.Version
    Specifies the version of the DHCP server role.

  • ServerRoleDns
    Allows the extension of attributes of the ServerRole complex type. The ServerRoleFlag MUST be set to ServerRoleType.Dns.

  • ServerRoleNps
    Allows the extension of attributes of the ServerRole complex type. The ServerRoleFlag MUST be set to ServerRoleType.Nps.

  • SetDhcpReservationCollectionParameters
    Specifies the reservation fields to be changed and the collection of reservations on which edit operations can be done for multi-edit of DHCP reservations.

  • SetDhcpReservationParameters
    Specifies the reservation whose configuration needs to be modified.

  • SetSuperscopeActivationStatusParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is SetSuperscopeActivationStatus. It associates a list of DhcpSuperscopeV4 objects to the required activation status.

  • SubnetLogicalGroupNodeRootEnumerationParameters
    Extends EnumerationParametersBase and specifies the logical group, address space, and the address family to be used to enumerate subnets.

  • SubTaskInstance
    Allows extended attributes on an ipam:IpamObject and ipam:INotifyPropertyChanged. These are used to break a task at a granular level to correspond with PowerShell commands that are used to execute them.

  • SuperscopeV4DataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name and superscope name.

  • sys:ArrayOfTupleOfBaseDnsServerZonelong2zwQHvQz
    Specifies an array of tuple of a DNS server zone and a DNS server.

  • sys:ArrayOfTupleOfCustomFieldValueCustomFieldValuenTEz2bI_S
    Specifies an array of pairs of two values of two custom fields.

  • sys:ArrayOfTupleOfDhcpVendorClassArrayOfDhcpOptionDefinitionDhcpServerKSQw48VL
    Specifies an array of tuples of DHCP Vendor Class, array of DHCP option definitions, and DHCP server.

  • sys:ArrayOfTupleOfGetAddressSpaceFilteranyType2zwQHvQz
    Specifies an array of filters to apply while enumerating address space data. Each filter is a key value pair where the key specifies the type of filter to be applied and the value specifies the value of the filter criteria.

  • sys:ArrayOfTupleOfGetIpamIPAddressFilteranyType2zwQHvQz
    Specifies an array of filters to be applied while enumerating IP address data. Each filter is a key value pair where the key specifies the type of filter to be applied and the value specifies the value of the filter criteria.

  • sys:ArrayOfTupleOfGetIPRangeFilteranyType2zwQHvQz
    Specifies an array of filters to be applied while enumerating IP range data. Each filter is a key value pair wherein the key specifies the type of filter and the value specifies the value of the filter criteria.

  • sys:ArrayOfTupleOfGetIPSubnetFilteranyType2zwQHvQz
    Specifies an array of filters to be applied while enumerating IP subnet data. Each filter is a key value pair wherein the key specifies the type of filter and the value specifies the value of the filter criteria.

  • sys:ArrayOfTupleOflongDnsResourceRecordTypem1ahUJFx
    Specifies an array of a tuple representing a combination of a RecordId of the DNS resource record and DNS resource record type.

  • sys:ArrayOfTupleOflongstringstring
    Specifies an array of a tuple representing a combination of a long integer and two strings.

  • sys:ArrayOfTupleOfstringstring
    Specifies an array of tuples representing a pair of string values.

  • sys:Exception
    Specifies the Exception complex type which is extended by the IpamException complex type to specify IPAM fault information.

  • sys:TupleOfBaseDnsServerZonelong2zwQHvQz
    Specifies a tuple of DNS server zone and identifier of DNS server.

  • sys:TupleOfCustomFieldValueCustomFieldValuenTEz2bI_S Specifies a pair of custom field values.

  • sys:TupleOfDhcpVendorClassArrayOfDhcpOptionDefinitionDhcpServerKSQw48VL
    Specifies a tuple of DHCP Vendor Class, array of DHCP option definition, and DHCP server.

  • sys:TupleOfGetAddressSpaceFilteranyType2zwQHvQz
    Specifies a key value pair wherein the m_Item1 specifies an ipam:GetAddressSpaceFilter type specifying the type of filter to be applied with the value of the filter-specified data specified in the m_Item2 portion key value pair entry.

  • sys:TupleOfGetIpamIPAddressFilteranyType2zwQHvQz
    Specifies a key value pair wherein the m_Item1 specifies a ipam:GetIpamIPAddressFilter type specifying the type of filter to be applied with the value of the filter-specified data specified in the m_Item2 portion key value pair entry.

  • sys:TupleOfGetIPRangeFilteranyType2zwQHvQz
    Specifies a key value pair wherein the m_Item1 specifies a ipam:GetIPRangeFilter type specifying the type of filter to be applied with the value of the filter-specified data specified in the m_Item2 portion key value pair entry.

  • sys:TupleOfGetIPSubnetFilteranyType2zwQHvQz
    Specifies a key value pair wherein the m_Item1 specifies a ipam:GetIPSubnetFilter type specifying the type of filter that has to be applied with the value of the filter-specified data specified in the m_Item2 portion key value pair entry.

  • sys:TupleOflongDnsResourceRecordTypem1ahUJFx
    Specifies a tuple containing a RecordId for the DNS resource record and the DNS resource record type.

  • sys:TupleOflongstringstring
    Specifies a row containing a long integer and a pair of strings.

  • sys:TupleOfstringstring
    Specifies a pair of string values.

  • sys:Version
    Specifies the version of a component or server.

  • sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpExclusionRangenTEz2bI_S
    Specifies an array of key value pairs wherein the key specifies a CollectionOperations type specifying the type of operation to be performed with the DhcpExclusionRange data specified in the value portion key value pair.

  • sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpOptionnTEz2bI_S
    Specifies an array of key value pairs wherein the key specifies a CollectionOperations type specifying the type of operation to be performed with the DhcpOption data specified in the value portion key value pair entry.

  • sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpOptionDefinitionnTEz2bI_S
    Specifies an array of key value pairs wherein the key specifies a CollectionOperations type specifying the type of operation to be performed with the DhcpOptionDefinition data specified in the value portion key value pair entry.

  • sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpUserClassnTEz2bI_S
    Specifies an array of key value pairs wherein the key specifies a CollectionOperations type specifying the type of operation to be performed with the DhcpUserClass data specified in the value portion key value pair entry.

  • sysgen:ArrayOfKeyValuePairOfCollectionOperationsDhcpVendorClassnTEz2bI_S
    Specifies an array of key value pairs wherein the key specifies a CollectionOperations type specifying the type of operation to be performed with the DhcpVendorClass data specified in the value portion key value pair entry.

  • sysgen:ArrayOfKeyValuePairOflongAddressSpacem1ahUJFx
    Specifies an array of key value pairs wherein the key specifies the record identifier and the value specifies an AddressSpace object.

  • sysgen:ArrayOfKeyValuePairOflongArrayOfIPBlockm1ahUJFx
    Specifies an array of key value pairs wherein the key specifies the record identifier and the value specifies an array of address block instances specifying the hierarchy of the address block corresponding to the record identifier.

  • sysgen:ArrayOfKeyValuePairOflongint
    Specifies an array of key value pairs wherein the key specifies a long integer and the value specifies an integer value.

  • sysgen:ArrayOfKeyValuePairOflongIpamExceptionmhTjmZB3
    Specifies an array of key value pairs wherein the key specifies a long integer and the value specifies an IpamException.

  • sysgen:KeyValuePairOfCollectionOperationsDhcpExclusionRangenTEz2bI_S
    Specifies a key value pair wherein the key specifies a CollectionOperations type specifying the type of operation to be performed on the DhcpExclusionRange data specified in the value portion.

  • sysgen:KeyValuePairOfCollectionOperationsDhcpOptionnTEz2bI_S
    Specifies a key value pair wherein the key specifies a CollectionOperations type specifying the type of operation to be performed on the DhcpOption data specified in the value portion.

  • sysgen:KeyValuePairOfCollectionOperationsDhcpOptionDefinitionnTEz2bI_S
    Specifies a key value pair wherein the key specifies a CollectionOperations type specifying the type of operation that has to be performed on the DhcpOptionDefinition data specified in the value portion.

  • sysgen:KeyValuePairOfCollectionOperationsDhcpUserClassnTEz2bI_S
    Specifies a key value pair wherein the key specifies a CollectionOperations type specifying the type of operation that has to be performed on the DhcpUserClass data specified in the value portion.

  • sysgen:KeyValuePairOfCollectionOperationsDhcpVendorClassnTEz2bI_S
    Specifies a key value pair wherein the key specifies a CollectionOperations type specifying the type of operation that has to be performed on the DhcpVendorClass data specified in the value portion.

  • sysgen:KeyValuePairOflongAddressSpacem1ahUJFx
    Specifies a key value pair wherein the key specifies a long type element and the value specifies an element of type ipam:AddressSpace.

  • sysgen:KeyValuePairOflongint
    Specifies a key value pair wherein the key specifies a long type element and the value specifies an int type element.

  • sysgen:KeyValuePairOflongIpamExceptionmhTjmZB3
    Specifies a key value pair wherein the key specifies a long type element and the value specifies an IpamException type element.

  • sysnet:ArrayOfIPAddress
    Specifies an array of IPAddress complex type.

  • sysnet:IPAddress
    Specifies an IP address independent of the address family.

  • TaskInfo
    Specifies the set of details that provide more information about IPAM tasks.

  • UnmappedIpamIPAddressForLogicalGroupEnumerationParameters
    Specifies the parameters for enumerating the IP address instances that do not map to a specific logical group.

  • UpdateDhcpFilterParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is UpdateDhcpFilter and associates them to an DhcpFilter that is to be updated.

  • UpdateDhcpFiltersParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is UpdateDhcpFilters and associates them to the update parameters for a collection of DhcpFilter that are to be updated.

  • UpdateDhcpScopeParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is EditDhcpScope and associates them to an ipam:DhcpScope.

  • UpdateDhcpServerParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is EditDhcpServer and associates them to an ipam:DhcpServer.

  • UpdateDnsResourceRecordParameters
    Specifies the DNS resource record to be modified and the DNS server and DNS zone on which it is to be modified.

  • UpdateDnsZonesParameters
    Specifies the DnsServerZone to be modified and the unique identifier of the DNS server on which it is to be modified.

  • UpdateIpamIPAddressParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type.

  • UpdatePolicyParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is UpdatePolicy and associates them to an ipam:DhcpPolicyV4.

  • UpdatePolicyPropertiesParameters
    Allows extended attributes on an IpamOperationWithProgressParameters type. It creates objects whose OperationId is UpdatePolicyProperty and associates them to a Collection of DhcpPolicyV4 and an ipam:DhcpPolicyPropertyUpdate object.

  • UserAccessPolicy
    Allows extended attributes on a BaseIpamObject type. It specifies the properties of a user's access policy in the IPAM data store.

  • UserClassDataFormatter
    Allows extended attributes on an IpamObject type. This presents the ServerName and UserClassName as a formatted string.

  • UserRole
    Allows extended attributes on a BaseIpamObject type. It specifies the properties that define a user's role in IPAM.

  • UsingExistingSchemaNotSupportedIpamExceptionData
    Allows extended attributes on an IpamExceptionData type. It creates objects whose IpamExceptionId is IpamApiErrorUsingExistingSchemaNotSupported.

  • VendorClassDataFormatter
    Allows extended attributes on an IpamObject type. It creates formatted strings with data about the server name and vendor class name.