supportbundle

Documentation

Index

• type ContainerClusterNode
• type FailedNodeSupportBundleResult
• type RemainingSupportBundleNode
• type SuccessNodeSupportBundleResult
• type SupportBundleContainerNode
• type SupportBundleFileTransferAuthenticationScheme
• type SupportBundleFileTransferProtocol
• type SupportBundleRemoteFileServer
• type SupportBundleRequest
• type SupportBundleResult

Types

type ContainerClusterNode

type ContainerClusterNode struct {
	// The UUID of the container cluster
	ClusterId string `json:"cluster_id"`
	// List of at most 200 container node UUIDs requiring a support bundle
	Nodes []string `json:"nodes,omitempty"`
}

Container cluster and its nodes requiring a support bundle

type FailedNodeSupportBundleResult

type FailedNodeSupportBundleResult struct {
	// Error code
	ErrorCode string `json:"error_code,omitempty"`
	// Error message
	ErrorMessage string `json:"error_message,omitempty"`
	// Display name of node
	NodeDisplayName string `json:"node_display_name,omitempty"`
	// UUID of node
	NodeId string `json:"node_id,omitempty"`
}

type RemainingSupportBundleNode

type RemainingSupportBundleNode struct {
	// Display name of node
	NodeDisplayName string `json:"node_display_name,omitempty"`
	// UUID of node
	NodeId string `json:"node_id,omitempty"`
	// Status of node
	Status string `json:"status,omitempty"`
}

type SuccessNodeSupportBundleResult

type SuccessNodeSupportBundleResult struct {
	// Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz
	BundleName string `json:"bundle_name,omitempty"`
	// Size of support bundle in bytes
	BundleSize int64 `json:"bundle_size,omitempty"`
	// Display name of node
	NodeDisplayName string `json:"node_display_name,omitempty"`
	// UUID of node
	NodeId string `json:"node_id,omitempty"`
	// File's SHA256 thumbprint
	Sha256Thumbprint string `json:"sha256_thumbprint,omitempty"`
}

type SupportBundleContainerNode

type SupportBundleContainerNode struct {
	// Support bundle container type
	ContainerType string `json:"container_type"`
	// List of ContainerClusterNodes identifying container clusters and their nodes
	Clusters []ContainerClusterNode `json:"clusters,omitempty"`
}

type SupportBundleFileTransferAuthenticationScheme

type SupportBundleFileTransferAuthenticationScheme struct {
	// Password to authenticate with
	Password string `json:"password,omitempty"`
	// Authentication scheme name
	SchemeName string `json:"scheme_name"`
	// User name to authenticate with
	Username string `json:"username"`
}

type SupportBundleFileTransferProtocol

type SupportBundleFileTransferProtocol struct {
	AuthenticationScheme *SupportBundleFileTransferAuthenticationScheme `json:"authentication_scheme"`
	// Protocol name
	Name string `json:"name"`
	// SSH fingerprint of server
	SshFingerprint string `json:"ssh_fingerprint"`
}

type SupportBundleRemoteFileServer

type SupportBundleRemoteFileServer struct {
	// Remote server directory to copy bundle files to
	DirectoryPath string `json:"directory_path"`
	// Uploads to the remote file server performed by the manager
	ManagerUploadOnly bool `json:"manager_upload_only,omitempty"`
	// Server port
	Port     int64                              `json:"port,omitempty"`
	Protocol *SupportBundleFileTransferProtocol `json:"protocol"`
	// Remote server hostname or IP address
	Server string `json:"server"`
}

Remote file server

type SupportBundleRequest

type SupportBundleRequest struct {
	// List of container clusters and their nodes requiring support bundle collection
	ContainerNodes []SupportBundleContainerNode `json:"container_nodes,omitempty"`
	// Bundle should include content of specified type
	ContentFilters []string `json:"content_filters,omitempty"`
	// List of dynamic content filters that specify additional content to include in the support bundle. The list of available filters available depends on your NSX-T deployment and can be determined by invoking the GET /api/v1/adminstration/support-bundles/dynamic-content-filters NSX API. For example, if NSX Intelligence is deployed, filters for collecting specific information about services are available.
	DynamicContentFilters []string `json:"dynamic_content_filters,omitempty"`
	// Include log files with modified times not past the age limit in days
	LogAgeLimit int64 `json:"log_age_limit,omitempty"`
	// List of cluster/fabric node UUIDs processed in specified order
	Nodes            []string                       `json:"nodes,omitempty"`
	RemoteFileServer *SupportBundleRemoteFileServer `json:"remote_file_server,omitempty"`
}

type SupportBundleResult

type SupportBundleResult struct {
	// Nodes where bundles were not generated or not copied to remote server
	FailedNodes []FailedNodeSupportBundleResult `json:"failed_nodes,omitempty"`
	// Nodes where bundle generation is pending or in progress
	RemainingNodes    []RemainingSupportBundleNode `json:"remaining_nodes,omitempty"`
	RequestProperties *SupportBundleRequest        `json:"request_properties,omitempty"`
	// Nodes whose bundles were successfully copied to remote file server
	SuccessNodes []SuccessNodeSupportBundleResult `json:"success_nodes,omitempty"`
}