MSFT_MaskingSet, ROOT\Microsoft\Windows\Storage

Class | Methods (10) | Properties (9) | Qualifiers (5) | Instances (1) | Namespaces (3)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

A masking set is a collection of virtual disks, target ports, and initiator ids that are used for bulk Show and Hide operations. When a resource is added to a masking set it is made available for access to all other resources in the masking set. For example, adding a virtual disk object to a masking set will allow all initiator IDs in the masking set to access the virtual disk object.

MSFT_MaskingSet methods

MSFT_MaskingSet has 10 methods (10 Local)

NameOriginReturn
AddInitiatorIdMSFT_MaskingSetuint32 {'out':True}
AddTargetPortMSFT_MaskingSetuint32 {'out':True}
AddVirtualDiskMSFT_MaskingSetuint32 {'out':True}
DeleteObjectMSFT_MaskingSetuint32 {'out':True}
GetSecurityDescriptorMSFT_MaskingSetuint32 {'out':True}
RemoveInitiatorIdMSFT_MaskingSetuint32 {'out':True}
RemoveTargetPortMSFT_MaskingSetuint32 {'out':True}
RemoveVirtualDiskMSFT_MaskingSetuint32 {'out':True}
SetFriendlyNameMSFT_MaskingSetuint32 {'out':True}
SetSecurityDescriptorMSFT_MaskingSetuint32 {'out':True}

MSFT_MaskingSet properties

MSFT_MaskingSet has 9 properties (3 Local, 6 Derived)

NameOriginCIMType
FriendlyNameMSFT_MaskingSet8 [string]
HostTypeMSFT_MaskingSet18 [uint16]
NameMSFT_MaskingSet8 [string]
key
ObjectId
MSFT_StorageObject8 [string]
PassThroughClassMSFT_StorageObject8 [string]
PassThroughIdsMSFT_StorageObject8 [string]
PassThroughNamespaceMSFT_StorageObject8 [string]
PassThroughServerMSFT_StorageObject8 [string]
UniqueIdMSFT_StorageObject8 [string]

Detailed description of MSFT_MaskingSet methods

Local methods (10) of MSFT_MaskingSet class

