Guest Alias Manager Add Guest Alias
Defines an alias for a guest account in a virtual machine.
After the alias is defined, the ESXi Server will use the alias to authenticate guest operations requests.
This will add the given VMware SSO Server's certificate and a subject to the alias store of the specified user in the guest.
In order to add an alias to the guest, you must supply an existing valid credential. This can be any instance of GuestAuthentication, but must be valid for the specified guest username.
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}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"vm": {},
"auth": {
"interactiveSession": false
},
"username": "string",
"mapCert": false,
"base64Cert": "string",
"aliasInfo": {
"subject": {},
"comment": "string"
}
}{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"auth": {
"_typeName": "string",
"interactiveSession": false
},
"username": "string",
"mapCert": false,
"base64Cert": "string",
"aliasInfo": {
"_typeName": "string",
"subject": {
"_typeName": "string"
},
"comment": "string"
}
}GuestAuthentication is an abstract base class for authentication in the guest.
Username for the guest account on the virtual machine.
Indicates whether the certificate associated with the alias should be mapped. If an alias certificate is mapped, guest operation requests that use that alias do not have to specify the guest account username in the SAMLTokenAuthentication object. If mapCert is false, the request must specify the username.
X.509 certificate from the VMware SSO Server, in base64 encoded DER format. The ESXi Server uses this certificate to authenticate guest operation requests.
Describes a subject associated with an X.509 certificate in the alias store.
No Content
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.
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.
InvalidArgument: if the operation fails because the certificate is invalid.
GuestMultipleMappings: if the operation fails because mapCert is set and the certificate already exists in the mapping file for a different user.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}