MSFT_IPAM_CustomValue, ROOT\Microsoft\IPAM

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

Description

ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.

MSFT_IPAM_CustomValue methods

MSFT_IPAM_CustomValue has 5 methods (5 Local)

NameOriginReturn
AddCustomValueMSFT_IPAM_CustomValueuint32 {'out':True}
BulkAddCustomValueMSFT_IPAM_CustomValueuint32 {'out':True}
BulkDeleteCustomValueMSFT_IPAM_CustomValueuint32 {'out':True}
RemoveCustomValueMSFT_IPAM_CustomValueuint32 {'out':True}
RenameCustomValueMSFT_IPAM_CustomValueuint32 {'out':True}

MSFT_IPAM_CustomValue properties

MSFT_IPAM_CustomValue has 7 properties (3 Local, 4 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
CategoryMSFT_IPAM_CustomValue8 [string]
CustomFieldMSFT_IPAM_CustomValue8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
ValueMSFT_IPAM_CustomValue8 [string]

Detailed description of MSFT_IPAM_CustomValue methods

Local methods (5) of MSFT_IPAM_CustomValue class

AddCustomValue method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
Valuestring1-{'In':True}
Outputobject:MSFT_IPAM_CustomValue2-{'EmbeddedInstance':'MSFT_IPAM_CustomValue','Out':True}
Description'Adds a custom value to the set of possible values for a given multi-valued custom field.'
implementedTrue
staticTrue
AddCustomValue method is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces
BulkAddCustomValue method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
Valuestring1-{'In':True}
Outputobject:MSFT_IPAM_OperationStatus2-{'EmbeddedInstance':'MSFT_IPAM_OperationStatus','Out':True}
Description'Adds a set of Custom Values in IPAM.'
implementedTrue
staticTrue
BulkAddCustomValue method is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces
BulkDeleteCustomValue method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
Valuestring1-{'In':True}
Outputobject:MSFT_IPAM_OperationStatus2-{'EmbeddedInstance':'MSFT_IPAM_OperationStatus','Out':True}
Description'Deletes a set of Custom Values from IPAM'
implementedTrue
staticTrue
BulkDeleteCustomValue method is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces
RemoveCustomValue method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
Valuestring1-{'In':True}
Outputobject:MSFT_IPAM_CustomValue2-{'EmbeddedInstance':'MSFT_IPAM_CustomValue','Out':True}
Description'Removes a value from set of possible values for a given multi-valued custom field. This returns an error if the value is currently in use. IPAM doesn't allow deletion of inbuilt custom fields.'
implementedTrue
staticTrue
RemoveCustomValue method is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces
RenameCustomValue method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'In':True}
Valuestring1-{'In':True}
NewValuestring2-{'In':True}
Outputobject:MSFT_IPAM_CustomValue3-{'EmbeddedInstance':'MSFT_IPAM_CustomValue','Out':True}
Description'Renames a value of a custom field. This returns an error if the value is an inbuilt value.'
implementedTrue
staticTrue
RenameCustomValue method is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of MSFT_IPAM_CustomValue properties

Local properties (3) of MSFT_IPAM_CustomValue class

Category property
CIMTYPE'string'
Description'Specifies if the metadata field is user defined or built in.'
Category property is in 2 classes of ROOT\Microsoft\IPAM and in 11 namespaces
CustomField property
CIMTYPE'string'
Description'Specifies the custom field that this value belongs to.'
CustomField property is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 2 namespaces
Value property
CIMTYPE'string'
Description'Value of the custom metadata field.'
Value property is in 1 class (MSFT_IPAM_CustomValue) of ROOT\Microsoft\IPAM and in 33 namespaces

Derived properties (4) of MSFT_IPAM_CustomValue 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
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.'
keyTrue
readTrue
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces

MSFT_IPAM_CustomValue Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.'
dynamicTrue
locale'MS_409'
provider'IPAMServerPSProvider'
UMLPackagePath'CIM::Core::CoreElements'

MSFT_IPAM_CustomValue System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM:MSFT_IPAM_CustomValue'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT7___SYSTEM3
__RELPATH'MSFT_IPAM_CustomValue'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ManagedElement'___SYSTEM8
__CLASS'MSFT_IPAM_CustomValue'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com