MSCluster_NetworkInterface, ROOT\MSCluster\ms_409

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

Description

An abstraction or emulation of a hardware entity, that may or may not be Realized in physical hardware. Any characteristics of a LogicalDevice that are used to manage its operation or configuration are contained in, or associated with, the LogicalDevice object. Examples of the operational properties of a Printer would be paper sizes supported, or detected errors. Examples of the configuration properties of a Sensor Device would be threshold settings. Various configurations could exist for a LogicalDevice. These configurations could be contained in Setting objects and associated with the LogicalDevice.

MSCluster_NetworkInterface methods

MSCluster_NetworkInterface has 4 methods (1 Local, 3 Derived)

NameOriginReturn
EnableDeviceCIM_LogicalDeviceuint32 {'out':True}
ExecuteNetworkInterfaceControlMSCluster_NetworkInterface
ResetCIM_LogicalDeviceuint32 {'out':True}
SetPowerStateCIM_LogicalDeviceuint32 {'out':True}

MSCluster_NetworkInterface properties

MSCluster_NetworkInterface has 33 properties (13 Local, 20 Derived)

NameOriginCIMType
AdapterMSCluster_NetworkInterface8 [string]
AdapterIdMSCluster_NetworkInterface8 [string]
AddressMSCluster_NetworkInterface8 [string]
AvailabilityCIM_LogicalDevice18 [uint16]
CaptionCIM_ManagedSystemElement8 [string]
CharacteristicsMSCluster_NetworkInterface19 [uint32]
CreationClassNameCIM_LogicalDevice8 [string]
DescriptionCIM_ManagedSystemElement8 [string]
key
DeviceID
CIM_LogicalDevice8 [string]
DhcpEnabledMSCluster_NetworkInterface11 [boolean]
ErrorClearedCIM_LogicalDevice11 [boolean]
ErrorDescriptionCIM_LogicalDevice8 [string]
FlagsMSCluster_NetworkInterface19 [uint32]
IdMSCluster_NetworkInterface8 [string]
IdentifyingDescriptionsCIM_LogicalDevice8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
IPv4AddressesMSCluster_NetworkInterface8 [string]
IPv6AddressesMSCluster_NetworkInterface8 [string]
LastErrorCodeCIM_LogicalDevice19 [uint32]
NameCIM_ManagedSystemElement8 [string]
NetworkMSCluster_NetworkInterface8 [string]
NodeMSCluster_NetworkInterface8 [string]
OtherIdentifyingInfoCIM_LogicalDevice8 [string]
PowerManagementCapabilitiesCIM_LogicalDevice18 [uint16]
PowerManagementSupportedCIM_LogicalDevice11 [boolean]
PowerOnHoursCIM_LogicalDevice21 [uint64]
PrivatePropertiesMSCluster_NetworkInterface13 [object:MSCluster_Property]
StateMSCluster_NetworkInterface19 [uint32]
StatusCIM_ManagedSystemElement8 [string]
StatusInfoCIM_LogicalDevice18 [uint16]
SystemCreationClassNameCIM_LogicalDevice8 [string]
key
SystemName
CIM_LogicalDevice8 [string]
TotalPowerOnHoursCIM_LogicalDevice21 [uint64]

Detailed description of MSCluster_NetworkInterface methods

Local methods (1) of MSCluster_NetworkInterface class

ExecuteNetworkInterfaceControl method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
ControlCodesint320-{'Description':'A control code specifying the operation to be performed.'}
InputBufferuint81-{'Description':'An input buffer containing information needed for the operation, or NULL if no information is needed.'}
OutputBufferuint82-{'Description':'An output buffer to receive the data resulting from the operation, or NULL if no data will be returned.'}
OutputBufferSizesint323-{'Description':'The allocated size (in bytes) of the output buffer.'}
Description'Executes a control code on the network interface.'
ExecuteNetworkInterfaceControl method is in 1 class (MSCluster_NetworkInterface) of ROOT\MSCluster\ms_409 and in 2 namespaces

Derived methods (3) of MSCluster_NetworkInterface class

EnableDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Enabledboolean0-
Description'Requests that the LogicalDevice be enabled ("Enabled" input parameter = TRUE) or disabled (= FALSE). If successful, the Device's StatusInfo property should also reflect the desired state (enabled/disabled). The return code should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.'
EnableDevice method is in 2 classes of ROOT\MSCluster\ms_409 and in 10 namespaces
Reset method
Returnuint32 {'out':True}
Description'Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.'
Reset method is in 2 classes of ROOT\MSCluster\ms_409 and in 19 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint160-{'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off']}
Timedatetime1-
Description'SetPowerState defines the desired power state for a LogicalDevice and when a Device should be put into that state. The desired power state is specified by setting the PowerState parameter to one of the following integer values: 1="Full Power", 2="Power Save - Low Power Mode", 3="Power Save - Standby", 4="Power Save - Other", 5="Power Cycle" or 6="Power Off". The Time parameter (for all state changes but 5, "Power Cycle") indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). When the PowerState parameter is equal to 5, "Power Cycle", the Time parameter indicates when the Device should power on again. Power off is immediate. SetPowerState should return 0 if successful, 1 if the specified PowerState and Time request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.'
SetPowerState method is in 4 classes of ROOT\MSCluster\ms_409 and in 14 namespaces

