diag

Documentation

Index

• Constants
• func CheckAPIAvailability(targetURL string) int
• func UserReadableVCAPITestDescription(code int) string

Constants

const (
	// VCStatusOK vSphere API is available.
	VCStatusOK = 0
	// VCStatusInvalidURL Provided vSphere API URL is wrong.
	VCStatusInvalidURL = 64
	// VCStatusErrorQuery Error happened trying to query vSphere API
	VCStatusErrorQuery = 65
	// VCStatusErrorResponse Received response doesn't contain expected data.
	VCStatusErrorResponse = 66
	// VCStatusIncorrectResponse Received in case if returned data from server is different from expected.
	VCStatusIncorrectResponse = 67
	// VCStatusNotXML Received response is not XML
	VCStatusNotXML = 68
	// VCStatusUnknownHost is returned in case if DNS failed to resolve name.
	VCStatusUnknownHost = 69
	// VCStatusHostIsNotReachable
	VCStatusHostIsNotReachable = 70
)

const StatusCodeFatalThreshold = 64

StatusCodeFatalThreshold defines a threshold after which all codes can be treated as fatal.

Functions

func CheckAPIAvailability

func CheckAPIAvailability(targetURL string) int

CheckAPIAvailability accesses vSphere API to ensure it is a correct end point that is up and running.

func UserReadableVCAPITestDescription

func UserReadableVCAPITestDescription(code int) string

UserReadableVCAPITestDescription convert API test code into user readable text