CIM29 Class Declaration
CIM_Printer

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_Printer --> CIM_LogicalDevice --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalDevice
NAMECIM_Printer

Class Qualifiers

Class CIM_Printer Qualifiers
NameTypeValueFrom Class
Versionstring2.7.1 CIM_Printer
DescriptionstringCapabilities and management of the Printer LogicalDevice. CIM_Printer
DescriptionstringAn 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. CIM_LogicalDevice
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
PrinterStatusuint16 Description
ValueMap
Values
MappingStrings
CIM_Printer
DetectedErrorStateuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_Printer
ErrorInformationstring[] Description
ModelCorrespondence
CIM_Printer
PaperSizesSupporteduint16[] Description
ValueMap
Values
CIM_Printer
PaperTypesAvailablestring[] Description
MappingStrings
ArrayType
ModelCorrespondence
CIM_Printer
DefaultPaperTypestring Description
ModelCorrespondence
CIM_Printer
CurrentPaperTypestring Description
ModelCorrespondence
CIM_Printer
LanguagesSupporteduint16[] Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_Printer
MimeTypesSupportedstring[] Description
ModelCorrespondence
CIM_Printer
CurrentLanguageuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_Printer
CurrentMimeTypestring Description
ModelCorrespondence
CIM_Printer
DefaultLanguageuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_Printer
DefaultMimeTypestring Description
ModelCorrespondence
CIM_Printer
JobCountSinceLastResetuint32 Description
Counter
CIM_Printer
TimeOfLastResetdatetime Description CIM_Printer
Capabilitiesuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_Printer
CapabilityDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_Printer
DefaultCapabilitiesuint16[] Description
ValueMap
Values
ModelCorrespondence
CIM_Printer
CurrentCapabilitiesuint16[] Description
ValueMap
Values
ModelCorrespondence
CIM_Printer
MaxCopiesuint32 Description
ModelCorrespondence
CIM_Printer
DefaultCopiesuint32 Description CIM_Printer
MaxNumberUpuint32 Description
ModelCorrespondence
CIM_Printer
DefaultNumberUpuint32 Description CIM_Printer
HorizontalResolutionuint32 Description
Units
ModelCorrespondence
CIM_Printer
VerticalResolutionuint32 Description
Units
ModelCorrespondence
CIM_Printer
CharSetsSupportedstring[] Description
MappingStrings
ArrayType
ModelCorrespondence
CIM_Printer
CurrentCharSetstring Description
ModelCorrespondence
CIM_Printer
NaturalLanguagesSupportedstring[] Description
MappingStrings
ArrayType
ModelCorrespondence
CIM_Printer
CurrentNaturalLanguagestring Description
ModelCorrespondence
CIM_Printer
MaxSizeSupporteduint32 Description
Units
ModelCorrespondence
CIM_Printer
AvailableJobSheetsstring[] Description
ModelCorrespondence
CIM_Printer
MarkingTechnologyuint16 Description
ValueMap
Values
MappingStrings
CIM_Printer
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_LogicalDevice
SystemNamestring Key
Propagated
Description
MaxLen
CIM_LogicalDevice
CreationClassNamestring Key
Description
MaxLen
CIM_LogicalDevice
DeviceIDstring Key
Description
MaxLen
CIM_LogicalDevice
PowerManagementSupportedboolean Deprecated
Description
CIM_LogicalDevice
PowerManagementCapabilitiesuint16[] Deprecated
Description
ValueMap
Values
CIM_LogicalDevice
Availabilityuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_LogicalDevice
StatusInfouint16 Deprecated
Description
ValueMap
Values
MappingStrings
CIM_LogicalDevice
LastErrorCodeuint32 Deprecated
Description
CIM_LogicalDevice
ErrorDescriptionstring Deprecated
Description
CIM_LogicalDevice
ErrorClearedboolean Deprecated
Description
CIM_LogicalDevice
OtherIdentifyingInfostring[] Description
MaxLen
ArrayType
ModelCorrespondence
CIM_LogicalDevice
PowerOnHoursuint64 Description
Units
Counter
CIM_LogicalDevice
TotalPowerOnHoursuint64 Description
Units
Counter
CIM_LogicalDevice
IdentifyingDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_LogicalDevice
AdditionalAvailabilityuint16[] Description
ValueMap
Values
ModelCorrespondence
CIM_LogicalDevice
MaxQuiesceTimeuint64 Deprecated
Description
Units
CIM_LogicalDevice
EnabledStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property PrinterStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringStatus information for a Printer, beyond that specified in the LogicalDevice Availability property. Values include " Idle " (3) and an indication that the Device is currently printing (4). CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringOther
Unknown
Idle
Printing
Warmup
Stopped Printing
Offline
CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.hrPrinterStatus CIM_Printer

