MSFT_IPAM_CustomFieldAssociation, ROOT\Microsoft\IPAM\MS_409

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

Description

This defines an association between values of two custom fields, CustomFieldOne and CustomFieldTwo. The set of associated values, AssociationValue, is an array of strings, each of which is an ordered pair denoting value of CustomFieldOne: value of CustomFieldTwo separated by a semicolon.

MSFT_IPAM_CustomFieldAssociation methods

MSFT_IPAM_CustomFieldAssociation has 3 methods (3 Local)

NameOriginReturn
AddMSFT_IPAM_CustomFieldAssociationuint32 {'out':True}
ModifyMSFT_IPAM_CustomFieldAssociationuint32 {'out':True}
RemoveMSFT_IPAM_CustomFieldAssociationuint32 {'out':True}

MSFT_IPAM_CustomFieldAssociation properties

MSFT_IPAM_CustomFieldAssociation has 7 properties (3 Local, 4 Derived)

NameOriginCIMType
AssociationValueMSFT_IPAM_CustomFieldAssociation8 [string]
CaptionCIM_ManagedElement8 [string]
CustomFieldOneMSFT_IPAM_CustomFieldAssociation8 [string]
CustomFieldTwoMSFT_IPAM_CustomFieldAssociation8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
key
InstanceID
CIM_ManagedElement8 [string]

Detailed description of MSFT_IPAM_CustomFieldAssociation methods

Local methods (3) of MSFT_IPAM_CustomFieldAssociation class

Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
CustomFieldOnestring0-{'In':True}
CustomFieldTwostring1-{'In':True}
AssociationValuestring2-{'In':True}
Outputobject:MSFT_IPAM_CustomFieldAssociation3-{'Out':True}
Description'Adds associations between values of custom fields CustomFieldOne and CustomFieldTwo, defined in IPAM.'
Add method is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 17 namespaces
Modify method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
CustomFieldOnestring0-{'In':True}
CustomFieldTwostring1-{'In':True}
AddAssociationValuestring2-{'In':True}
RemoveAssociationValuestring3-{'In':True}
Outputobject:MSFT_IPAM_CustomFieldAssociation4-{'Out':True}
Description'Updates the associations between values of CustomFieldOne and CustomFieldTwo. The ordered pairs in AddAssociationValue array are added to the list, while the ordered pairs in RemoveAssociationValue are removed from the list of associations for the two custom fields'
Modify method is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 3 namespaces
Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
CustomFieldOnestring0-{'In':True}
CustomFieldTwostring1-{'In':True}
Outputobject:MSFT_IPAM_CustomFieldAssociation2-{'Out':True}
Description'Deletes association between two custom fields defined in IPAM.'
Remove method is in 2 classes of ROOT\Microsoft\IPAM\ms_409 and in 18 namespaces

Detailed description of MSFT_IPAM_CustomFieldAssociation properties

Local properties (3) of MSFT_IPAM_CustomFieldAssociation class

AssociationValue property
CIMTYPE'string'
Description'Specifies an array of strings each of which is represented as "CustomFieldValue1:CustomFieldValue2". This defines the values of custom field one which are associated with particular values of custom field 2, separated by a colon (:).'
AssociationValue property is in 1 class (MSFT_IPAM_CustomFieldAssociation) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
CustomFieldOne property
CIMTYPE'string'
Description'Specifies one of the custom fields which is the part of association.'
CustomFieldOne property is in 1 class (MSFT_IPAM_CustomFieldAssociation) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces
CustomFieldTwo property
CIMTYPE'string'
Description'Specifies the second custom field which is part of the association.'
CustomFieldTwo property is in 1 class (MSFT_IPAM_CustomFieldAssociation) of ROOT\Microsoft\IPAM\ms_409 and in 2 namespaces

Derived properties (4) of MSFT_IPAM_CustomFieldAssociation class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 45 classes of ROOT\Microsoft\IPAM\ms_409 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\ms_409 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\ms_409 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
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM\ms_409 and in 21 namespaces

MSFT_IPAM_CustomFieldAssociation Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'This defines an association between values of two custom fields, CustomFieldOne and CustomFieldTwo. The set of associated values, AssociationValue, is an array of strings, each of which is an ordered pair denoting value of CustomFieldOne: value of CustomFieldTwo separated by a semicolon.'
LOCALE'MS_409'

MSFT_IPAM_CustomFieldAssociation System properties

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