Detailed description of MSCluster_NetworkInterface properties

Local properties (13) of MSCluster_NetworkInterface class

Adapter property
CIMTYPE'string'
Description'The Adapter property provides the name that is used to uniquely identify the network interface in the cluster.'
Adapter property is in 1 class (MSCluster_NetworkInterface) of ROOT\MSCluster\ms_409 and in 4 namespaces
AdapterId property
CIMTYPE'string'
Description'The AdapterId property provides a unique ID for the network interface.'
AdapterId property is in 1 class (MSCluster_NetworkInterface) of ROOT\MSCluster\ms_409 and in 2 namespaces
Address property
CIMTYPE'string'
Description'The Address property provides the primary network address that the node uses for the network interface.'
Address property is in 2 classes of ROOT\MSCluster\ms_409 and in 18 namespaces
Characteristics property
CIMTYPE'uint32'
Description'Retrieves the intrinsic characteristics of a network interface.'
Characteristics property is in 2 classes of ROOT\MSCluster\ms_409 and in 9 namespaces
DhcpEnabled property
CIMTYPE'boolean'
Description'Whether or not DHCP is enabled on the network interface.'
DhcpEnabled property is in 1 class (MSCluster_NetworkInterface) of ROOT\MSCluster\ms_409 and in 9 namespaces
Flags property
CIMTYPE'uint32'
Description'Retrieves the flags that are set for a network interface.'
Flags property is in 3 classes of ROOT\MSCluster\ms_409 and in 142 namespaces
Id property
CIMTYPE'string'
Description'The Id of the network interface.'
Id property is in 9 classes of ROOT\MSCluster\ms_409 and in 33 namespaces
IPv4Addresses property
CIMTYPE'string'
Description'The IPv4 addresses currently assigned to this network interface.'
IPv4Addresses property is in 2 classes of ROOT\MSCluster\ms_409 and in 4 namespaces
IPv6Addresses property
CIMTYPE'string'
Description'The IPv6 addresses currently assigned to this network interface.'
IPv6Addresses property is in 2 classes of ROOT\MSCluster\ms_409 and in 4 namespaces
Network property
CIMTYPE'string'
Description'The Network property provides the name of the network to which the network interface is connected.'
Network property is in 1 class (MSCluster_NetworkInterface) of ROOT\MSCluster\ms_409 and in 7 namespaces
Node property
CIMTYPE'string'
Description'The Node property provides the name of the node in which the network interface is installed.'
Node property is in 2 classes of ROOT\MSCluster\ms_409 and in 3 namespaces
PrivateProperties property
CIMTYPE'object:MSCluster_Property'
Description'Private properties of the NetworkInterface.'
PrivateProperties property is in 7 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
State property
CIMTYPE'uint32'
Description'The current state of the network interface'
Values['Unknown', 'Unavailable', 'Failed', 'Unreachable', 'Up']
State property is in 6 classes of ROOT\MSCluster\ms_409 and in 36 namespaces

Derived properties (20) of MSCluster_NetworkInterface class