NameValue
1Other
2Unknown
3Idle
4Printing
5Warmup
6Stopped Printing
7Offline
Property DetectedErrorState Qualifiers
NameTypeValueFrom Class
DescriptionstringPrinter error information. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringUnknown
Other
No Error
Low Paper
No Paper
Low Toner
No Toner
Door Open
Jammed
Offline
Service Requested
Output Bin Full
CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.hrPrinterDetectedErrorState CIM_Printer
ModelCorrespondencestringCIM_Printer.ErrorInformation CIM_Printer

NameValue
0Unknown
1Other
2No Error
3Low Paper
4No Paper
5Low Toner
6No Toner
7Door Open
8Jammed
9Offline
10Service Requested
11Output Bin Full
Property ErrorInformation Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array providing supplemental information for the current error state, indicated in DetectedErrorState. CIM_Printer
ModelCorrespondencestringCIM_Printer.DetectedErrorState CIM_Printer

Property PaperSizesSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringAn integer array indicating the types of paper supported. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringUnknown
Other
A
B
C
D
E
Letter
Legal
NA-10x13-Envelope
NA-9x12-Envelope
NA-Number-10-Envelope
NA-7x9-Envelope
NA-9x11-Envelope
NA-10x14-Envelope
NA-Number-9-Envelope
NA-6x9-Envelope
NA-10x15-Envelope
A0
A1
A2
A3
A4
A5
A6
A7
A8
A9
A10
B0
B1
B2
B3
B4
B5
B6
B7
B8
B9
B10
C0
C1
C2
C3
C4
C5
C6
C7
C8
ISO-Designated
JIS B0
JIS B1
JIS B2
JIS B3
JIS B4
JIS B5
JIS B6
JIS B7
JIS B8
JIS B9
JIS B10
NA-Letter
NA-Legal
B4-Envelope
B5-Envelope
C3-Envelope
C4-Envelope
C5-Envelope
C6-Envelope
Designated-Long-Envelope
Monarch-Envelope
Executive
Folio
Invoice
Ledger
Quarto
CIM_Printer

NameValue
0Unknown
1Other
2A
3B
4C
5D
6E
7Letter
8Legal
9NA-10x13-Envelope
10NA-9x12-Envelope
11NA-Number-10-Envelope
12NA-7x9-Envelope
13NA-9x11-Envelope
14NA-10x14-Envelope
15NA-Number-9-Envelope
16NA-6x9-Envelope
17NA-10x15-Envelope
18A0
19A1
20A2
21A3
22A4
23A5
24A6
25A7
26A8
27A9
28A10
29B0
30B1
31B2
32B3
33B4
34B5
35B6
36B7
37B8
38B9
39B10
40C0
41C1
42C2
43C3
44C4
45C5
46C6
47C7
48C8
49ISO-Designated
50JIS B0
51JIS B1
52JIS B2
53JIS B3
54JIS B4
55JIS B5
56JIS B6
57JIS B7
58JIS B8
59JIS B9
60JIS B10
61NA-Letter
62NA-Legal
63B4-Envelope
64B5-Envelope
65C3-Envelope
66C4-Envelope
67C5-Envelope
68C6-Envelope
69Designated-Long-Envelope
70Monarch-Envelope
71Executive
72Folio
73Invoice
74Ledger
75Quarto
Property PaperTypesAvailable Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of free-form strings specifying the types of paper that are currently available on the Printer. Each string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB). Examples of valid strings are " iso-a4-colored " and " na-10x14-envelope " . By definition a paper size that is available and listed in PaperTypesAvailable should also appear in the PaperSizesSupported property. CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMediaName CIM_Printer
ArrayTypestringIndexed CIM_Printer
ModelCorrespondencestringCIM_PrintJob.RequiredPaperType
CIM_PrintService.PaperTypesAvailable
CIM_Printer

Property DefaultPaperType Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the paper type that the Printer will use if a PrintJob does not specify a particular type. The string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB). CIM_Printer
ModelCorrespondencestringCIM_Printer.PaperTypesAvailable CIM_Printer

Property CurrentPaperType Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the paper type that the Printer is currently using. The string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB). CIM_Printer
ModelCorrespondencestringCIM_Printer.PaperTypesAvailable CIM_Printer

