MSFT_IPAM_Block, ROOT\Microsoft\IPAM

Class | Methods (1) | Properties (20) | 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_Block methods

MSFT_IPAM_Block has 1 methods (1 Local)

NameOriginReturn
AddIpamBlockMSFT_IPAM_Blockuint32 {'out':True}

MSFT_IPAM_Block properties

MSFT_IPAM_Block has 20 properties (13 Local, 7 Derived)

NameOriginCIMType
AddressCategoryMSFT_IPAM_Block18 [uint16]
AddressTypeCIM_RangeOfIPAddresses18 [uint16]
AssignedAddressesMSFT_IPAM_Block21 [uint64]
CaptionCIM_ManagedElement8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EndAddressCIM_RangeOfIPAddresses8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
LastAssignedDateMSFT_IPAM_Block101 [datetime]
LastModifiedTimeMSFT_IPAM_Block101 [datetime]
NetworkIdMSFT_IPAM_Block8 [string]
OwnerMSFT_IPAM_Block8 [string]
PercentageAssignedMSFT_IPAM_Block4 [real32]
PercentageUtilizedMSFT_IPAM_Block4 [real32]
RirMSFT_IPAM_Block8 [string]
RirReceivedDateMSFT_IPAM_Block101 [datetime]
StartAddressCIM_RangeOfIPAddresses8 [string]
TotalAddressesMSFT_IPAM_Block21 [uint64]
UtilizationMSFT_IPAM_Block18 [uint16]
UtilizedAddressesMSFT_IPAM_Block21 [uint64]

Detailed description of MSFT_IPAM_Block methods

Local methods (1) of MSFT_IPAM_Block class

AddIpamBlock method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
NetworkIdstring0-{'In':True}
StartAddressstring1-{'In':True}
EndAddressstring2-{'In':True}
Rirstring3-{'In':True}
RirReceivedDatedatetime4-{'In':True}
Descriptionstring5-{'In':True}
LastAssignedDatedatetime6-{'In':True}
Ownerstring7-{'In':True}
outputobject:MSFT_IPAM_Block8-{'EmbeddedInstance':'MSFT_IPAM_Block','Out':True}
Description'Adds a new IP Block to IPAM.'
implementedTrue
staticTrue
AddIpamBlock method is in 1 class (MSFT_IPAM_Block) of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of MSFT_IPAM_Block properties

Local properties (13) of MSFT_IPAM_Block class

AddressCategory property
CIMTYPE'uint16'
Description'Specifies whether the IP address block is public or private.'
ValueMap['1', '2', '3']
Values['Public', 'Private', 'Global']
AddressCategory property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
AssignedAddresses property
CIMTYPE'uint64'
Description'Number of IP addresses currently assigned to child ranges.'
AssignedAddresses property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
LastAssignedDate property
CIMTYPE'datetime'
Description'Date when the IP address block was assigned to the IPAM server.'
LastAssignedDate property is in 1 class (MSFT_IPAM_Block) of ROOT\Microsoft\IPAM and in 2 namespaces
LastModifiedTime property
CIMTYPE'datetime'
Description'The latest date and time when any property of this IP Address was modified'
LastModifiedTime property is in 4 classes of ROOT\Microsoft\IPAM and in 4 namespaces
NetworkId property
CIMTYPE'string'
Description'The network address and prefix length of this IP address block. This is specified as NetworkId/Prefix.'
NetworkId property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
Owner property
CIMTYPE'string'
Description'Optional field specifying the owner of this IP address block.'
Owner property is in 9 classes of ROOT\Microsoft\IPAM and in 142 namespaces
PercentageAssigned property
CIMTYPE'real32'
Description'Assigned IP addresses in this block, expressed as a percentage of total addresses.'
PercentageAssigned property is in 1 class (MSFT_IPAM_Block) of ROOT\Microsoft\IPAM and in 2 namespaces
PercentageUtilized property
CIMTYPE'real32'
Description'Utilized IP addresses in this block, expressed as a percentage of total addresses.'
PercentageUtilized property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces
Rir property
CIMTYPE'string'
Description'Specifies the Regional Internet Registry for public addresses. This field is mandatory for a public IP address block. Allowed values are: AFRINIC, APNIC, ARIN, LACNIC, and RIPE. You can also configure and add custom values.'
Rir property is in 1 class (MSFT_IPAM_Block) of ROOT\Microsoft\IPAM and in 2 namespaces
RirReceivedDate property
CIMTYPE'datetime'
Description'Optional parameter specifying the date on which a public address block was obtained from Regional Internet Registry.'
RirReceivedDate property is in 1 class (MSFT_IPAM_Block) of ROOT\Microsoft\IPAM and in 2 namespaces
TotalAddresses property
CIMTYPE'uint64'
Description'Total number of IP addresses in the block.'
TotalAddresses property is in 2 classes of ROOT\Microsoft\IPAM and in 4 namespaces
Utilization property
CIMTYPE'uint16'
Description'Indicates whether the IP address block 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
UtilizedAddresses property
CIMTYPE'uint64'
Description'Current number of IP addresses mapping to this block that are in use.'
UtilizedAddresses property is in 3 classes of ROOT\Microsoft\IPAM and in 2 namespaces

Derived properties (7) of MSFT_IPAM_Block class

AddressType property
CIMTYPE'uint16'
Description'An enumeration that defines how the address and mask properties are formatted.'
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
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_Block 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_Block System properties

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

Similar Classes to MSFT_IPAM_Block

Number of classes:4
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_IPAM_Address_Block_Association020----
MSFT_IPAM_Block_Association020----
MSFT_IPAM_Range_Block_Association020----
MSFT_IPAM_Subnet_Block_Association020----
comments powered by Disqus
WUtils.com