AddInitiatorId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InitiatorIdsstring0-{'Description':'This parameter is an array of initiator addresses. For each address contained in this array, a corresponding initiator ID instance should be created and then associated with this masking set.','In':True,'Required':True}
HostTypeuint161-{'In':True,'ValueMap':['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22..32767', '32768..65535'],'Values':['Unknown', 'Other', 'Standard', 'Solaris', 'HPUX', 'OpenVMS', 'Tru64', 'Netware', 'Sequent', 'AIX', 'DGUX', 'Dynix', 'Irix', 'Cisco iSCSI Storage Router', 'Linux', 'Microsoft Windows', 'OS400', 'TRESPASS', 'HI-UX', 'VMware ESXi', 'Microsoft Windows Server 2008', 'Microsoft Windows Server 2003', 'Microsoft Reserved', 'Vendor Specific']}
RunAsJobboolean2-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob3-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus4-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method adds an initiator to the masking set. All virtual disks in the masking set will be accessible (shown) to these initiators.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '53000', '53001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The initiator address specified is not valid', 'Only one initiator address is acceptable for this operation.']
AddInitiatorId method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
AddTargetPort method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
TargetPortAddressesstring0-{'In':True,'Required':True}
RunAsJobboolean1-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob2-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus3-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method adds one or more target ports to the masking set.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '54000']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The target port address specified is not valid.']
AddTargetPort method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
AddVirtualDisk method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
VirtualDiskNamesstring0-{'In':True,'Required':True}
DeviceNumbersstring1-{'In':True,'Required':True}
DeviceAccessesuint162-{'In':True,'Required':True,'ValueMap':['2', '3', '4'],'Values':['Read Write', 'Read-Only', 'No Access']}
RunAsJobboolean3-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob4-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus5-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method adds a virtual disk to the masking set, allowing it to be shown to the initiators contained in the set.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '50000', '52000', '52002']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The specified virtual disk could not be found.', 'The device number specified is not valid.', 'DeviceAccess must be specified for each virtual disk.']
AddVirtualDisk method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
DeleteObject method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RunAsJobboolean0-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob1-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus2-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method deletes the masking set instance.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '40003', '46000', '46001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cache out of date', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.']
DeleteObject method is in 6 classes of ROOT\Microsoft\Windows\Storage and in 4 namespaces
GetSecurityDescriptor method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SecurityDescriptorstring0-{'Description':'A Security Descriptor Definition Language (SDDL) formed string describing the access control list of the object.','Out':True,'Required':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method returns the security descriptor that controls access to this specific object instance.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.']
GetSecurityDescriptor method is in 6 classes of ROOT\Microsoft\Windows\Storage and in 142 namespaces
RemoveInitiatorId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InitiatorIdsstring0-{'In':True,'Required':True}
RunAsJobboolean1-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob2-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus3-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method removes one or more initiator ids from the masking set. Note that the initiator id instances themselves should not be deleted from the system.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '53000']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The initiator address specified is not valid']
RemoveInitiatorId method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
RemoveTargetPort method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
TargetPortAddressesstring0-{'In':True,'Required':True}
RunAsJobboolean1-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob2-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus3-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method removes one or more target ports from the masking set.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '54000']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The target port address specified is not valid.']
RemoveTargetPort method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
RemoveVirtualDisk method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
VirtualDiskNamesstring0-{'In':True,'Required':True}
RunAsJobboolean1-{'Description':'This parameter controls the asynchronous behavior the method will follow.If TRUE, this method will make use of the CreatedStorageJob out parameter when the request is taking a long time to service. If a storage job has been created to track the operation, this method will return 4096 - 'Method Parameters Checked - Job Started'. Note, even if RunAsJob is TRUE, the method can still return a result if it has finished in sufficient time. If FALSE or NULL, this method will follow default WMI asynchronous behavior as determined by the client's method for invocation (i.e. synchronous unless requested otherwise).','In':True}
CreatedStorageJobref:MSFT_StorageJob2-{'Description':'If RunAsJob is set to TRUE and this method takes a while to execute, this parameter returns a reference to the storage job used to track the long running operation.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus3-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method removes a virtual disk from the masking set. Once removed, this virtual disk will no longer be shown to the initiators contained in this masking set.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001', '50000']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.', 'The specified virtual disk could not be found.']
RemoveVirtualDisk method is in 1 class (MSFT_MaskingSet) of ROOT\Microsoft\Windows\Storage and in 3 namespaces
SetFriendlyName method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
FriendlyNamestring0-{'In':True,'Required':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method allows the FriendlyName to be set.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '40003', '46000', '46001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cache out of date', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.']
SetFriendlyName method is in 5 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
SetSecurityDescriptor method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SecurityDescriptorstring0-{'Description':'A Security Descriptor Definition Language (SDDL) formed string describing the desired access control list for this object.','In':True,'Required':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Description':'ExtendedStatus allows the storage provider to return extended (implementation specific) error information.','EmbeddedInstance':'MSFT_StorageExtendedStatus','Out':True}
Description'This method allows a user with sufficient privileges to set the security descriptor that control access to this specific object instance. If the call is not made in the context of a user specified in the security descriptor's access control list, this method will fail with 40001 - 'Access Denied'. If an empty security descriptor is passed to this function, the behavior is left to the specific implementation so long as there is some user context (typically domain administrators) that can access and administer the object.'
implementedTrue
ValueMap['0', '1', '2', '3', '4', '5', '40001', '40002', '46000', '46001']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot connect to the storage provider.', 'The storage provider cannot connect to the storage subsystem.']
SetSecurityDescriptor method is in 6 classes of ROOT\Microsoft\Windows\Storage and in 142 namespaces

Detailed description of MSFT_MaskingSet properties

Local properties (3) of MSFT_MaskingSet class

FriendlyName property
CIMTYPE'string'
Description'FriendlyName is a user-friendly name of the masking set. It is specified during the creation of the masking set, and can be changed using the SetFriendlyName method.'
readTrue
RequiredTrue
FriendlyName property is in 9 classes of ROOT\Microsoft\Windows\Storage and in 22 namespaces
HostType property
CIMTYPE'uint16'
Description'This field specifies the operating system, version, driver, and other host environment factors that influence the behavior exposed by the storage subsystem.'
readTrue
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22..32767', '32768..65535']
Values['Unknown', 'Other', 'Standard', 'Solaris', 'HPUX', 'OpenVMS', 'Tru64', 'Netware', 'Sequent', 'AIX', 'DGUX', 'Dynix', 'Irix', 'Cisco iSCSI Storage Router', 'Linux', 'Microsoft Windows', 'OS400', 'TRESPASS', 'HI-UX', 'VMware ESXi', 'Microsoft Windows Server 2008', 'Microsoft Windows Server 2003', 'Microsoft Reserved', 'Vendor Specific']
HostType property is in 2 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
Name property
CIMTYPE'string'
Description'Name is a user-friendly system defined name for the masking set. Name is unique within the scope of the owning storage subsystem.'
readTrue
RequiredTrue
Name property is in 14 classes of ROOT\Microsoft\Windows\Storage and in 142 namespaces

Derived properties (6) of MSFT_MaskingSet class

ObjectId property
CIMTYPE'string'
Description'ObjectId is a mandatory property that is used to opaquely and uniquely identify an instance of a class. ObjectIds must be unique within the scope of the management server (which is hosting the provider). The ObjectId is created and maintained for use of the Storage Management Providers and their clients to track instances of objects. If an object is visible through two different paths (for example: there are two separate Storage Management Providers that point to the same storage subsystem) then the same object may appear with two different ObjectIds. For determining if two object instances are the same object, refer to the UniqueId property.'
keyTrue
readTrue
RequiredTrue
ObjectId property is in 20 classes of ROOT\Microsoft\Windows\Storage and in 6 namespaces
PassThroughClass property
CIMTYPE'string'
Description'PassThroughClass is the WBEM class name of the proprietary storage provider object.'
readTrue
PassThroughClass property is in 17 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
PassThroughIds property
CIMTYPE'string'
Description'PassThroughIds is a comma-separated list of all implementation specific keys. It is used by storage management applications to access the vendor proprietary object model. This field should be in the form: key1='value1',key2='value2'.'
readTrue
PassThroughIds property is in 17 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
PassThroughNamespace property
CIMTYPE'string'
Description'PassThroughNamespace is the WBEM namespace that contains the proprietary storage provider classes.'
readTrue
PassThroughNamespace property is in 17 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
PassThroughServer property
CIMTYPE'string'
Description'PassThroughServer is the name or address of the computer system hosting the proprietary storage provider classes.'
readTrue
PassThroughServer property is in 17 classes of ROOT\Microsoft\Windows\Storage and in 3 namespaces
UniqueId property
CIMTYPE'string'
Description'UniqueId is a mandatory property that is used to uniquely identify a logical instance of a storage subsystem's object. This value must be the same for an object viewed by two or more provider instances (even if they are running on seperate management servers). UniqueId can be any globally unique, opaque value unless otherwise specified by a derived class.'
readTrue
RequiredTrue
UniqueId property is in 18 classes of ROOT\Microsoft\Windows\Storage and in 6 namespaces

MSFT_MaskingSet Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0'
Description'A masking set is a collection of virtual disks, target ports, and initiator ids that are used for bulk Show and Hide operations. When a resource is added to a masking set it is made available for access to all other resources in the masking set. For example, adding a virtual disk object to a masking set will allow all initiator IDs in the masking set to access the virtual disk object.'
dynamicTrue
locale'MS_409'
provider'StorageWMI'

MSFT_MaskingSet System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\Storage:MSFT_MaskingSet'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\Storage'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['MSFT_StorageObject']___SYSTEM8
__PROPERTY_COUNT9___SYSTEM3
__RELPATH'MSFT_MaskingSet'___SYSTEM8
__DYNASTY'MSFT_StorageObject'___SYSTEM8
__SUPERCLASS'MSFT_StorageObject'___SYSTEM8
__CLASS'MSFT_MaskingSet'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_MaskingSet

Number of classes:9
comments powered by Disqus
WUtils.com