Property LanguagesSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array indicating the print languages natively supported. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringOther
Unknown
PCL
HPGL
PJL
PS
PSPrinter
IPDS
PPDS
EscapeP
Epson
DDIF
Interpress
ISO6429
Line Data
MODCA
REGIS
SCS
SPDL
TEK4014
PDS
IGP
CodeV
DSCDSE
WPS
LN03
CCITT
QUIC
CPAP
DecPPL
Simple Text
NPAP
DOC
imPress
Pinwriter
NPDL
NEC201PL
Automatic
Pages
LIPS
TIFF
Diagnostic
CaPSL
EXCL
LCDS
XES
MIME
TIPSI
Prescribe
LinePrinter
IDP
XJCL
PDF
RPDL
IntermecIPL
UBIFingerprint
UBIDirectProtocol
Fujitsu
PCLXL
CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.prtInterpreterLangFamily CIM_Printer
ModelCorrespondencestringCIM_Printer.MimeTypesSupported
CIM_PrintJob.Language
CIM_PrintService.LanguagesSupported
CIM_Printer

NameValue
1Other
2Unknown
3PCL
4HPGL
5PJL
6PS
7PSPrinter
8IPDS
9PPDS
10EscapeP
11Epson
12DDIF
13Interpress
14ISO6429
15Line Data
16MODCA
17REGIS
18SCS
19SPDL
20TEK4014
21PDS
22IGP
23CodeV
24DSCDSE
25WPS
26LN03
27CCITT
28QUIC
29CPAP
30DecPPL
31Simple Text
32NPAP
33DOC
34imPress
35Pinwriter
36NPDL
37NEC201PL
38Automatic
39Pages
40LIPS
41TIFF
42Diagnostic
43CaPSL
44EXCL
45LCDS
46XES
47MIME
48TIPSI
50Prescribe
51LinePrinter
52IDP
53XJCL
54PDF
55RPDL
56IntermecIPL
57UBIFingerprint
58UBIDirectProtocol
59Fujitsu
60PCLXL
Property MimeTypesSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of free-form strings providing more detailed explanations of any mime types that are supported by the Printer. If data is provided for this property, then the value 47, " Mime " , should be included in the Languages Supported property. CIM_Printer
ModelCorrespondencestringCIM_Printer.LanguagesSupported
CIM_PrintJob.MimeTypes
CIM_PrintService.MimeTypesSupported
CIM_Printer

Property CurrentLanguage Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current printer language being used. A language that is being used by the Printer should also be listed in LanguagesSupported. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringOther
Unknown
PCL
HPGL
PJL
PS
PSPrinter
IPDS
PPDS
EscapeP
Epson
DDIF
Interpress
ISO6429
Line Data
MODCA
REGIS
SCS
SPDL
TEK4014
PDS
IGP
CodeV
DSCDSE
WPS
LN03
CCITT
QUIC
CPAP
DecPPL
Simple Text
NPAP
DOC
imPress
Pinwriter
NPDL
NEC201PL
Automatic
Pages
LIPS
TIFF
Diagnostic
CaPSL
EXCL
LCDS
XES
MIME
TIPSI
Prescribe
LinePrinter
IDP
XJCL
PDF
RPDL
IntermecIPL
UBIFingerprint
UBIDirectProtocol
Fujitsu
PCLXL
CIM_Printer
ModelCorrespondencestringCIM_Printer.LanguagesSupported
CIM_Printer.CurrentMimeType
CIM_Printer

NameValue
1Other
2Unknown
3PCL
4HPGL
5PJL
6PS
7PSPrinter
8IPDS
9PPDS
10EscapeP
11Epson
12DDIF
13Interpress
14ISO6429
15Line Data
16MODCA
17REGIS
18SCS
19SPDL
20TEK4014
21PDS
22IGP
23CodeV
24DSCDSE
25WPS
26LN03
27CCITT
28QUIC
29CPAP
30DecPPL
31Simple Text
32NPAP
33DOC
34imPress
35Pinwriter
36NPDL
37NEC201PL
38Automatic
39Pages
40LIPS
41TIFF
42Diagnostic
43CaPSL
44EXCL
45LCDS
46XES
47MIME
48TIPSI
50Prescribe
51LinePrinter
52IDP
53XJCL
54PDF
55RPDL
56IntermecIPL
57UBIFingerprint
58UBIDirectProtocol
59Fujitsu
60PCLXL
Property CurrentMimeType Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the mime type currently being used by the Printer if the CurrentLanguage is set to indicate a mime type is in use (value = 47). CIM_Printer
ModelCorrespondencestringCIM_Printer.CurrentLanguage CIM_Printer

