ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class

2018-05-31

Modifies the setting data for existing resources on a virtual computer system.

Syntax

uint32 ModifyVirtualSystemResources(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [in]  string                 ResourceSettingData[],
  [out] CIM_ConcreteJob    REF Job
);

Parameters

ComputerSystem [in]

Type: CIM_ComputerSystem

A reference to the virtual computer system whose resources are to be modified.

ResourceSettingData [in]

Type: string[]

An array of embedded instances of the CIM_ResourceAllocationSettingData class that describe the resources to be modified on the virtual computer system.

Job [out]

Type: CIM_ConcreteJob

An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.

Return value

Type: uint32

If this method is executed synchronously, it returns 0 if it succeeds. If this method is executed asynchronously, it returns 4096 and the Job output parameter can be used to track the progress of the asynchronous operation. Any other return value indicates an error.

Completed with No Error (0)
Method Parameters Checked - Job Started (4096)
Failed (32768)
Access Denied (32769)
Not Supported (32770)
Status is unknown (32771)
Timeout (32772)
Invalid parameter (32773)
System is in used (32774)
Invalid state for this operation (32775)
Incorrect data type (32776)
System is not available (32777)
Out of memory (32778)

Remarks

Access to the Msvm_VirtualSystemManagementService class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Examples

The following C# sample modifies the settings for the resources of a virtual system. The referenced utilities can be found in Common Utilities for the Virtualization Samples.

[!Important]
To function correctly, the following code must be run on the VM host server, and must be run with Administrator privileges.

using System;
using System.Management;

namespace HyperVSamples
{
    class ModifyVirtualSystemResourcesClass
    {
        ManagementObject virtualSystemService = null;
        ManagementScope scope = null;

        ModifyVirtualSystemResourcesClass()
        {
            scope = new ManagementScope(@"root\virtualization", null);
            virtualSystemService = Utility.GetServiceObject(scope, "Msvm_VirtualSystemManagementService");
        }

        ManagementObject GetVirtualSystemEthernetPortSetting(ManagementObject vmSetting, string SyntheticNicElementName)
        {
            ManagementObject SyntheticNicSetting = null;
            ManagementObjectCollection SyntheticNicSettings = vmSetting.GetRelated
            (
                "Msvm_SyntheticEthernetPortSettingData",
                "Msvm_VirtualSystemSettingDataComponent",
                null,
                null,
                "PartComponent",
                "GroupComponent",
                false,
                null
            );

            foreach (ManagementObject instance in SyntheticNicSettings)
            {
                if (instance["ElementName"].ToString().ToLower() == SyntheticNicElementName.ToLower())
                {
                    SyntheticNicSetting = instance;
                    break;
                }
            }

            return SyntheticNicSetting;

        }

        void ModifyVirtualSystemResources(string vmName, string syntheticNicName, string address)
        {

            ManagementObject vm = Utility.GetTargetComputer(vmName, scope);
            ManagementObject vmSetting = Utility.GetVirtualSystemSettingData(vm);

            ManagementObject syntheticNicPortSetting = GetVirtualSystemEthernetPortSetting(vmSetting, syntheticNicName);

            if (address == null)
            {
                syntheticNicPortSetting["StaticMacAddress"] = false;
            }
            else
            {
                syntheticNicPortSetting["StaticMacAddress"] = true;
                syntheticNicPortSetting["Address"] = address;
            }

            string[] resources = new string[1];
            resources[0] = syntheticNicPortSetting.GetText(TextFormat.CimDtd20);

            ManagementBaseObject inParams = virtualSystemService.GetMethodParameters("ModifyVirtualSystemResources");

            inParams["ComputerSystem"] = vm.Path.Path;
            inParams["ResourcesettingData"] = resources;

            ManagementBaseObject outParams = virtualSystemService.InvokeMethod("ModifyVirtualSystemResources", inParams, null);

            if ((UInt32)outParams["ReturnValue"] == ReturnCode.Started)
            {
                if (Utility.JobCompleted(outParams, scope))
                {
                    Console.WriteLine("SyntheticNic was modified successfully.");

                }
                else
                {
                    Console.WriteLine("Failed to modify SyntheticNic.");
                }
            }
            else if ((UInt32)outParams["ReturnValue"] == ReturnCode.Completed)
            {
                Console.WriteLine("SyntheticNic was modified successfully.");
            }
            else
            {
                Console.WriteLine("Modify SyntheticNic failed with error : {0}", outParams["ReturnValue"]);
            }

            inParams.Dispose();
            outParams.Dispose();
            vm.Dispose();
            vmSetting.Dispose();
            syntheticNicPortSetting.Dispose();
        }

        void Close()
        {
            this.virtualSystemService.Dispose();
        }

        static void Main(string[] args)
        {
            if (args != null &amp;&amp; args.Length != 2 &amp;&amp; args.Length != 3)
            {
                Console.WriteLine("Usage: AddVirtualSystemResources vmName syntheticNicName MACAddress");
                Console.WriteLine("MACAddress: Optional. Static MAC address is used if it's specified.");
                Console.WriteLine("Example: AddVirtualSystemResources MyFirstVM myStaticNic 00155D02B317");
                return;
            }

            string address = null;

            if (args.Length == 3)
            {
                address = args[2];

            }
            ModifyVirtualSystemResourcesClass modifyResource = new ModifyVirtualSystemResourcesClass();

            modifyResource.ModifyVirtualSystemResources(args[0], args[1], address);
            modifyResource.Close();
        }
    }
}

The following VBScript sample modifies the settings for the resources of a virtual system.