MSFT_IPAM_Server, ROOT\Microsoft\IPAM

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

Description

CIM_Product is a concrete class that aggregates PhysicalElements, software (SoftwareIdentity and SoftwareFeatures), Services and/or other Products, and is acquired as a unit. Acquisition implies an agreement between supplier and consumer which may have implications to Product licensing, support and warranty. Non-commercial (e.g., in-house developed Products) should also be identified as an instance of CIM_Product. Note that software is handled a bit differently in the list of aggregated entities, above. This is because software can be viewed as a tangible asset (similar to PhysicalElements) AND/ OR as a set of features that make up a Product and are deployed. These are two different concepts, usually managed by different units in a business\' organization. When software \'features\' are described, the CIM_SoftwareFeature class from the Application Model is instantiated (where Features are Weak to/scoped by a Product). When a specific piece of software is acquired and perhaps warrantied as part of a Product, this is addressed by the class, SoftwareIdentity.

MSFT_IPAM_Server methods

MSFT_IPAM_Server has 2 methods (2 Local)

NameOriginReturn
InvokeIpamServerProvisioningMSFT_IPAM_Serveruint32 {'out':True}
UpdateIpamServerMSFT_IPAM_Serveruint32 {'out':True}

MSFT_IPAM_Server properties

MSFT_IPAM_Server has 11 properties (11 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
key
IdentifyingNumber
CIM_Product8 [string]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_Product8 [string]
SKUNumberCIM_Product8 [string]
key
Vendor
CIM_Product8 [string]
key
Version
CIM_Product8 [string]
WarrantyDurationCIM_Product19 [uint32]
WarrantyStartDateCIM_Product101 [datetime]

Detailed description of MSFT_IPAM_Server methods

Local methods (2) of MSFT_IPAM_Server class

InvokeIpamServerProvisioning method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
DatabaseServerstring0-{'In':True}
DatabaseNamestring1-{'In':True}
DatabasePortuint162-{'In':True}
DatabaseAuthTypeuint163-{'In':True}
DatabaseCredentialstring4-{'In':True}
ProvisioningMethoduint165-{'In':True}
GpoPrefixstring6-{'In':True}
WidSchemaPathstring7-{'In':True}
Description'Provisions the IPAM server. Provisioning method and IPAM data store can be configured using this method.'
implementedTrue
staticTrue
InvokeIpamServerProvisioning method is in 1 class (MSFT_IPAM_Server) of ROOT\Microsoft\IPAM and in 2 namespaces
UpdateIpamServer method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
DeleteSystemCheckFailureRowsboolean0-{'In':True}
Description'This method allows the caller to update IPAM server schema after an OS upgrade.'
implementedTrue
staticTrue
UpdateIpamServer method is in 1 class (MSFT_IPAM_Server) of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of MSFT_IPAM_Server properties

Derived properties (11) of MSFT_IPAM_Server class

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
IdentifyingNumber property
CIMTYPE'string'
Description'Product identification such as a serial number on software, a die number on a hardware chip, or (for non-commercial Products) a project number.'
keyTrue
MaxLen64
IdentifyingNumber property is in 4 classes of ROOT\Microsoft\IPAM and in 4 namespaces
InstanceID property
CIMTYPE'string'
Description'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
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 copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID 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 reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces
Name property
CIMTYPE'string'
Description'Commonly used Product name.'
keyTrue
MaxLen256
ModelCorrespondence['PRS_Product.ProductName']
Name property is in 26 classes of ROOT\Microsoft\IPAM and in 142 namespaces
SKUNumber property
CIMTYPE'string'
Description'Product SKU (stock keeping unit) information.'
MaxLen64
SKUNumber property is in 2 classes of ROOT\Microsoft\IPAM and in 4 namespaces
Vendor property
CIMTYPE'string'
Description'The name of the Product\'s supplier, or entity selling the Product (the manufacturer, reseller, OEM, etc.). Corresponds to the Vendor property in the Product object in the DMTF Solution Exchange Standard.'
keyTrue
MaxLen256
ModelCorrespondence['PRS_Product.Vendor']
Vendor property is in 4 classes of ROOT\Microsoft\IPAM and in 6 namespaces
Version property
CIMTYPE'string'
Description'Product version information.'
keyTrue
MaxLen64
ModelCorrespondence['PRS_Product.Version']
Version property is in 7 classes of ROOT\Microsoft\IPAM and in 142 namespaces
WarrantyDuration property
CIMTYPE'uint32'
Description'If this Product is under warranty, the duration of the warranty in days.'
ModelCorrespondence['CIM_Product.WarrantyStartDate']
PUnit'day'
Units'Days'
WarrantyDuration property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
WarrantyStartDate property
CIMTYPE'datetime'
Description'If this Product is under warranty, the start date of the warranty.'
ModelCorrespondence['CIM_Product.WarrantyDuration']
WarrantyStartDate property is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces

MSFT_IPAM_Server Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'CIM_Product is a concrete class that aggregates PhysicalElements, software (SoftwareIdentity and SoftwareFeatures), Services and/or other Products, and is acquired as a unit. Acquisition implies an agreement between supplier and consumer which may have implications to Product licensing, support and warranty. Non-commercial (e.g., in-house developed Products) should also be identified as an instance of CIM_Product.
Note that software is handled a bit differently in the list of aggregated entities, above. This is because software can be viewed as a tangible asset (similar to PhysicalElements) AND/ OR as a set of features that make up a Product and are deployed. These are two different concepts, usually managed by different units in a business\' organization. When software \'features\' are described, the CIM_SoftwareFeature class from the Application Model is instantiated (where Features are Weak to/scoped by a Product). When a specific piece of software is acquired and perhaps warrantied as part of a Product, this is addressed by the class, SoftwareIdentity.'
dynamicTrue
locale'MS_409'
provider'IPAMServerPSProvider'
UMLPackagePath'CIM::Core::ProductFRU'

MSFT_IPAM_Server System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM:MSFT_IPAM_Server'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Product', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT11___SYSTEM3
__RELPATH'MSFT_IPAM_Server'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_Product'___SYSTEM8
__CLASS'MSFT_IPAM_Server'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_IPAM_Server

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_IPAM_ServerCapabilities0202----
MSFT_IPAM_ServerConfiguration0109----
MSFT_IPAM_ServerInventory0333----
comments powered by Disqus
WUtils.com