Property DefaultLanguage Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the default printer language. A language that is used as a default by the Printer should also be listed in LanguagesSupported. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringOther
Unknown
PCL
HPGL
PJL
PS
PSPrinter
IPDS
PPDS
EscapeP
Epson
DDIF
Interpress
ISO6429
Line Data
MODCA
REGIS
SCS
SPDL
TEK4014
PDS
IGP
CodeV
DSCDSE
WPS
LN03
CCITT
QUIC
CPAP
DecPPL
Simple Text
NPAP
DOC
imPress
Pinwriter
NPDL
NEC201PL
Automatic
Pages
LIPS
TIFF
Diagnostic
CaPSL
EXCL
LCDS
XES
MIME
TIPSI
Prescribe
LinePrinter
IDP
XJCL
PDF
RPDL
IntermecIPL
UBIFingerprint
UBIDirectProtocol
Fujitsu
PCLXL
CIM_Printer
ModelCorrespondencestringCIM_Printer.LanguagesSupported
CIM_Printer.DefaultMimeType
CIM_Printer

NameValue
1Other
2Unknown
3PCL
4HPGL
5PJL
6PS
7PSPrinter
8IPDS
9PPDS
10EscapeP
11Epson
12DDIF
13Interpress
14ISO6429
15Line Data
16MODCA
17REGIS
18SCS
19SPDL
20TEK4014
21PDS
22IGP
23CodeV
24DSCDSE
25WPS
26LN03
27CCITT
28QUIC
29CPAP
30DecPPL
31Simple Text
32NPAP
33DOC
34imPress
35Pinwriter
36NPDL
37NEC201PL
38Automatic
39Pages
40LIPS
41TIFF
42Diagnostic
43CaPSL
44EXCL
45LCDS
46XES
47MIME
48TIPSI
50Prescribe
51LinePrinter
52IDP
53XJCL
54PDF
55RPDL
56IntermecIPL
57UBIFingerprint
58UBIDirectProtocol
59Fujitsu
60PCLXL
Property DefaultMimeType Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the default mime type used by the Printer if the DefaultLanguage is set to indicate a mime type is in use (value=47). CIM_Printer
ModelCorrespondencestringCIM_Printer.DefaultLanguage CIM_Printer

Property JobCountSinceLastReset Qualifiers
NameTypeValueFrom Class
DescriptionstringPrinter jobs processed since last reset. These jobs may be processed from one or more PrintQueues. CIM_Printer
Counterbooleantrue CIM_Printer

Property TimeOfLastReset Qualifiers
NameTypeValueFrom Class
DescriptionstringTime of last reset of the Printer Device. CIM_Printer

Property Capabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of integers indicating Printer capabilities. Information such as " Duplex Printing " (value=3) or " Transparency Printing " (7) is specified in this property. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringUnknown
Other
Color Printing
Duplex Printing
Copies
Collation
Stapling
Transparency Printing
Punch
Cover
Bind
Black and White Printing
One Sided
Two Sided Long Edge
Two Sided Short Edge
Portrait
Landscape
Reverse Portrait
Reverse Landscape
Quality High
Quality Normal
Quality Low
CIM_Printer
ArrayTypestringIndexed CIM_Printer
ModelCorrespondencestringCIM_Printer.CapabilityDescriptions
CIM_PrintJob.Finishing
CIM_PrintService.Capabilities
CIM_Printer

NameValue
0Unknown
1Other
2Color Printing
3Duplex Printing
4Copies
5Collation
6Stapling
7Transparency Printing
8Punch
9Cover
10Bind
11Black and White Printing
12One Sided
13Two Sided Long Edge
14Two Sided Short Edge
15Portrait
16Landscape
17Reverse Portrait
18Reverse Landscape
19Quality High
20Quality Normal
21Quality Low
Property CapabilityDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of free-form strings providing more detailed explanations for any of the Printer features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index. CIM_Printer
ArrayTypestringIndexed CIM_Printer
ModelCorrespondencestringCIM_Printer.Capabilities CIM_Printer

Property DefaultCapabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies which finishings and other capabilities of the Printer will be used by default. An entry in Default Capabilities should also be listed in the Capabilities array. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringUnknown
Other
Color Printing
Duplex Printing
Copies
Collation
Stapling
Transparency Printing
Punch
Cover
Bind
Black and White Printing
One Sided
Two Sided Long Edge
Two Sided Short Edge
Portrait
Landscape
Reverse Portrait
Reverse Landscape
Quality High
Quality Normal
Quality Low
CIM_Printer
ModelCorrespondencestringCIM_Printer.Capabilities CIM_Printer

