Guest Windows Registry Manager List Registry Keys In Guest

List all registry subkeys for a given registry key.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/GuestWindowsRegistryManager/{moId}/ListRegistryKeysInGuest

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

ListRegistryKeysInGuestRequestType of type(s) application/json

Required

Show optional properties

{
    "vm": {},
    "auth": {
        "interactiveSession": false
    },
    "keyName": {
        "registryPath": "string",
        "wowBitness": "string"
    },
    "recursive": false
}

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "keyName": {
        "_typeName": "string",
        "registryPath": "string",
        "wowBitness": "string"
    },
    "recursive": false,
    "matchPattern": "string"
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication

auth

Required

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

GuestRegKeyNameSpec

keyName

Required

This describes the registry key name.

boolean

recursive

Required

If true, all subkeys are listed recursively.

string

matchPattern

Optional

A filter for the key names returned, specified using perl-compatible regular expressions. If matchPattern is unset, then the pattern '.*' is used, which returns all key names found, otherwise only those key names that match the input pattern shall be returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The list of subkeys is returned in an array of GuestRegKeySpec structures.

Returns Array of GuestRegKeyRecordSpec of type(s) application/json

[
    {
        "_typeName": "string",
        "key": {
            "_typeName": "string",
            "keyName": {
                "_typeName": "string",
                "registryPath": "string",
                "wowBitness": "string"
            },
            "classType": "string",
            "lastWritten": "string"
        },
        "fault": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    }
]

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Guest Windows Registry Manager Create Registry Key In Guest