Computer Management Provider::Get Machine Configuration

The Get Machine Configuration method allows you to retrieve the configuration of a specified server. Domain, username, and password are required for this method to function correctly.

Note

The Get Machine Configuration method cannot be used on the machine hosting the MPF Engine.

Arguments

Input argument	Required	Description
ComputerName	Yes	A string containing the NetBIOS name or the fully qualified domain name (FQDN) of the target server.
Hardware	Yes	Values are True or False (indicated by 1 or 0), to specify whether to return hardware information.
Software	Yes	Values are True or False (indicated by 1 or 0), to specify whether to return software information.
Username	Yes	The username to be used when connecting to the server. This parameter is the "key" parameter for using declarative authentication, meaning that if this value is present, the password and domain are then required. If this value is not present, values for the other two nodes will be ignored.
Password	Yes	The password of the user connecting to the server. If username is provided, this value is required; otherwise it is ignored.
Domain	Yes	The domain to use in conjunction with the username above. If username is provided, this value is required; otherwise it is ignored.
[perfCounterList]	No	A collection of performance counters to return.
[perfCounter]	No	A node representing a performance counter to return. @category - the category of the performance counter to return. @counter - the name of the counter to return. @instance - the instance of the counter to return, if any.

Output argument	Description
Names	A collection of names for the specified computer.
NetBIOS	The NetBIOS name for the specified computer.
Domain	The domain (workgroup) for the specified computer.
[hardware]	If the [hardware] input parameter is set to 1, a hardware node with various details about the physical machine will be returned.
IP	The current (primary) IP address assigned to the server.
CPU	Text description of the CPU(s).
Memory	Text description of the available memory.
Disks	A collection of disk nodes.
Disk	A node representing a disk (virtual or physical) available to the O/S: @id - the unique identifier/index number of the disk. @letter - the letter representation for this disk. @name - the string representation of the label assigned to this disk. @spaceAvailable - the total space available on the drive (max size). @spaceConsumed - the total space that has been allocated on the drive.
[software]	If the [software] input parameter is set to 1, a software node will be returned with various details about the software installed on the specified computer.
OS	The operating system installed on the computer.
SP	The service pack level of the O/S installed on the computer.
Locale	The locale of the O/S installed on the computer.
[perfCounters]	If perfCounterList is present and not empty in the input, this node will exist in the output and will contain a list of performance counters and their values at the instant in time that they were read by the provider.

Remarks

Sample Code

Example XML Request

The following is an example of an XML request for the Get Machine Configuration method of the Computer Manager Provider:

<request>
		<procedure>
				<execute namespace="Computer Management Provider" procedure="Get Machine Configuration">
						<executeData>
								<computerName>Web01</computerName>
								<hardware>1</hardware>
								<software>1</software>
								<perfCounterList>
								<perfCounter category="Memory" counter="Available MBytes" instance="" />
								<perfCounter category="Processor" counter="% Processor Time" instance="_Total" />
								</perfCounterList>
						</executeData>
				</execute>
		</procedure>
</request>

Example XML Response

The following is an example of an XML response for the Get Machine Configuration method of the Computer Manager Provider:

<response>
		<data>
				<names>
						<netBIOS>TestBox</netBIOS>
						<domain>test.local</domain>
				</names>
				<hardware>
						<IP>10.1.1.1</IP>
						<CPU>Pentium(R) 4 CPU 2.6GHz</CPU>
						<Memory>2 GB of RAM</Memory>
						<Disks>
								<Disk id="0" letter="C" name="Local Disk" spaceAvailable="20GB" 
										spaceConsumed="10GB" />
								<Disk id="1" letter="D" name="App Data" spaceAvailable="200GB" 
										spaceConsumed="100GB" />
						</Disks>
				</hardware>
				<software>
						<OS>Windows 2003 Standard</OS>
						<SP>SP1</SP>
						<locale>United States</locale>
				</software>
				<perfCounters>
						<perfCounter category="Memory" counter="Available MBytes" instance="">24</perfCounter>
						<perfCounter category="Processor" counter="% Processor Time" instance="_Total ">29</perfCounter>
				</perfCounters>
		</data>
</response>

Applies To