Guest Alias Manager Remove Guest Alias

Guest Alias Manager Remove Guest Alias

Removes an alias from the guest so it can no longer be used for authentication of guest operations.

It will also be removed from the mapped credentials.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/GuestAliasManager/{moId}/RemoveGuestAlias
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 GuestAliasManager/{moId}.

string
release
Required

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

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

Show optional properties

{
    "vm": {},
    "auth": {
        "interactiveSession": false
    },
    "username": "string",
    "base64Cert": "string",
    "subject": {}
}
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "username": "string",
    "base64Cert": "string",
    "subject": {
        "_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.

string
username
Required

Username for the guest account on the virtual machine.

string
base64Cert
Required

The X.509 certificate associated with the alias to be removed, in base64 encoded DER format.

GuestAuthSubject
subject
Required

A Subject.

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.

GuestPermissionDenied: if there are insufficient permissions in the guest OS.

InvalidArgument: if the operation fails because the certificate is invalid.

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 Alias Manager Add Guest Alias
POST
Guest Alias Manager List Guest Aliases
POST
Guest Alias Manager List Guest Mapped Aliases
POST
Guest Alias Manager Remove Guest Alias
POST
Guest Alias Manager Remove Guest Alias By Cert