AddGuestAliasRequestType

AddGuestAliasRequestType
AddGuestAliasRequestType

The parameters of AddGuestAlias.

JSON Example
{
    "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"
    }
}
vm
Required

Virtual machine to perform the operation on.

Required privileges: VirtualMachine.GuestOperations.ModifyAliases

auth
Required

The guest authentication data for this operation. See GuestAuthentication. These credentials must satisfy authentication requirements for a guest account on the specified virtual machine.

string
username
Required

Username for the guest account on the virtual machine.

boolean
mapCert
Required

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.

string
base64Cert
Required

X.509 certificate from the VMware SSO Server, in base64 encoded DER format. The ESXi Server uses this certificate to authenticate guest operation requests.

aliasInfo
Required

Specifies the subject name for authentication. The subject name (when present) corresponds to the value of the Subject element in SAML tokens. The ESXi Server uses the subject name to authenticate guest operation requests.

Parameter To