MSFT_IPAM_Range, ROOT\Microsoft\IPAM

Class | Methods (5) | Properties (41) | Qualifiers (6) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The class RangeOfIPAddresses represents an implicit grouping (or \'pool\') of IP addresses specified by the properties, Start and EndAddress. It is defined as scoped/contained by a system such as an individual network element or an admin domain.

MSFT_IPAM_Range methods

MSFT_IPAM_Range has 5 methods (5 Local)

NameOriginReturn
AddRangeMSFT_IPAM_Rangeuint32 {'out':True}
BulkAddOrUpdateRangeMSFT_IPAM_Rangeuint32 {'out':True}
BulkDeleteRangeMSFT_IPAM_Rangeuint32 {'out':True}
ExportRangeMSFT_IPAM_Rangeuint32 {'out':True}
ImportRangeMSFT_IPAM_Rangeuint32 {'out':True}

MSFT_IPAM_Range properties

MSFT_IPAM_Range has 41 properties (34 Local, 7 Derived)

NameOriginCIMType
AddressCategoryMSFT_IPAM_Range18 [uint16]
AddressSpaceMSFT_IPAM_Range8 [string]
AddressSpaceIdMSFT_IPAM_Range21 [uint64]
AddressTypeCIM_RangeOfIPAddresses18 [uint16]
AssignedAddressesMSFT_IPAM_Range21 [uint64]
AssignmentDateMSFT_IPAM_Range101 [datetime]
AssignmentTypeMSFT_IPAM_Range18 [uint16]
CaptionCIM_ManagedElement8 [string]
ConnectionSpecificDnsSuffixMSFT_IPAM_Range8 [string]
CustomConfigurationMSFT_IPAM_Range8 [string]
CustomerAddressSpaceMSFT_IPAM_Range8 [string]
DescriptionCIM_ManagedElement8 [string]
DhcpScopeNameMSFT_IPAM_Range8 [string]
DhcpServerNameMSFT_IPAM_Range8 [string]
DnsServersMSFT_IPAM_Range8 [string]
DnsSuffixesMSFT_IPAM_Range8 [string]
ElementNameCIM_ManagedElement8 [string]
EndAddressCIM_RangeOfIPAddresses8 [string]
ExclusionRangesMSFT_IPAM_Range8 [string]
GatewayMSFT_IPAM_Range8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
LastModifiedTimeMSFT_IPAM_Range101 [datetime]
LastReclaimRunTimeMSFT_IPAM_Range101 [datetime]
ManagedByServiceMSFT_IPAM_Range8 [string]
NetworkIDMSFT_IPAM_Range8 [string]
NetworkSiteMSFT_IPAM_Range8 [string]
NetworkTypeMSFT_IPAM_Range18 [uint16]
OverlappingMSFT_IPAM_Range11 [boolean]
OwnerMSFT_IPAM_Range8 [string]
PercentageUtilizedMSFT_IPAM_Range5 [real64]
ProviderAddressSpaceMSFT_IPAM_Range8 [string]
ReservedIPAddressesMSFT_IPAM_Range8 [string]
ServiceInstanceMSFT_IPAM_Range8 [string]
StartAddressCIM_RangeOfIPAddresses8 [string]
SubnetMaskMSFT_IPAM_Range8 [string]
UtilizationMSFT_IPAM_Range18 [uint16]
UtilizationCalculationMSFT_IPAM_Range18 [uint16]
UtilizedAddressesMSFT_IPAM_Range5 [real64]
VIPMSFT_IPAM_Range8 [string]
VmmLogicalNetworkMSFT_IPAM_Range8 [string]
WinsServersMSFT_IPAM_Range8 [string]

Detailed description of MSFT_IPAM_Range methods

Local methods (5) of MSFT_IPAM_Range class

AddRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
NetworkIDstring0-{'In':True}
NetworkTypeuint161-{'In':True}
AddressSpacestring2-{'In':True}
StartAddressstring3-{'In':True}
EndAddressstring4-{'In':True}
ManagedByServicestring5-{'In':True}
ServiceInstancestring6-{'In':True}
UtilizationCalculationuint167-{'In':True}
UtilizedAddressesreal648-{'In':True}
Descriptionstring9-{'In':True}
Ownerstring10-{'In':True}
AssignmentTypeuint1611-{'In':True}
AssignmentDatedatetime12-{'In':True}
ReservedIPAddressesstring13-{'In':True}
DnsServersstring14-{'In':True}
DnsSuffixesstring15-{'In':True}
ConnectionSpecificDnsSuffixstring16-{'In':True}
WinsServersstring17-{'In':True}
VIPstring18-{'In':True}
Gatewaystring19-{'In':True}
CustomConfigurationstring20-{'In':True}
OutputRangeobject:MSFT_IPAM_Range21-{'EmbeddedInstance':'MSFT_IPAM_Range','Out':True}
Description'Adds a new IP Range object to IPAM'
implementedTrue
staticTrue
AddRange method is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
BulkAddOrUpdateRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Rangeobject:MSFT_IPAM_Range0-{'EmbeddedInstance':'MSFT_IPAM_Range','In':True}
Outputobject:MSFT_IPAM_OperationStatus1-{'EmbeddedInstance':'MSFT_IPAM_OperationStatus','Out':True,'Stream':True}
Description'Adds or updates a set of IP Range objects in IPAM. This method takes an array of IP Range objects as input'
implementedTrue
staticTrue
BulkAddOrUpdateRange method is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
BulkDeleteRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Rangeobject:MSFT_IPAM_Range0-{'EmbeddedInstance':'MSFT_IPAM_Range','In':True}
Outputobject:MSFT_IPAM_OperationStatus1-{'EmbeddedInstance':'MSFT_IPAM_OperationStatus','Out':True,'Stream':True}
Description'Deletes a set of IP Range objects from IPAM'
implementedTrue
staticTrue
BulkDeleteRange method is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
ExportRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Pathstring0-{'In':True}
AddressTypeuint161-{'In':True}
NetworkTypeuint162-{'In':True}
AddressSpacestring3-{'In':True}
Outputobject:MSFT_IPAM_Range4-{'EmbeddedInstance':'MSFT_IPAM_Range','Out':True,'Stream':True}
Description'Exports IP Ranges from IPAM Server to a .CSV file'
implementedTrue
staticTrue
ExportRange method is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
ImportRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Pathstring0-{'In':True}
ErrorPathstring1-{'In':True}
AddressFamilyuint162-{'In':True}
ManagedByServicestring3-{'In':True}
ServiceInstancestring4-{'In':True}
AddManagedByServiceboolean5-{'In':True}
AddServiceInstanceboolean6-{'In':True}
DeleteMappedAddressesboolean7-{'In':True}
CreateSubnetIfNotFoundboolean8-{'In':True}
Outputstring9-{'Out':True}
Description'Imports IP Ranges into IPAM Server from a .CSV file'
implementedTrue
staticTrue
ImportRange method is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of MSFT_IPAM_Range properties

Local properties (34) of MSFT_IPAM_Range class

AddressCategory property
CIMTYPE'uint16'
Description'Specifies whether the address range is public or private.'
readTrue
ValueMap['0', '1', '2', '3']
Values['None', 'Public', 'Private', 'Global']
AddressCategory property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
AddressSpace property
CIMTYPE'string'
Description'Specifies the address space associated with this IP Range.'
AddressSpace property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
AddressSpaceId property
CIMTYPE'uint64'
Description'Specifies the address space associated with this IP Range.'
AddressSpaceId property is in 3 classes of ROOT\Microsoft\IPAM and in 4 namespaces
AssignedAddresses property
CIMTYPE'uint64'
Description'The number of addresses assigned to this range. It is calculated as end IP address � start IP address.'
AssignedAddresses property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
AssignmentDate property
CIMTYPE'datetime'
Description'The date that addresses in this range were assigned.'
AssignmentDate property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
AssignmentType property
CIMTYPE'uint16'
Description'Specifies how addresses will be assigned from this range. Allowed values are: Static, Dynamic, Auto, VIP and Reserved.'
ValueMap['0', '1', '2', '3', '4', '5']
Values['None', 'Static', 'Dynamic', 'Auto', 'VIP', 'Reserved']
AssignmentType property is in 2 classes of ROOT\Microsoft\IPAM and in 10 namespaces
ConnectionSpecificDnsSuffix property
CIMTYPE'string'
Description'Connection specific DNS suffix that is associated with this range.'
ConnectionSpecificDnsSuffix property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
CustomConfiguration property
CIMTYPE'string'
Description'Custom data associated with this range. This is specified as a semi-colon separated �name=value� pairs.'
CustomConfiguration property is in 5 classes of ROOT\Microsoft\IPAM and in 4 namespaces
CustomerAddressSpace property
CIMTYPE'string'
Description'Readonly value of the customer address space to which this IP Range belongs to. This will only be populated when the NetworkType of the IP Range is Customer.'
CustomerAddressSpace property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
DhcpScopeName property
CIMTYPE'string'
Description'Name of the DHCP scope from which this range was synchronized.'
DhcpScopeName property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
DhcpServerName property
CIMTYPE'string'
Description'Name of the DHCP server from which this range was synchronized.'
DhcpServerName property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
DnsServers property
CIMTYPE'string'
Description'List of DNS servers associated with this range.'
DnsServers property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 4 namespaces
DnsSuffixes property
CIMTYPE'string'
Description'List of DNS search suffixes that are associated with this range. A search suffix list is used to resolve a DNS query.'
DnsSuffixes property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
ExclusionRanges property
CIMTYPE'string'
Description'The exclusion ranges defined in the DHCP scope from which this range was synchronized.'
readTrue
ExclusionRanges property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
Gateway property
CIMTYPE'string'
Description'List of gateway servers and corresponding metrics associated with this range.'
Gateway property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 4 namespaces
LastModifiedTime property
CIMTYPE'datetime'
Description'The latest date and time when any property of this IP Range was modified'
LastModifiedTime property is in 4 classes of ROOT\Microsoft\IPAM and in 4 namespaces
LastReclaimRunTime property
CIMTYPE'datetime'
Description'The last time IP addresses were reclaimed from this range.'
LastReclaimRunTime property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
ManagedByService property
CIMTYPE'string'
Description'The service managing the IP address range.'
ManagedByService property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
NetworkID property
CIMTYPE'string'
Description'The network address and prefix length of this IP address range. This is specified as NetworkId / Prefix Length.'
NetworkID property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
NetworkSite property
CIMTYPE'string'
Description'This field, along with a logical network, forms an abstraction of the physical network. A given logical network can contain many network sites. This property is inherited from the subnet to which this range maps.'
NetworkSite property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
NetworkType property
CIMTYPE'uint16'
Description'Specifies whether the IP address range is virtualized or non-virtualized.'
ValueMap['1', '2', '4']
Values['NonVirtualized', 'Provider', 'Customer']
NetworkType property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
Overlapping property
CIMTYPE'boolean'
Description'Indicates whether this range overlaps with another range in IPAM.'
readTrue
Overlapping property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
Owner property
CIMTYPE'string'
Description'Optional field specifying the owner of this address IP range.'
Owner property is in 9 classes of ROOT\Microsoft\IPAM and in 142 namespaces
PercentageUtilized property
CIMTYPE'real64'
Description'The percentage utilization of IP addresses in the given range.'
PercentageUtilized property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
ProviderAddressSpace property
CIMTYPE'string'
Description'Readonly value of the provider address space to which this IP Range belongs to. This will only be populated when the NetworkType of the IP Range is either Provider or Non-Virtualized.'
ProviderAddressSpace property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
ReservedIPAddresses property
CIMTYPE'string'
Description'List of reserved IP addresses that are a part of this range. These will be excluded from the range while searching for a free IP address.'
ReservedIPAddresses property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
ServiceInstance property
CIMTYPE'string'
Description'The instance of Managed By Service that is managing this range.'
ServiceInstance property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
SubnetMask property
CIMTYPE'string'
Description'The subnet mask associated with the IP address range.'
readTrue
SubnetMask property is in 5 classes of ROOT\Microsoft\IPAM and in 16 namespaces
Utilization property
CIMTYPE'uint16'
Description'Indicates that the IP address range is underutilized, overutilized or utilization is optimal.'
readTrue
ValueMap['0', '1', '2', '3']
Values['None', 'Under', 'Optimal', 'Over']
Utilization property is in 3 classes of ROOT\Microsoft\IPAM and in 4 namespaces
UtilizationCalculation property
CIMTYPE'uint16'
Description'Specifies whether the utilization calculation for this range will be performed automatically or whether this data will be specified by the user.'
ValueMap['1', '2']
Values['Auto', 'Static']
UtilizationCalculation property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
UtilizedAddresses property
CIMTYPE'real64'
Description'The number of addresses that are currently in use in the specified range.'
UtilizedAddresses property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
VIP property
CIMTYPE'string'
Description'List of virtual IP addresses that are a part of this range. These will be excluded from the range while searching for a free IP address.'
VIP property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 2 namespaces
VmmLogicalNetwork property
CIMTYPE'string'
Description'An network abstraction defined for your environment. This property is inherited from the subnet to which this range maps.'
VmmLogicalNetwork property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
WinsServers property
CIMTYPE'string'
Description'List of WINS servers associated with this range.'
WinsServers property is in 1 class (MSFT_IPAM_Range) of ROOT\Microsoft\IPAM and in 5 namespaces

Derived properties (7) of MSFT_IPAM_Range class

AddressType property
CIMTYPE'uint16'
Description'An enumeration that defines how the address and mask properties are formatted.'
Override'AddressType'
readTrue
ValueMap['0', '1', '2']
Values['Unknown', 'IPv4', 'IPv6']
AddressType property is in 7 classes of ROOT\Microsoft\IPAM and in 9 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
MaxLen64
Caption property is in 45 classes of ROOT\Microsoft\IPAM and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 46 classes of ROOT\Microsoft\IPAM and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces
EndAddress property
CIMTYPE'string'
Description'The ending IP address of the AddressRange, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., 171.79.6.40).'
ModelCorrespondence['CIM_RangeOfIPAddresses.AddressType']
EndAddress property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following \'preferred\' algorithm:
:
Where and are separated by a colon \':\', and where must include a unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority.(This requirement is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness must not contain a colon (\':\'). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above \'preferred\' algorithm is not used, the defining entity must ensure that the resulting InstanceID is not re-used as any of InstanceIDs produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the \'preferred\' algorithm must be used with the set to \'CIM\'.'
keyTrue
Override'InstanceID'
readTrue
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces
StartAddress property
CIMTYPE'string'
Description'The starting IP address of the AddressRange, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., 171.79.6.40).'
ModelCorrespondence['CIM_RangeOfIPAddresses.AddressType']
StartAddress property is in 3 classes of ROOT\Microsoft\IPAM and in 4 namespaces

MSFT_IPAM_Range Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'The class RangeOfIPAddresses represents an implicit grouping (or \'pool\') of IP addresses specified by the properties, Start and EndAddress. It is defined as scoped/contained by a system such as an individual network element or an admin domain.'
dynamicTrue
locale'MS_409'
provider'IPAMServerPSProvider'
UMLPackagePath'CIM::Network::Collections'

MSFT_IPAM_Range System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM:MSFT_IPAM_Range'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_RangeOfIPAddresses', 'CIM_SystemSpecificCollection', 'CIM_Collection', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT41___SYSTEM3
__RELPATH'MSFT_IPAM_Range'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_RangeOfIPAddresses'___SYSTEM8
__CLASS'MSFT_IPAM_Range'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_IPAM_Range

Number of classes:4
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_RangeOfIPAddresses270----
MSFT_IPAM_Address_Range_Association020----
MSFT_IPAM_Range_Block_Association020----
MSFT_IPAM_Range_Subnet_Association020----
comments powered by Disqus
WUtils.com