Availability property
CIMTYPE'uint16'
Description'The availability and status of the Device. For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the Power Save states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the Device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the Device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the Device is in a warning state, though also in a power save mode.'
Values['Other', 'Unknown', 'Running/Full Power', 'Warning', 'In Test', 'Not Applicable', 'Power Off', 'Off Line', 'Off Duty', 'Degraded', 'Not Installed', 'Install Error', 'Power Save - Unknown', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Cycle', 'Power Save - Warning', 'Paused', 'Not Ready']
Availability property is in 2 classes of ROOT\MSCluster\ms_409 and in 12 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one-line string) of the object.'
Caption property is in 23 classes of ROOT\MSCluster\ms_409 and in 37 namespaces
CreationClassName property
CIMTYPE'string'
Description'CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.'
CreationClassName property is in 11 classes of ROOT\MSCluster\ms_409 and in 20 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides comments about the network interface.'
Description property is in 25 classes of ROOT\MSCluster\ms_409 and in 142 namespaces
DeviceID property
CIMTYPE'string'
Description'An address or other identifying information to uniquely name the LogicalDevice.'
keyTrue
DeviceID property is in 2 classes of ROOT\MSCluster\ms_409 and in 21 namespaces
ErrorCleared property
CIMTYPE'boolean'
Description'ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared.'
ErrorCleared property is in 2 classes of ROOT\MSCluster\ms_409 and in 12 namespaces
ErrorDescription property
CIMTYPE'string'
Description'ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken.'
ErrorDescription property is in 4 classes of ROOT\MSCluster\ms_409 and in 142 namespaces
IdentifyingDescriptions property
CIMTYPE'string'
Description'An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.'
IdentifyingDescriptions property is in 7 classes of ROOT\MSCluster\ms_409 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
Description'A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
InstallDate property is in 23 classes of ROOT\MSCluster\ms_409 and in 23 namespaces
LastErrorCode property
CIMTYPE'uint32'
Description'LastErrorCode captures the last error code reported by the LogicalDevice.'
LastErrorCode property is in 2 classes of ROOT\MSCluster\ms_409 and in 16 namespaces
Name property
CIMTYPE'string'
Description'The Name property provides the Clustering Service-generated name for the network interface.'
Name property is in 29 classes of ROOT\MSCluster\ms_409 and in 142 namespaces
OtherIdentifyingInfo property
CIMTYPE'string'
Description'OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property.'
OtherIdentifyingInfo property is in 7 classes of ROOT\MSCluster\ms_409 and in 20 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
Description'Indicates the specific power-related capabilities of a LogicalDevice. The array values, 0="Unknown", 1="Not Supported" and 2="Disabled" are self-explanatory. The value, 3="Enabled" indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. "Power Saving Modes Entered Automatically" (4) describes that a Device can change its power state based on usage or other criteria. "Power State Settable" (5) indicates that the SetPowerState method is supported. "Power Cycling Supported" (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.'
Values['Unknown', 'Not Supported', 'Disabled', 'Enabled', 'Power Saving Modes Entered Automatically', 'Power State Settable', 'Power Cycling Supported', 'Timed Power On Supported']
PowerManagementCapabilities property is in 4 classes of ROOT\MSCluster\ms_409 and in 14 namespaces
PowerManagementSupported property
CIMTYPE'boolean'
Description'Boolean indicating that the Device can be power managed - ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is false, the integer value 1, for the string, "Not Supported", should be the only entry in the PowerManagementCapabilities array.'
PowerManagementSupported property is in 4 classes of ROOT\MSCluster\ms_409 and in 14 namespaces
PowerOnHours property
CIMTYPE'uint64'
Description'The number of consecutive hours that this Device has been powered, since its last power cycle.'
Units'Hours'
PowerOnHours property is in 2 classes of ROOT\MSCluster\ms_409 and in 13 namespaces
Status property
CIMTYPE'string'
Description'A string indicating the current status of the object. Various operational and non-operational statuses are defined. Operational statuses are "OK", "Degraded", "Stressed" and "Pred Fail". "Stressed" indicates that the Element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. The condition "Pred Fail" (failure predicted) indicates that an Element is functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "NonRecover", "Starting", "Stopping" and "Service". "NonRecover" indicates that a non-recoverable error has occurred. "Service" describes an Element being configured, maintained or cleaned, or otherwise administered. This status could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative task. Not all such work is on-line, yet the Element is neither "OK" nor in one of the other states.'
Status property is in 24 classes of ROOT\MSCluster\ms_409 and in 42 namespaces
StatusInfo property
CIMTYPE'uint16'
Description'StatusInfo is a string indicating whether the LogicalDevice is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the LogicalDevice, the value, 5 ("Not Applicable"), should be used.'
Values['Other', 'Unknown', 'Enabled', 'Disabled', 'Not Applicable']
StatusInfo property is in 2 classes of ROOT\MSCluster\ms_409 and in 12 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'The scoping System's CreationClassName.'
SystemCreationClassName property is in 5 classes of ROOT\MSCluster\ms_409 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'The scoping System's Name.'
keyTrue
SystemName property is in 5 classes of ROOT\MSCluster\ms_409 and in 22 namespaces
TotalPowerOnHours property
CIMTYPE'uint64'
Description'The total number of hours that this Device has been powered.'
Units'Hours'
TotalPowerOnHours property is in 2 classes of ROOT\MSCluster\ms_409 and in 10 namespaces

MSCluster_NetworkInterface Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'An abstraction or emulation of a hardware entity, that may or may not be Realized in physical hardware. Any characteristics of a LogicalDevice that are used to manage its operation or configuration are contained in, or associated with, the LogicalDevice object. Examples of the operational properties of a Printer would be paper sizes supported, or detected errors. Examples of the configuration properties of a Sensor Device would be threshold settings. Various configurations could exist for a LogicalDevice. These configurations could be contained in Setting objects and associated with the LogicalDevice.'
LOCALE1033

MSCluster_NetworkInterface System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\MSCluster\ms_409:MSCluster_NetworkInterface'___SYSTEM8
__NAMESPACE'ROOT\MSCluster\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_LogicalDevice', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']___SYSTEM8
__PROPERTY_COUNT33___SYSTEM3
__RELPATH'MSCluster_NetworkInterface'___SYSTEM8
__DYNASTY'CIM_ManagedSystemElement'___SYSTEM8
__SUPERCLASS'CIM_LogicalDevice'___SYSTEM8
__CLASS'MSCluster_NetworkInterface'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSCluster_NetworkInterface

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSCluster_ClusterToNetworkInterface020----
MSCluster_NetworkToNetworkInterface020----
MSCluster_NodeToNetworkInterface020----
comments powered by Disqus
WUtils.com