{'Description':'The Name parameter specifies the domain or workgroup to join. This parameter cannot be NULL.','In':True}
Password
string
1
✓
-
{'Description':'If the UserName parameter specifies an account name, the Password parameter must point to the password to use when connecting to the domain controller. Otherwise, this parameter must be NULL. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. ','In':True}
UserName
string
2
✓
-
{'Description':'The Username parameter is a pointer to a constant null-terminated character string that specifies the account name to use when connecting to the domain controller. The string must specify either a domain NetBIOS name and user account (for example, "REDMOND\user") or the user principal name (UPN) of the user in the form of an Internet-style login name (for example, "someone@microsoft.com"). If this parameter is NULL, the caller's context is used. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. ','In':True}
AccountOU
string
3
✓
-
{'Description':'The AccountOU optionally specifies the pointer to a constant null-terminated character string that contains the RFC 1779 format name of the organizational unit (OU) for the computer account. If you specify this parameter, the string must contain a full path, for example, OU=testOU, DC=domain, DC=Domain,DC=com. Otherwise, this parameter must be NULL. ','In':True}
FJoinOptions
uint32
4
✓
-
{'BitMap':['0', '1', '2', '4', '5', '6', '7', '8', '18'],'BitValues':['Join Domain', 'Acct Create', 'Acct Delete', 'Win9X Upgrade', 'Domain Join If Joined', 'Join Unsecure', 'Machine Password Passed', 'Deferred SPN Set', 'Install Invocation'],'Description':'The FJoinOptions parameter contains a set of bit flags defining the join options. This parameter can be one or more of the following values: Join Domain - Joins the computer to a domain. If this value is not specified, joins the computer to a workgroup. 0 bit - Join Domain - If not present, a workgroup is joined. 1 bit - Acct Create - Creates the account on the domain. 2 bit - Acct Delete - Delete the account when a domain is left. 4 bit - Win9X Upgrade - The join operation is occurring as part of an upgrade of Windows 95/98 to Windows NT/Windows 2000. 5 bit - Domain Join If Joined - Allows a join to a new domain even if the computer is already joined to a domain. 6 bit - Join Unsecure - Performs an unsecured join.7 bit - Machine Password Passed - Indicates that the machine (not user) password is passed. This option is only valid for unsecure joins 8 bit - Deferred SPN Set - Specifies that writing SPN and DnsHostName attributes on the computer object should be deferred until the rename that will follow the join. 18 bit - Install Invocation - The APIs were invoked during install. The method returns a 0 if no options are involved.','In':True}
Description
'The JoinDomainOrWorkgroup method joins computer systems to a domain or workgroup. This method is only available on Windows 2000 platforms and beyond. The method can return the following values: 0 - Success. Other - For integer values other than those listed above, refer to Win32 error code documentation. Note: If moving a computer from a Domain to a WorkGroup, the computer must first be removed from the domain before running this method to join the Workgroup. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. '
Implemented
True
ValueMap
['0', '..']
Values
['Success', 'Other']
JoinDomainOrWorkgroup method is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
{'Description':'The Name parameter specifies the new name. The name cannot include control characters, leading or trailing spaces, or any of the following characters: / \ [ ] : | < > + = ; , ? ','In':True}
Password
string
1
✓
-
{'Description':'If the UserName parameter specifies an account name, the Password parameter must point to the password to use when connecting to the domain controller. Otherwise, this parameter must be NULL. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. This parameter is only used for domain renames on Windows 2000 platforms and beyond. ','In':True}
UserName
string
2
✓
-
{'Description':'The Username parameter is a pointer to a constant null-terminated character string that specifies the account name to use when connecting to the domain controller. The string must specify either a domain NetBIOS name and user account (for example, "REDMOND\user") or the user principal name (UPN) of the user in the form of an Internet-style login name (for example, "someone@microsoft.com"). If this parameter is NULL, the caller's context is used. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. This parameter is only used for domain renames on Windows 2000 platforms and beyond. ','In':True}
Description
'The Rename method is used to change the name of a computer either in a workgroup or a domain. When working remotely, the Rename method does not function for Windows XP Home Edition or on Professional Edition (workgroup only). It should be noted that, for any computer in a domain (except the Domain Controller, since it can authenticate itself), delegation is required as a second hop is needed from the machine being remoted over to the Domain Controller for authentication. There are no restrictions for local cases. If the Password and Username parameters are specified, then the connection to winmgmt must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. The method can return the following values: 0 - Success. Reboot required. Other - For integer values other than those listed above, refer to Win32 error code documentation.'
{'Description':'If the UserName parameter specifies an account name, the Password parameter must point to the password to use when connecting to the domain controller. Otherwise, this parameter must be NULL. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. ','In':True}
UserName
string
1
✓
-
{'Description':'The Username parameter is a pointer to a constant null-terminated character string that specifies the account name to use when connecting to the domain controller. The string must specify either a domain NetBIOS name and user account (for example, "REDMOND\user") or the user principal name (UPN) of the user in the form of an Internet-style login name (for example, "someone@microsoft.com"). If this parameter is NULL, the caller's context is used. Blank password is passed by using an empty string Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. ','In':True}
FUnjoinOptions
uint32
2
✓
-
{'BitMap':['2'],'BitValues':['Acct Delete'],'Description':'The FUnjoinOptions parameter specifies the unjoin options. If this parameter is NETSETUP_ACCT_DELETE, the account is disabled when the unjoin occurs. Note that this option does not delete the account. Currently, there are no other unjoin options defined. 2 bit - Acct Delete - Delete the account when a domain is left. The method returns a 0 if no options are involved.','In':True}
Description
'The UnjoinDomainOrWorkgroup method un-joins or removes a computer system from a domain or workgroup. This method is only available on Windows 2000 platforms and beyond. The method can return the following values: 0 - Success. Other - For integer values other than those listed above, refer to Win32 error code documentation. Password and Username must use a high authentication level (i.e. no less than RPC_C_AUTHN_LEVEL_PKT_PRIVACY) when they connect to winmgmt (i.e. in the call to obtain the IWbemServices interface) or SetProxyBlanket on their IWbemServices ptr. If they are local to winmgmt then this is not a concern because their authentication level is as good as RPC_C_AUTHN_LEVEL_PKT_PRIVACY as well as their client request never goes over the wire to get to the winmgmt. If Password and Username are left null, the provider does not care. If the provider determines that the authentication level is too low and a Password or Username has been specified then WBEM_E_ENCRYPTED_CONNECTION_REQUIRED will be returned. '
Implemented
True
ValueMap
['0', '..']
Values
['Success', 'Other']
UnjoinDomainOrWorkgroup method is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'SetPowerState method defines the desired power state of a computer system and its running operating system, and when the system should be put into that state. The PowerState parameter is specified as one of the valid integer values defined for the property, PowerState. 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 system should power on again. power off is immediate. SetPowerState should return 0 if successful, 1 if the specified power state and time requests are not supported, and some other value if any other error occurred.'
'The AutomaticManagedPagefile property determines whether the system managed pagefile is enabled. This capability is notAvailable on windows server 2003,XP and lower versions. Values: TRUE or FALSE. If TRUE, the automatic managed pagefile is enabled.'
MappingStrings
['WMI']
read
True
write
True
AutomaticManagedPagefile property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The AutomaticResetBootOption property determines whether the automatic reset boot option is enabled, i.e. whether the machine will try to reboot after a system failure. Values: TRUE or FALSE. If TRUE, the automatic reset boot option is enabled.'
'The AutomaticResetCapability property determines whether the auto reboot feature is available with this machine. This capability is available on Windows NT but not on Windows 95. Values: TRUE or FALSE. If TRUE, the automatic reset is enabled.'
MappingStrings
['WMI']
read
True
AutomaticResetCapability property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The BootROMSupported property determines whether a boot ROM is supported. Values are TRUE or FALSE. If BootROMSupported equals TRUE, then a boot ROM is supported.'
MappingStrings
['WMI']
read
True
BootROMSupported property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The BootupState property specifies how the system was started. Fail-safe boot (also called SafeBoot) bypasses the user's startup files. Constraints: Must have a value.'
MappingStrings
['Win32API|GetSystemMetrics|SM_CLEANBOOT']
read
True
Values
['Normal boot', 'Fail-safe boot', 'Fail-safe with network boot']
BootupState property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The DaylightInEffect property specifies if the daylight savings is in effect. Values: TRUE or FALSE. If TRUE, daylight savings is presently being observed. In most cases this means that the current time is one hour earlier than the standard time.'
'The DomainRole property indicates the role this computer plays within its assigned domain-workgroup. The domain-workgroup is a collection of computers on the same network. For example, the DomainRole property may show this computer is a "Member Workstation" (value of [1]).'
MappingStrings
['Win32API|Directory Service (Ds) Structures| DSROLE_PRIMARY_DOMAIN_INFO_BASIC|DSROLE_MACHINE_ROLE| MachineRole']
'The EnableDaylightSavingsTime property indicates whether Daylight Savings Time is recognized on this machine. FALSE - time does not move an hour ahead or behind in the year. NULL - the status of DST is unknown on this system'
write
True
EnableDaylightSavingsTime property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The HypervisorPresent property determines whether the system is running under a hypervisor that follows the industry standard convention for reporting a hypervisor is present. Values: TRUE or FALSE. If TRUE, a hypervisor is present.'
MappingStrings
['WMI']
read
True
HypervisorPresent property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The InfraredSupported property determines whether an infrared (IR) port exists on the computer system. Values are TRUE or FALSE. If InfraredSupported equals TRUE, then an IR port exists.'
MappingStrings
['WMI']
read
True
InfraredSupported property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The NetworkServerModeEnabled property determines whether Network Server Mode is enabled. Values: TRUE or FALSE. If TRUE, Network Server Mode is enabled.'
'The NumberOfProcessors property indicates the number of physical processors currently available on the system. This is the number of processors whose status is "enabled" - versus simply the number of processors for the computer system. The former can be determined by enumerating the number of processor instances associated with the computer system object, using the Win32_ComputerSystemProcessor association.'
MappingStrings
['Win32API|System Information Structures|SYSTEM_INFO|dwNumberOfProcessors']
read
True
NumberOfProcessors property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 9 namespaces
'This structure contains free form strings defined by the OEM. Examples of this are: Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc.'
MappingStrings
['SMBIOS|Type 11|OEM Strings']
read
True
OEMStringArray property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The PartOfDomain property indicates whether the computer is part of a domain or workgroup. If TRUE, the computer is part of a domain. If FALSE, the computer is part of a workgroup. If NULL, the computer is not part of a network group, or is unknown.'
MappingStrings
['']
read
True
PartOfDomain property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The PauseAfterReset property identifies the time delay before the reboot is initiated. It is used after a system power cycle, system reset (local or remote), and automatic system reset. A value of -1 indicates that the pause value is unknown'
MappingStrings
['SMBIOS|Type 23|Timeout']
read
True
Units
'milliseconds'
PauseAfterReset property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The ResetCount property indicates the number of automatic resets since the last intentional reset. A value of -1 indicates that the count is unknown.'
MappingStrings
['SMBIOS|Type 23|System Reset|Reset Count']
read
True
ResetCount property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 4 namespaces
'The ResetLimit property indicates the number of consecutive time the system reset will be attempted. A value of -1 indicates that the limit is unknown'
MappingStrings
['SMBIOS|Type 23|System Reset| Reset Limit']
read
True
ResetLimit property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The SystemStartupOptions property array indicates the options for starting up the computer system. Note that this property is not writable on IA64 bit machines. Constraints: Must have a value.
Note: The SE_SYSTEM_ENVIRONMENT privilege is required on IA64bit machines. This privilege is not required for other systems.'
'The SystemStartupSetting property indicates the index of the default start profile. This value is 'calculated' so that it usually returns zero (0) because at write-time, the profile string is physically moved to the top of the list. (This is how Windows NT determines which value is the default.)
Note: The SE_SYSTEM_ENVIRONMENT privilege is required on IA64bit machines. This privilege is not required for 32bit systems.'
MappingStrings
['WMI']
Privileges
['SeSystemEnvironmentPrivilege']
read
True
write
True
SystemStartupSetting property is in 1 class (Win32_ComputerSystem) of ROOT\cimv2 and in 2 namespaces
'The CreationClassName property 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.'
'This object contains the data needed to find either the initial load device (its key) or the boot service to request the operating system to start up. In addition, the load parameters (ie, a pathname and parameters) may also be specified.'
'The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
'This object contains the data identifying either the initial load device (its key) or the boot service that requested the last operating system load. In addition, the load parameters (ie, a pathname and parameters) may also be specified.'
'The CIM_ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique CIM_System keys is required. A heuristic is defined to create the CIM_ComputerSystem name to attempt to always generate the same name, independent of discovery protocol. This prevents inventory and management problems where the same asset or entity is discovered multiple times, but can not be resolved to a single object. Use of the heuristic is optional, but recommended.
The NameFormat property identifies how the computer system name is generated, using a heuristic. The heuristic is outlined, in detail, in the CIM V2 Common Model specification. It assumes that the documented rules are traversed in order, to determine and assign a name. The NameFormat values list defines the precedence order for assigning the computer system name. Several rules do map to the same Value.
Note that the CIM_ComputerSystem Name calculated using the heuristic is the system's key value. Other names can be assigned and used for the CIM_ComputerSystem that better suit the business, using Aliases.'
'Indicates the specific power-related capabilities of a computer system and its associated running operating system. The 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 system 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 parameter set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.'
MappingStrings
['MIF.DMTF|System Power Controls|001.2']
read
True
Values
['Unknown', 'Not Supported', 'Disabled', 'Enabled', 'Power Saving Modes Entered Automatically', 'Power State Settable', 'Power Cycling Supported', 'Timed Power On Supported']
'Boolean indicating that the ComputerSystem, with its running OperatingSystem, supports power management. 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.'
'Indicates the current power state of the computer system and its associated operating system. Regarding the power saving states, these are defined as follows: Value 4 (Unknown) indicates that the system is known to be in a power save mode, but its exact status in this mode is unknown; 2 (Low Power Mode) indicates that the system is in a power save state but still functioning, and may exhibit degraded performance; 3 (Standby) describes that the system is not functioning but could be brought to full power 'quickly'; and value 7 (Warning) indicates that the computerSystem is in a warning state, though also in a power save mode.'
read
True
Values
['Unknown', 'Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Unknown', 'Power Cycle', 'Power Off', 'Power Save - Warning', 'Power Save - Hibernate', 'Power Save - Soft Off']
'If enabled (value = 4), the unitary computer system can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2).'
'An array (bag) of strings that specify the roles this System plays in the IT-environment. Subclasses of System may override this property to define explicit Roles values. Alternately, a Working Group may describe the heuristics, conventions and guidelines for specifying Roles. For example, for an instance of a networking system, the Roles property might contain the string, 'Switch' or 'Bridge'.'
'The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be 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", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.'