NameValue
0Unknown
1Other
2Color Printing
3Duplex Printing
4Copies
5Collation
6Stapling
7Transparency Printing
8Punch
9Cover
10Bind
11Black and White Printing
12One Sided
13Two Sided Long Edge
14Two Sided Short Edge
15Portrait
16Landscape
17Reverse Portrait
18Reverse Landscape
19Quality High
20Quality Normal
21Quality Low
Property CurrentCapabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies which finishings and other capabilities of the Printer are currently being used. An entry in this property should also be listed in the Capabilities array. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringUnknown
Other
Color Printing
Duplex Printing
Copies
Collation
Stapling
Transparency Printing
Punch
Cover
Bind
Black and White Printing
One Sided
Two Sided Long Edge
Two Sided Short Edge
Portrait
Landscape
Reverse Portrait
Reverse Landscape
Quality High
Quality Normal
Quality Low
CIM_Printer
ModelCorrespondencestringCIM_Printer.Capabilities CIM_Printer

NameValue
0Unknown
1Other
2Color Printing
3Duplex Printing
4Copies
5Collation
6Stapling
7Transparency Printing
8Punch
9Cover
10Bind
11Black and White Printing
12One Sided
13Two Sided Long Edge
14Two Sided Short Edge
15Portrait
16Landscape
17Reverse Portrait
18Reverse Landscape
19Quality High
20Quality Normal
21Quality Low
Property MaxCopies Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum number of copies that can be produced by the Printer from a single Job. CIM_Printer
ModelCorrespondencestringCIM_PrintJob.Copies CIM_Printer

Property DefaultCopies Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of copies that will be produced for a single Job unless otherwise specified. CIM_Printer

Property MaxNumberUp Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum number of print-stream pages that the Printer can render onto a single media sheet. CIM_Printer
ModelCorrespondencestringCIM_PrintJob.NumberUp CIM_Printer

Property DefaultNumberUp Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of print-stream pages that the Printer will render onto a single media sheet unless a Job specifies otherwise. CIM_Printer

Property HorizontalResolution Qualifiers
NameTypeValueFrom Class
DescriptionstringPrinter ’ s horizontal resolution in Pixels per Inch. CIM_Printer
UnitsstringPixels per Inch CIM_Printer
ModelCorrespondencestringCIM_PrintJob.HorizontalResolution CIM_Printer

Property VerticalResolution Qualifiers
NameTypeValueFrom Class
DescriptionstringPrinter ’ s vertical resolution in Pixels per Inch. CIM_Printer
UnitsstringPixels per Inch CIM_Printer
ModelCorrespondencestringCIM_PrintJob.HorizontalResolution CIM_Printer

Property CharSetsSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the available character sets for the output of text related to managing the Printer. Strings provided in this property should conform to the semantics and syntax specified by section 4.1.2 ( " Charset parameter " ) in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include " utf-8 " , " us-ascii " and " iso-8859-1 " . CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.prtLocalizationCharacterSet CIM_Printer
ArrayTypestringIndexed CIM_Printer
ModelCorrespondencestringCIM_PrintJob.CharSet CIM_Printer

Property CurrentCharSet Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the current character set being used for the output of text relating to management of the Printer. The character set described by this property should also be listed in CharsetsSupported. The string specified by this property should conform to the semantics and syntax specified by section 4.1.2 ( " Charset parameter " ) in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include " utf-8 " , " us-ascii " and " iso-8859-1 " . CIM_Printer
ModelCorrespondencestringCIM_Printer.CharSetsSupported CIM_Printer

Property NaturalLanguagesSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the available languages for strings used by the Printer for the output of management information. The strings should conform to RFC 1766, for example " en " is used for English. CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.prtLocalizationLanguage CIM_Printer
ArrayTypestringIndexed CIM_Printer
ModelCorrespondencestringCIM_PrintJob.NaturalLanguage CIM_Printer

Property CurrentNaturalLanguage Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the current language being used by the Printer for management. The language listed in the CurrentNaturalLanguage property should also be listed in NaturalLanguagesSupported. CIM_Printer
ModelCorrespondencestringCIM_Printer.NaturalLanguagesSupported CIM_Printer

Property MaxSizeSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the largest Job (as a byte stream) that the Printer will accept in units of Kbytes. A value of zero indicates that no limit has been set. CIM_Printer
UnitsstringKiloBytes CIM_Printer
ModelCorrespondencestringCIM_PrintJob.JobSize CIM_Printer

Property AvailableJobSheets Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes all of the job sheets that are available on the Printer. This can also be used to describe the banner that a Printer might provide at the beginning of each Job, or can describe other user specified options. CIM_Printer
ModelCorrespondencestringCIM_PrintJob.RequiredJobSheets CIM_Printer

