Guest Windows Registry Manager Set Registry Value In Guest

Guest Windows Registry Manager Set Registry Value In Guest

Set/Create a registry value.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/GuestWindowsRegistryManager/{moId}/SetRegistryValueInGuest
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case GuestWindowsRegistryManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
SetRegistryValueInGuestRequestType of type(s) application/json
Required

Show optional properties

{
    "vm": {},
    "auth": {
        "interactiveSession": false
    },
    "value": {
        "name": {
            "keyName": {
                "registryPath": "string",
                "wowBitness": "string"
            },
            "name": "string"
        },
        "data": {}
    }
}
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "value": {
        "_typeName": "string",
        "name": {
            "_typeName": "string",
            "keyName": {
                "_typeName": "string",
                "registryPath": "string",
                "wowBitness": "string"
            },
            "name": "string"
        },
        "data": {
            "_typeName": "string"
        }
    }
}
MoRefVirtualMachine
vm
Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication
auth
Required

GuestAuthentication is an abstract base class for authentication in the guest.

GuestRegValueSpec
value
Required

This describes the registry value.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

GuestOperationsFault: if there is an error processing a guest operation.

GuestOperationsUnavailable: if the VM agent for guest operations is not running.

InvalidPowerState: if the VM is not powered on.

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

TaskInProgress: if the virtual machine is busy.

GuestRegistryKeyInvalid: if the registry key is not valid. Check the HKEY Root specified.

GuestPermissionDenied: if the program path cannot be run because the guest authentication will not allow the operation.

InvalidGuestLogin: if the the guest authentication information was not accepted.

GuestComponentsOutOfDate: if the guest agent is too old to support the operation.

OperationNotSupportedByGuest: if the operation is not supported by the guest OS.

OperationDisabledByGuest: if the operation is not enabled due to guest agent configuration.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Guest Windows Registry Manager Create Registry Key In Guest
POST
Guest Windows Registry Manager Delete Registry Key In Guest
POST
Guest Windows Registry Manager Delete Registry Value In Guest
POST
Guest Windows Registry Manager List Registry Keys In Guest
POST
Guest Windows Registry Manager List Registry Values In Guest
POST
Guest Windows Registry Manager Set Registry Value In Guest