|
APIs in Category: vmservices |
API version 1.13 |
vmservices-vsphere-credential-check |
These APIs provide programmatic access to functionality provided only on virtual machine platforms. |
| vmservices-vsphere-credential-check | [top] |
Check vSphere credentials by attempting to login to the vSphere server. The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR Missing username or password. EAPIAUTHENTICATION vSphere server authentication failed. EHOSTNOTFOUND could not resolve server name with DNS EONTAPI_ECONNREFUSED could not connect to server EINTERNALERROR internal error in underlying implementation
Errno Description EOPNOTSUPPORTED EINVALIDINPUTERROR EAPIAUTHENTICATION EHOSTNOTFOUND EONTAPI_ECONNREFUSED EINTERNALERROR
| vmservices-vsphere-credential-get | [top] |
Reports the currently configured vSphere server and username. The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINTERNALERROR internal error in underlying implementation
Output Name Range Type Description server string
optional
The currently configured vSphere server, if any. It can be a hostname if DNS is enabled, otherwise it must be an IP address. username string
optional
The currently configured vSphere username, if any.
Errno Description EOPNOTSUPPORTED EINTERNALERROR
| vmservices-vsphere-credential-modify | [top] |
Modify or set initial value for vSphere server, user, and/or password. The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR argument(s) too large EINTERNALERROR internal error in underlying implementation
Input Name Range Type Description password string
encrypted
optional
Password for the vSphere user. If not specified, the configured password (if any) is not changed. server string
optional
vSphere server managing this VSA instance: either the ESX host itself or its managing vCenter server. It can be a hostname if DNS is enabled, otherwise it must be an IP address. If not specified, the configured server (if any) is not changed. username string
optional
A vSphere username (only "read-only" access required) to be used when connecting to the vSphere server. If not specified, the configured username (if any) is not changed.
Errno Description EOPNOTSUPPORTED EINVALIDINPUTERROR EINTERNALERROR