Property MarkingTechnology Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the marking technology used by the Printer. CIM_Printer
ValueMapstring
[See below.]
CIM_Printer
ValuesstringOther
Unknown
Electrophotographic LED
Electrophotographic Laser
Electrophotographic Other
Impact Moving Head Dot Matrix 9pin
Impact Moving Head Dot Matrix 24pin
Impact Moving Head Dot Matrix Other
Impact Moving Head Fully Formed
Impact Band
Impact Other
Inkjet Aqueous
Inkjet Solid
Inkjet Other
Pen
Thermal Transfer
Thermal Sensitive
Thermal Diffusion
Thermal Other
Electroerosion
Electrostatic
Photographic Microfiche
Photographic Imagesetter
Photographic Other
Ion Deposition
eBeam
Typesetter
CIM_Printer
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerMarkTech CIM_Printer

NameValue
1Other
2Unknown
3Electrophotographic LED
4Electrophotographic Laser
5Electrophotographic Other
6Impact Moving Head Dot Matrix 9pin
7Impact Moving Head Dot Matrix 24pin
8Impact Moving Head Dot Matrix Other
9Impact Moving Head Fully Formed
10Impact Band
11Impact Other
12Inkjet Aqueous
13Inkjet Solid
14Inkjet Other
15Pen
16Thermal Transfer
17Thermal Sensitive
18Thermal Diffusion
19Thermal Other
20Electroerosion
21Electrostatic
22Photographic Microfiche
23Photographic Imagesetter
24Photographic Other
25Ion Deposition
26eBeam
27Typesetter
Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
PropagatedstringCIM_System.CreationClassName CIM_LogicalDevice
DescriptionstringThe scoping System ’ s CreationClassName. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
PropagatedstringCIM_System.Name CIM_LogicalDevice
DescriptionstringThe scoping System ’ s Name. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
DescriptionstringCreationClassName 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. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice

Property DeviceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
DescriptionstringAn address or other identifying information to uniquely name the LogicalDevice. CIM_LogicalDevice
MaxLenuint3264 CIM_LogicalDevice

Property PowerManagementSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported. CIM_LogicalDevice

Property PowerManagementCapabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringAn enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringUnknown
Not Supported
Disabled
Enabled
Power Saving Modes Entered Automatically
Power State Settable
Power Cycling Supported
Timed Power On Supported
CIM_LogicalDevice

NameValue
0Unknown
1Not Supported
2Disabled
3Enabled
4Power Saving Modes Entered Automatically
5Power State Settable
6Power Cycling Supported
7Timed Power On Supported
Property Availability Qualifiers
NameTypeValueFrom Class
DescriptionstringThe primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) 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. CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
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
Not Configured
Quiesced
CIM_LogicalDevice
MappingStringsstringMIF.DMTF|Operational State|006.5
MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus
MIF.DMTF|Host Device|001.5
CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.AdditionalAvailability CIM_LogicalDevice

NameValue
1Other
2Unknown
3Running/Full Power
4Warning
5In Test
6Not Applicable
7Power Off
8Off Line
9Off Duty
10Degraded
11Not Installed
12Install Error
13Power Save - Unknown
14Power Save - Low Power Mode
15Power Save - Standby
16Power Cycle
17Power Save - Warning
18Paused
19Not Ready
20Not Configured
21Quiesced
Property StatusInfo Qualifiers
NameTypeValueFrom Class
DescriptionstringThe StatusInfo property indicates whether the Logical Device 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. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement. If a Device is ( " Enabled " )(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ( " Running/Full Power " )(value=3) or ( " Off line " ) (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ( " Disabled " ) StatusInfo value=4), a Device can only be " enabled " or powered off. In a personal computer environment, ( " Disabled " ) means that the Device ’ s driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other " enabling " activity has occurred. CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
Unknown
Enabled
Disabled
Not Applicable
CIM_LogicalDevice
MappingStringsstringMIF.DMTF|Operational State|006.4 CIM_LogicalDevice

NameValue
1Other
2Unknown
3Enabled
4Disabled
5Not Applicable
Property LastErrorCode Qualifiers
NameTypeValueFrom Class
DescriptionstringLastErrorCode captures the last error code reported by the LogicalDevice. CIM_LogicalDevice

Property ErrorDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. CIM_LogicalDevice

Property ErrorCleared Qualifiers
NameTypeValueFrom Class
DescriptionstringErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. CIM_LogicalDevice

Property OtherIdentifyingInfo Qualifiers
NameTypeValueFrom Class
DescriptionstringOtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System ’ s user friendly name for the Device in this property. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice
ArrayTypestringIndexed CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.IdentifyingDescriptions CIM_LogicalDevice

Property PowerOnHours Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of consecutive hours that this Device has been powered, since its last power cycle. CIM_LogicalDevice
UnitsstringHours CIM_LogicalDevice
Counterbooleantrue CIM_LogicalDevice

Property TotalPowerOnHours Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of hours that this Device has been powered. CIM_LogicalDevice
UnitsstringHours CIM_LogicalDevice
Counterbooleantrue CIM_LogicalDevice

Property IdentifyingDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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. CIM_LogicalDevice
ArrayTypestringIndexed CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.OtherIdentifyingInfo CIM_LogicalDevice

Property AdditionalAvailability Qualifiers
NameTypeValueFrom Class
DescriptionstringAdditional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device ’ s primary Availability may be " Off line " (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, " In Test " ). CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
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
Not Configured
Quiesced
CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.Availability CIM_LogicalDevice

NameValue
1Other
2Unknown
3Running/Full Power
4Warning
5In Test
6Not Applicable
7Power Off
8Off Line
9Off Duty
10Degraded
11Not Installed
12Install Error
13Power Save - Unknown
14Power Save - Low Power Mode
15Power Save - Standby
16Power Cycle
17Power Save - Warning
18Paused
19Not Ready
20Not Configured
21Quiesced
Property MaxQuiesceTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later. Maximum time in milliseconds, that a Device can run in a " Quiesced " state. A Device ’ s state is defined in its Availability and AdditionalAvailability properties, where " Quiesced " is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely. CIM_LogicalDevice
UnitsstringMilliSeconds CIM_LogicalDevice

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element doesn ’ t support being enabled/disabled. Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element ’ s behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the element ’ s enabled/disabled state when the EnabledState property is set to 1 ( " Other " ). This property MUST be set to NULL when EnabledState is any value other than 1. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the element ’ s RequestedState is 5 ( " No Change " ). Refer to the EnabledState ’ s property Description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). The former, Reboot, refers to doing a " Shut Down " and then moving to an " Enabled " state. The latter, Reset, indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator ’ s default/startup configuration for an element ’ s Enabled State. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date/time when the element ’ s EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated. CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 ManagedSystemElement ’ s Name property 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 MAY be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
SetPowerStateuint32 Deprecated
Description
PowerState
Time
CIM_LogicalDevice
Resetuint32 Description  CIM_LogicalDevice
EnableDeviceuint32 Deprecated
Description
EnabledCIM_LogicalDevice
OnlineDeviceuint32 Deprecated
Description
OnlineCIM_LogicalDevice
QuiesceDeviceuint32 Deprecated
Description
QuiesceCIM_LogicalDevice
SavePropertiesuint32 Description  CIM_LogicalDevice
RestorePropertiesuint32 Description  CIM_LogicalDevice
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method SetPowerState Qualifiers
NameTypeValueFrom Class
DescriptionstringSets the power state of the Device. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class. CIM_LogicalDevice

Method Reset Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests 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. CIM_LogicalDevice

Method EnableDevice Qualifiers
NameTypeValueFrom Class
DescriptionstringThe EnableDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be enabled ( " Enabled " input parameter = TRUE) or disabled (= FALSE). If successful, the Device ’ s StatusInfo/EnabledState properties should reflect the desired state (enabled/disabled). Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the EnableDevice method should set the RequestedState property appropriately. 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. CIM_LogicalDevice

Method OnlineDevice Qualifiers
NameTypeValueFrom Class
DescriptionstringThe OnlineDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be brought online ( " Online " input parameter = TRUE) or taken offline (= FALSE). " Online " indicates that the Device is ready to accept requests, and is operational and fully functioning. In this case, the Device ’ s Availability property would be set to a value of 3 ( " Running/Full Power " ). " Offline " indicates that a Device is powered up and operational, but not processing functional requests. In an offline state, a Device may be capable of running diagnostics or generating operational alerts. For example, when the " Offline " button is pushed on a Printer, the Device is no longer available to process print jobs, but could be available for diagnostics or maintenance. If this method is successful, the Device ’ s Availability and AdditionalAvailability properties should reflect the updated status. If a failure occurs trying to bring the Device online or offline, it should remain in its current state. IE, the request, if unsuccessful, should not leave the Device in an indeterminate state. When bringing a Device back " Online " , from an " Offline " mode, the Device should be restored to its last " Online " state, if at all possible. Only a Device that has an EnabledState/StatusInfo of " Enabled " and has been configured can be brought online or taken offline. OnlineDevice should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, 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. Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the OnlineDevice method should set the RequestedState property appropriately. CIM_LogicalDevice

Method QuiesceDevice Qualifiers
NameTypeValueFrom Class
DescriptionstringThe QuiesceDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice cleanly cease all current activity ( " Quiesce " input parameter = TRUE) or resume activity (= FALSE). For this method to quiesce a Device, that Device should have an Availability (or Additional Availability) of " Running/Full Power " (value=3) and an EnabledStatus/StatusInfo of " Enabled " . For example, if quiesced, a Device may then be offlined for diagnostics, or disabled for power off and hot swap. For the method to " unquiesce " a Device, that Device should have an Availability (or AdditionalAvailability) of " Quiesced " (value=21) and an EnabledStatus/StatusInfo of " Enabled " . In this case, the Device would be returned to an " Enabled " and " Running/Full Power " status. The method ’ s return code should indicate the success or failure of the quiesce. It should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, 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. CIM_LogicalDevice

Method SaveProperties Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the Device capture its current configuration, setup and/or state information in a backing store. The goal would be to use this information at a later time (via the RestoreProperties method), to return a Device to its present " condition " . This method may not be supported by all Devices. The method should return 0 if successful, 1 if the 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. CIM_LogicalDevice

Method RestoreProperties Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the Device re-establish its configuration, setup and/or state information from a backing store. The intent is to capture this information at an earlier time (via the SaveProperties method), and use it to return a Device to this earlier " condition " . This method may not be supported by all Devices. The method should return 0 if successful, 1 if the 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. CIM_LogicalDevice

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the element ’ s state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element ’ s EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted with No Error
Not Supported
Unknown/Unspecified Error
Can NOT complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method SetPowerState Parameters
NameTypeQualifiers
PowerStateuint16IN
Description
ValueMap
Values
TimedatetimeIN
Description

Method EnableDevice Parameters
NameTypeQualifiers
EnabledbooleanIN
Description

Method OnlineDevice Parameters
NameTypeQualifiers
OnlinebooleanIN
Description

Method QuiesceDevice Parameters
NameTypeQualifiers
QuiescebooleanIN
Description

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter PowerState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringThe power state to set. CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringFull Power
Power Save - Low Power Mode
Power Save - Standby
Power Save - Other
Power Cycle
Power Off
CIM_LogicalDevice

Parameter Time Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringTime 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. CIM_LogicalDevice

Parameter Enabled Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf TRUE enable the device, if FALSE disable the device. CIM_LogicalDevice

Parameter Online Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf TRUE, take the device online, if FALSE, take the device OFFLINE. CIM_LogicalDevice

Parameter Quiesce Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf set to TRUE then cleanly cease all activity, if FALSE resume activity. CIM_LogicalDevice

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe state requested for the element. This information will be placed into the instance ’ s RequestedState property if the RequestStateChange method ’ s return code is 0, 3, or 4096 (0x1000) - ’ Completed with No Error ’ , ’ Timeout ’ , or ’ Job Started ’ respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format MUST be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation doesn ’ t support this parameter. A return code of ’ Use Of Timeout Parameter Not Supported ’ MUST be returned. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_PrinterServicingQueueCIM_PrinterAntecedent
CIM_PrinterServicingJobCIM_PrinterAntecedent
CIM_PortOnDeviceCIM_LogicalDeviceAntecedent
CIM_RealizesCIM_LogicalDeviceDependent
CIM_DeviceServiceImplementationCIM_LogicalDeviceAntecedent
CIM_DeviceSAPImplementationCIM_LogicalDeviceAntecedent
CIM_DeviceAccessedByFileCIM_LogicalDeviceDependent
CIM_AllocatedResourceCIM_LogicalDeviceDependent
CIM_AllocatedDMACIM_LogicalDeviceDependent
CIM_DeviceConnectionCIM_LogicalDeviceAntecedent
CIM_DeviceConnectionCIM_LogicalDeviceDependent
CIM_ControlledByCIM_LogicalDeviceDependent
CIM_PackageDependencyCIM_LogicalDeviceAntecedent
CIM_DeviceSoftwareCIM_LogicalDeviceDependent
CIM_AssociatedCoolingCIM_LogicalDeviceDependent
CIM_AssociatedBatteryCIM_LogicalDeviceDependent
CIM_SuppliesPowerCIM_LogicalDeviceDependent
CIM_ProtocolControllerForDeviceCIM_LogicalDeviceDependent
CIM_ProtocolControllerForUnitCIM_LogicalDeviceDependent
CIM_ProtocolControllerAccessesUnitCIM_LogicalDeviceDependent
CIM_AssociatedLabelReaderCIM_LogicalDeviceDependent
CIM_DoorAccessToDeviceCIM_LogicalDeviceDependent
CIM_AssociatedSensorCIM_LogicalDeviceDependent
CIM_AssociatedAlarmCIM_LogicalDeviceDependent
CIM_SystemDeviceCIM_LogicalDevicePartComponent
CIM_DeviceIdentityCIM_LogicalDeviceSystemElement
CIM_DeviceIdentityCIM_LogicalDeviceSameElement
CIM_DeviceStatisticsCIM_LogicalDeviceElement
CIM_ErrorCountersForDeviceCIM_LogicalDeviceElement
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement