Documentation
¶
Index ¶
- Variables
- type AddressRange
- type AviConfigCreateSpec
- type Backing
- type CarvelVersionCreateSpec
- type Cidr
- type CloudNativeFileVolume
- type ClusterSummary
- type ConfigStatus
- type ContentLibrary
- type ContentLibraryV2
- type ControlPlane
- type ControlPlaneNetwork
- type DNS
- type DVPGNetwork
- type DefaultImageRegistry
- type DeploymentTarget
- type DirectPathIoDevice
- type DistributedSwitchCompatibilitySummary
- type Edge
- type EdgeClusterCompatibilitySummary
- type EdgeNSX
- type EdgeNetworkServices
- type EdgeServer
- type EnableClusterSpec
- type EnableOnComputeClusterSpec
- type EnableOnZonesSpec
- type HAProxy
- type HAProxyConfigCreateSpec
- type IPAssignment
- type IPConfig
- type IPManagement
- type IPRange
- type ImageStorageSpec
- type Images
- type IpAssignmentMode
- type IpRange
- type Ipv4Cidr
- type KubeAPIServerOptions
- type KubeAPIServerSecurity
- type KubernetesStatus
- type LoadBalancerConfigSpec
- type LoadBalancerProvider
- type LoadBalancersServer
- type LocalizableMessage
- type Manager
- func (c *Manager) ActivateSupervisorServiceVersion(ctx context.Context, id string, version string) error
- func (c *Manager) ActivateSupervisorServices(ctx context.Context, id string) error
- func (c *Manager) CreateNamespace(ctx context.Context, spec NamespacesInstanceCreateSpec) error
- func (c *Manager) CreateNamespaceV2(ctx context.Context, spec NamespaceInstanceCreateSpecV2) error
- func (c *Manager) CreateSupervisorService(ctx context.Context, service *SupervisorService) error
- func (c *Manager) CreateSupervisorServiceVersion(ctx context.Context, id string, service *SupervisorServiceVersion) error
- func (c *Manager) CreateSupportBundle(ctx context.Context, id string) (*SupportBundleLocation, error)
- func (c *Manager) CreateVmClass(ctx context.Context, spec VirtualMachineClassCreateSpec) error
- func (c *Manager) DeactivateSupervisorServiceVersion(ctx context.Context, id string, version string) error
- func (c *Manager) DeactivateSupervisorServices(ctx context.Context, id string) error
- func (c *Manager) DeleteNamespace(ctx context.Context, namespace string) error
- func (c *Manager) DeleteVmClass(ctx context.Context, vmClass string) error
- func (c *Manager) DisableCluster(ctx context.Context, id string) error
- func (c *Manager) EnableCluster(ctx context.Context, id string, spec *EnableClusterSpec) error
- func (c *Manager) EnableOnComputeCluster(ctx context.Context, id string, spec *EnableOnComputeClusterSpec) (string, error)
- func (c *Manager) EnableOnZones(ctx context.Context, spec *EnableOnZonesSpec) (string, error)
- func (c *Manager) GetNamespace(ctx context.Context, namespace string) (NamespacesInstanceInfo, error)
- func (c *Manager) GetNamespaceV2(ctx context.Context, namespace string) (NamespaceInstanceInfoV2, error)
- func (c *Manager) GetSupervisorService(ctx context.Context, id string) (SupervisorServiceInfo, error)
- func (c *Manager) GetSupervisorServiceVersion(ctx context.Context, id string, version string) (SupervisorServiceVersionInfo, error)
- func (c *Manager) GetSupervisorSummaries(ctx context.Context) (SupervisorsSummaryResult, error)
- func (c *Manager) GetSupervisorSummary(ctx context.Context, id string) (SupervisorSummaryInfo, error)
- func (c *Manager) GetSupervisorTopology(ctx context.Context, id string) ([]SupervisorTopologyInfo, error)
- func (c *Manager) GetVmClass(ctx context.Context, vmClass string) (VirtualMachineClassInfo, error)
- func (c *Manager) ListClusters(ctx context.Context) ([]ClusterSummary, error)
- func (c *Manager) ListCompatibleDistributedSwitches(ctx context.Context, clusterId string) (result []DistributedSwitchCompatibilitySummary, err error)
- func (c *Manager) ListCompatibleEdgeClusters(ctx context.Context, clusterId string, switchId string) (result []EdgeClusterCompatibilitySummary, err error)
- func (c *Manager) ListNamespaces(ctx context.Context) ([]NamespacesInstanceSummary, error)
- func (c *Manager) ListNamespacesV2(ctx context.Context) ([]NamespaceInstanceSummaryV2, error)
- func (c *Manager) ListSupervisorServiceVersions(ctx context.Context, id string) ([]SupervisorServiceVersionSummary, error)
- func (c *Manager) ListSupervisorServices(ctx context.Context) ([]SupervisorServiceSummary, error)
- func (c *Manager) ListVmClasses(ctx context.Context) ([]VirtualMachineClassInfo, error)
- func (c *Manager) RegisterVM(ctx context.Context, namespace string, spec RegisterVMSpec) (string, error)
- func (c *Manager) RemoveSupervisorService(ctx context.Context, id string) error
- func (c *Manager) RemoveSupervisorServiceVersion(ctx context.Context, id string, version string) error
- func (c *Manager) SupportBundleRequest(ctx context.Context, bundle *SupportBundleLocation) (*http.Request, error)
- func (c *Manager) UpdateNamespace(ctx context.Context, namespace string, spec NamespacesInstanceUpdateSpec) error
- func (c *Manager) UpdateVmClass(ctx context.Context, vmClass string, spec VirtualMachineClassUpdateSpec) error
- type MasterManagementNetwork
- type NSXAdvancedLBConfig
- type NTP
- type NamespaceInstanceCreateSpecV2
- type NamespaceInstanceInfoV2
- type NamespaceInstanceSummaryV2
- type NamespacesInstanceCreateSpec
- type NamespacesInstanceInfo
- type NamespacesInstanceStats
- type NamespacesInstanceSummary
- type NamespacesInstanceUpdateSpec
- type NcpClusterNetworkSpec
- type NetworkInterface
- type NetworkInterfaceNetwork
- type NetworkNSX
- type NetworkProvider
- type NetworkSegment
- type NetworkVPC
- type NetworkVSphere
- type NetworksCreateSpec
- type NsxNetwork
- type Proxy
- type RegisterVMSpec
- type Registry
- type Services
- type SizingHint
- type Stats
- type StorageSpec
- type SupervisorService
- type SupervisorServiceInfo
- type SupervisorServiceSummary
- type SupervisorServiceVersion
- type SupervisorServiceVersionInfo
- type SupervisorServiceVersionSummary
- type SupervisorServicesCarvelSpec
- type SupervisorServicesVSphereSpec
- type SupervisorServicesVSphereVersionCreateSpec
- type SupervisorSummaryInfo
- type SupervisorSummaryInfoStats
- type SupervisorTopologyInfo
- type SupervisorsSummaryResult
- type SupervisorsSummaryResultItem
- type SupportBundleLocation
- type SupportBundleToken
- type Syslog
- type VSphereFoundationConfig
- type VgpuDevice
- type VirtualDevices
- type VirtualMachineClassCreateSpec
- type VirtualMachineClassInfo
- type VirtualMachineClassUpdateSpec
- type VmServiceSpec
- type VsphereDVPGNetworkCreateSpec
- type WorkloadNetwork
- type WorkloadNetworksEnableSpec
- type Workloads
- type WorkloadsStorageConfig
Constants ¶
This section is empty.
Variables ¶
var ( UndefinedSizingHint = SizingHint{""} TinySizingHint = SizingHint{"TINY"} SmallSizingHint = SizingHint{"SMALL"} MediumSizingHint = SizingHint{"MEDIUM"} LargeSizingHint = SizingHint{"LARGE"} )
var ( UndefinedIpAssignmentMode = IpAssignmentMode{""} DhcpIpAssignmentMode = IpAssignmentMode{"DHCP"} StaticRangeIpAssignmentMode = IpAssignmentMode{"STATICRANGE"} )
var ( UndefinedNetworkProvider = NetworkProvider{""} NsxtContainerPluginNetworkProvider = NetworkProvider{"NSXT_CONTAINER_PLUGIN"} // Since 7.0u1:- VSphereNetworkProvider = NetworkProvider{"VSPHERE_NETWORK"} )
var ( UndefinedLoadBalancerProvider = LoadBalancerProvider{""} // Deprecated: HA Proxy is being deprecated in vSphere 9.0. Use // Avi vSphere networking, or NSX-T networking, instead. HAProxyLoadBalancerProvider = LoadBalancerProvider{"HA_PROXY"} AviLoadBalancerProvider = LoadBalancerProvider{"AVI"} )
var ( UndefinedKubernetesStatus = KubernetesStatus{""} ReadyKubernetesStatus = KubernetesStatus{"READY"} WarningKubernetesStatus = KubernetesStatus{"WARNING"} ErrorKubernetesStatus = KubernetesStatus{"ERROR"} )
var ( UndefinedConfigStatus = ConfigStatus{""} ConfiguringConfigStatus = ConfigStatus{"CONFIGURING"} RemovingConfigStatus = ConfigStatus{"REMOVING"} RunningConfigStatus = ConfigStatus{"RUNNING"} ErrorConfigStatus = ConfigStatus{"ERROR"} )
Functions ¶
This section is empty.
Types ¶
type AddressRange ¶
type AddressRange struct {
SubnetMask string `json:"subnet_mask,omitempty"`
StartingAddress string `json:"starting_address"`
Gateway string `json:"gateway"`
AddressCount int `json:"address_count,omitempty"`
}
Since 7.0.0:-
type AviConfigCreateSpec ¶ added in v0.30.0
type AviConfigCreateSpec struct {
CertificateAuthorityChain string `json:"certificate_authority_chain"`
Password string `json:"password"`
Server *LoadBalancersServer `json:"server"`
Username string `json:"username"`
}
AviConfigCreateSpec defines full information for the linking of a Tanzu Kubernetes Grid enabled vSphere cluster to an NSX Advanced Load Balancer (formerly Avi Load Balancer) See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/LoadBalancers/AviConfigCreateSpec/ Since 7.0u2:-
type Backing ¶ added in v0.53.0
type Backing struct {
Backing string `json:"backing"`
Network *string `json:"network,omitempty"`
NetworkSegment *NetworkSegment `json:"network_segment,omitempty"`
}
Backing https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Management%20NetworkBacking Since 8.0.0.1
type CarvelVersionCreateSpec ¶ added in v0.48.0
type CarvelVersionCreateSpec struct {
// Inline content that contains all service definition of the version in Carvel application package format, which shall be base64 encoded.
Content string `json:"content"`
}
The “CarvelVersionCreateSpec“ class provides a specification required to create a Supervisor Service version from Carvel application package format (Package and PackageMetadata resources should be declared).
type Cidr ¶
Cidr defines an IPv4 CIDR range for a subnet. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/Namespaces/Instances/Ipv4Cidr/ TODO decide whether to rename this in the Go API to match the vSphere API. Since 7.0.0:-
type CloudNativeFileVolume ¶ added in v0.53.0
type CloudNativeFileVolume struct {
VSANClusters []string `json:"vsan_clusters"`
}
type ClusterSummary ¶
type ClusterSummary struct {
ID string `json:"cluster"`
Name string `json:"cluster_name"`
// Was string until #2860:-
KubernetesStatus *KubernetesStatus `json:"kubernetes_status"`
// Was string until #2860:-
ConfigStatus *ConfigStatus `json:"config_status"`
}
ClusterSummary for a cluster with vSphere Namespaces enabled. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/Summary/ TODO plural vs singular - consistency with REST API above vs Go Since 7.0.0:-
func (*ClusterSummary) Reference ¶
func (c *ClusterSummary) Reference() types.ManagedObjectReference
TODO whether to replace the below with a Go GUID (json to string) reference type? (I.e. replace ClusterSummary.ID string with ID ManagedObjectID) Reference implements the mo.Reference interface
type ConfigStatus ¶ added in v0.30.0
type ConfigStatus struct {
// contains filtered or unexported fields
}
func ConfigStatusFromString ¶ added in v0.30.0
func ConfigStatusFromString(s string) ConfigStatus
func (*ConfigStatus) FromString ¶ added in v0.30.0
func (v *ConfigStatus) FromString(s string)
func (ConfigStatus) MarshalJSON ¶ added in v0.30.0
func (v ConfigStatus) MarshalJSON() ([]byte, error)
func (ConfigStatus) String ¶ added in v0.30.0
func (v ConfigStatus) String() string
func (*ConfigStatus) UnmarshalJSON ¶ added in v0.30.0
func (v *ConfigStatus) UnmarshalJSON(b []byte) error
type ContentLibrary ¶ added in v0.53.0
type ContentLibrary struct {
ContentLibrary string `json:"content_library"`
SupervisorServices *[]string `json:"supervisor_services,omitempty"`
ResourceNamingStrategy *string `json:"resource_naming_strategy,omitempty"`
}
ContentLibrary https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Clusters%20ContentLibrarySpec Since 8.0.2.0
type ContentLibraryV2 ¶ added in v0.53.0
type ControlPlane ¶ added in v0.53.0
type ControlPlane struct {
Network ControlPlaneNetwork `json:"network"`
LoginBanner *string `json:"login_banner,omitempty"`
Size *string `json:"size,omitempty"`
StoragePolicy *string `json:"storage_policy,omitempty"`
Count *int `json:"count,omitempty"`
}
ControlPlane https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20ControlPlane Since 8.0.0.1
type ControlPlaneNetwork ¶ added in v0.53.0
type ControlPlaneNetwork struct {
Network *string `json:"network,omitempty"`
Backing Backing `json:"backing"`
Services *Services `json:"services,omitempty"`
IPManagement *IPManagement `json:"ip_management,omitempty"`
FloatingIPAddress *string `json:"floating_ip_address,omitempty"`
Proxy *Proxy `json:"proxy,omitempty"`
}
ControlPlaneNetwork https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Management%20Network Since 8.0.0.1
type DNS ¶ added in v0.53.0
type DNS struct {
Servers []string `json:"servers"`
SearchDomains []string `json:"search_domains"`
}
DNS https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Service%20DNS Since 8.0.0.1
type DVPGNetwork ¶ added in v0.53.0
type DVPGNetwork struct {
Name string `json:"name"`
Network string `json:"network"`
IPAM string `json:"ipam"`
IPConfig *IPConfig `json:"ip_config,omitempty"`
}
DVPGNetwork https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20DistributedPortGroupNetwork Since 9.0.0.0
type DefaultImageRegistry ¶
type DefaultImageRegistry struct {
Hostname string `json:"hostname"`
Port int `json:"port,omitempty"`
}
Since 7.0.0:-
type DeploymentTarget ¶ added in v0.53.0
type DeploymentTarget struct {
Zones *[]string `json:"zones,omitempty"`
StoragePolicy *string `json:"storage_policy,omitempty"`
DeploymentSize *string `json:"deployment_size,omitempty"`
Availability *string `json:"availability,omitempty"`
}
DeploymentTarget https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20DeploymentTarget Since 8.0.0.1
type DirectPathIoDevice ¶ added in v0.37.0
type DirectPathIoDevice struct {
CustomLabel string `json:"custom_label,omitempty"`
DeviceId int64 `json:"device_id"`
VendorId int64 `json:"vendor_id"`
}
DirectPathIoDevice https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/NamespaceManagement/VirtualMachineClasses/DynamicDirectPathIODevice/
type DistributedSwitchCompatibilitySummary ¶
type DistributedSwitchCompatibilitySummary struct {
Compatible bool `json:"compatible"`
DistributedSwitch string `json:"distributed_switch"`
}
Since 7.0.0:-
type Edge ¶ added in v0.53.0
type Edge struct {
ID *string `json:"id,omitempty"`
LoadBalancerAddressRanges *[]IPRange `json:"load_balancer_address_ranges,omitempty"`
HAProxy *HAProxy `json:"haproxy,omitempty"`
NSX *EdgeNSX `json:"nsx,omitempty"`
NSXAdvanced *NSXAdvancedLBConfig `json:"nsx_advanced,omitempty"`
Foundation *VSphereFoundationConfig `json:"foundation,omitempty"`
Provider *string `json:"provider,omitempty"`
}
Edge https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Edge Since 8.0.0.1
type EdgeClusterCompatibilitySummary ¶
type EdgeClusterCompatibilitySummary struct {
Compatible bool `json:"compatible"`
EdgeCluster string `json:"edge_cluster"`
DisplayName string `json:"display_name"`
}
Since 7.0.0:-
type EdgeNSX ¶ added in v0.53.0
type EdgeNSX struct {
EdgeClusterID *string `json:"edge_cluster_id,omitempty"`
DefaultIngressTLSCertificate *string `json:"default_ingress_tls_certificate,omitempty"`
RoutingMode *string `json:"routing_mode,omitempty"`
EgressIPRanges *[]IPRange `json:"egress_ip_ranges,omitempty"`
T0Gateway *string `json:"t0_gateway,omitempty"`
LoadBalancerSize *string `json:"load_balancer_size,omitempty"`
}
EdgeNSX https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20NSXConfig Since 8.0.0.1
type EdgeNetworkServices ¶ added in v0.53.0
type EdgeNetworkServices struct {
DNS *DNS `json:"dns,omitempty"`
NTP *NTP `json:"ntp,omitempty"`
Syslog *Syslog `json:"syslog,omitempty"`
}
EdgeNetworkServices https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20NetworkServices Since 8.0.0.1
type EdgeServer ¶ added in v0.53.0
EdgeServer https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Server Since 8.0.0.1
type EnableClusterSpec ¶
type EnableClusterSpec struct {
MasterDNSSearchDomains []string `json:"master_DNS_search_domains,omitempty"`
ImageStorage ImageStorageSpec `json:"image_storage"`
NcpClusterNetworkSpec *NcpClusterNetworkSpec `json:"ncp_cluster_network_spec,omitempty"`
// Note: NcpClusterNetworkSpec is replaced by WorkloadNetworksSpec in vSphere 7.0u2+
// Since 7.0u1:-
WorkloadNetworksSpec *WorkloadNetworksEnableSpec `json:"workload_networks_spec,omitempty"`
MasterManagementNetwork *MasterManagementNetwork `json:"master_management_network"`
MasterDNSNames []string `json:"Master_DNS_names,omitempty"`
MasterNTPServers []string `json:"master_NTP_servers,omitempty"`
EphemeralStoragePolicy string `json:"ephemeral_storage_policy,omitempty"`
DefaultImageRepository string `json:"default_image_repository,omitempty"`
ServiceCidr *Cidr `json:"service_cidr"`
LoginBanner string `json:"login_banner,omitempty"`
// Was string until #2860:-
SizeHint *SizingHint `json:"size_hint"`
WorkerDNS []string `json:"worker_DNS,omitempty"`
DefaultImageRegistry *DefaultImageRegistry `json:"default_image_registry,omitempty"`
MasterDNS []string `json:"master_DNS,omitempty"`
// Was string until #2860:-
NetworkProvider *NetworkProvider `json:"network_provider"`
MasterStoragePolicy string `json:"master_storage_policy,omitempty"`
DefaultKubernetesServiceContentLibrary string `json:"default_kubernetes_service_content_library,omitempty"`
WorkloadNTPServers []string `json:"workload_ntp_servers,omitempty"`
LoadBalancerConfigSpec *LoadBalancerConfigSpec `json:"load_balancer_config_spec,omitempty"`
}
EnableClusterSpec defines a Tanzu Supervisor Cluster for creation. See: https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/EnableSpec/ Since 7.0.0:-
type EnableOnComputeClusterSpec ¶ added in v0.53.0
type EnableOnComputeClusterSpec struct {
Zone *string `json:"zone,omitempty"`
Name string `json:"name"`
ControlPlane ControlPlane `json:"control_plane"`
Workloads Workloads `json:"workloads"`
}
EnableOnComputeClusterSpec a specification for enabling Supervisor on a single vSphere Zone https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20EnableOnComputeClusterSpec Since 8.0.0.1
type EnableOnZonesSpec ¶ added in v0.53.0
type EnableOnZonesSpec struct {
Zones []string `json:"zones"`
Name string `json:"name"`
ControlPlane ControlPlane `json:"control_plane"`
Workloads Workloads `json:"workloads"`
}
EnableOnZonesSpec a specification for enabling Supervisor on multiple vSphere Zones https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20EnableOnZonesSpec/ Since 8.0.0.1
type HAProxy ¶ added in v0.53.0
type HAProxy struct {
Servers []EdgeServer `json:"servers"`
Username string `json:"username"`
Password string `json:"password"`
CertificateAuthorityChain string `json:"certificate_authority_chain"`
}
HAProxy https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20HAProxyConfig Since 8.0.0.1
type HAProxyConfigCreateSpec ¶ added in v0.30.0
type HAProxyConfigCreateSpec struct {
CertificateAuthorityChain string `json:"certificate_authority_chain"`
Password string `json:"password"`
Servers []LoadBalancersServer `json:"servers"`
Username string `json:"username"`
}
HAProxyConfigCreateSpec defines full information for the linking of a Tanzu Kubernetes Grid enabled vSphere cluster to a HA Proxy Load Balancer. Note: HA Proxy is not supported in vSphere 7.0u3 and above. Use Avi
with vSphere networking, or NSX-T networking, instead.
See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/LoadBalancers/HAProxyConfigCreateSpec/ Since 7.0u1:- Deprecated: HA Proxy is being deprecated in vSphere 9.0. Use Avi with vSphere networking, or NSX-T networking, instead.
type IPAssignment ¶ added in v0.53.0
type IPAssignment struct {
Assignee *string `json:"assignee,omitempty"`
Ranges []IPRange `json:"ranges"`
}
IPAssignment https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20IPAssignment Since 8.0.0.1
type IPConfig ¶ added in v0.53.0
IPConfig https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20IPConfig Since 9.0.0.0
type IPManagement ¶ added in v0.53.0
type IPManagement struct {
DHCPEnabled *bool `json:"dhcp_enabled,omitempty"`
GatewayAddress *string `json:"gateway_address,omitempty"`
IPAssignments *[]IPAssignment `json:"ip_assignments,omitempty"`
}
IPManagement https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20IPManagement Since 8.0.0.1
type IPRange ¶ added in v0.53.0
IPRange https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20IPRange Since 8.0.0.1
type ImageStorageSpec ¶ added in v0.30.0
type ImageStorageSpec struct {
StoragePolicy string `json:"storage_policy"`
}
ImageStorageSpec defines the storage policy ID (not name) assigned to a Tanzu Kubernetes Grid cluster (supervisor or workload clusters) See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/ImageStorageSpec/ Since 7.0.0:-
type Images ¶ added in v0.53.0
type Images struct {
Registry Registry `json:"registry"`
Repository string `json:"repository"`
KubernetesContentLibrary string `json:"kubernetes_content_library"`
ContentLibraries []ContentLibrary `json:"content_libraries"`
}
type IpAssignmentMode ¶ added in v0.30.0
type IpAssignmentMode struct {
// contains filtered or unexported fields
}
IpAssignmentMode specifies whether DHCP or a static range assignment method is used. This is used for both Supervisor Cluster and Workload Cluster networks in 7.0u3 and above. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Networks/IPAssignmentMode/ TODO decide whether to rename this in the Go API to match the vSphere API. Since 7.0u3:-
func IpAssignmentModeFromString ¶ added in v0.30.0
func IpAssignmentModeFromString(s string) IpAssignmentMode
func (*IpAssignmentMode) FromString ¶ added in v0.30.0
func (v *IpAssignmentMode) FromString(s string)
func (IpAssignmentMode) MarshalJSON ¶ added in v0.30.0
func (v IpAssignmentMode) MarshalJSON() ([]byte, error)
func (IpAssignmentMode) String ¶ added in v0.30.0
func (v IpAssignmentMode) String() string
func (*IpAssignmentMode) UnmarshalJSON ¶ added in v0.30.0
func (v *IpAssignmentMode) UnmarshalJSON(b []byte) error
type IpRange ¶ added in v0.30.0
type IpRange struct {
Address string `json:"address,omitempty"`
Count int `json:"count,omitempty"`
}
IpRange specifies a contiguous set of IPv4 Addresses See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/IPRange/ TODO decide whether to rename this in the Go API to match the vSphere API. Note: omitempty allows AddressRanges: []IpRange to become json [] Since 7.0u1:-
type Ipv4Cidr ¶ added in v0.53.0
Ipv4Cidr https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Ipv4Cidr Since 8.0.0.1
type KubeAPIServerOptions ¶ added in v0.53.0
type KubeAPIServerOptions struct {
Security *KubeAPIServerSecurity `json:"security,omitempty"`
}
KubeAPIServerOptions https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20KubeAPIServerOptions Since 8.0.0.1
type KubeAPIServerSecurity ¶ added in v0.53.0
type KubeAPIServerSecurity struct {
CertificateDNSNames []string `json:"certificate_dns_names"`
}
KubeAPIServerSecurity https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20KubeAPIServerSecurity Since 8.0.0.1
type KubernetesStatus ¶ added in v0.30.0
type KubernetesStatus struct {
// contains filtered or unexported fields
}
func KubernetesStatusFromString ¶ added in v0.30.0
func KubernetesStatusFromString(s string) KubernetesStatus
func (*KubernetesStatus) FromString ¶ added in v0.30.0
func (v *KubernetesStatus) FromString(s string)
func (KubernetesStatus) MarshalJSON ¶ added in v0.30.0
func (v KubernetesStatus) MarshalJSON() ([]byte, error)
func (KubernetesStatus) String ¶ added in v0.30.0
func (v KubernetesStatus) String() string
func (*KubernetesStatus) UnmarshalJSON ¶ added in v0.30.0
func (v *KubernetesStatus) UnmarshalJSON(b []byte) error
type LoadBalancerConfigSpec ¶ added in v0.30.0
type LoadBalancerConfigSpec struct {
// AddressRanges removed since 7.0u2:- (Now in workload network spec)
AddressRanges []IpRange `json:"address_ranges,omitempty"` // omitempty to prevent null being the value
HAProxyConfigCreateSpec *HAProxyConfigCreateSpec `json:"ha_proxy_config_create_spec,omitempty"`
// Optional for create:-
Id string `json:"id"`
Provider *LoadBalancerProvider `json:"provider"`
// Since 7.0u2:-
AviConfigCreateSpec *AviConfigCreateSpec `json:"avi_config_create_spec,omitempty"`
}
LoadBalancerConfigSpec defines LoadBalancer options for Tanzu Kubernetes Grid, both for the Supervisor Cluster and for Workload Cluster kubeapi endpoints, and services of type LoadBalancer See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/LoadBalancers/ConfigSpec/ Since 7.0u1:-
type LoadBalancerProvider ¶ added in v0.30.0
type LoadBalancerProvider struct {
// contains filtered or unexported fields
}
A LoadBalancerProvider is an enum type that defines the Load Balancer technology in use in a Tanzu Kubernetes Grid cluster. Note: If invalid or undefined (E.g. if a newer/older vSphere
version is used whose option isn't listed) then the UndefinedLoadBalancerProvider value shall be set. This translates to an empty string, removing its element from the produces JSON.
func LoadBalancerFromString ¶ added in v0.30.0
func LoadBalancerFromString(s string) LoadBalancerProvider
func (*LoadBalancerProvider) FromString ¶ added in v0.30.0
func (v *LoadBalancerProvider) FromString(s string)
func (LoadBalancerProvider) MarshalJSON ¶ added in v0.30.0
func (v LoadBalancerProvider) MarshalJSON() ([]byte, error)
func (LoadBalancerProvider) String ¶ added in v0.30.0
func (v LoadBalancerProvider) String() string
func (*LoadBalancerProvider) UnmarshalJSON ¶ added in v0.30.0
func (v *LoadBalancerProvider) UnmarshalJSON(b []byte) error
type LoadBalancersServer ¶ added in v0.30.0
LoadBalancersServer defines an Avi or HA Proxy load balancer location. Host can be an IP Address (normally an Avi Management Virtual IP for the Avi Controller(s)) or a hostname. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/LoadBalancers/Server/ Since 7.0u1:-
type LocalizableMessage ¶ added in v0.37.0
type Manager ¶
Manager extends rest.Client, adding namespace related methods.
func NewManager ¶
NewManager creates a new Manager instance with the given client.
func (*Manager) ActivateSupervisorServiceVersion ¶ added in v0.48.0
func (c *Manager) ActivateSupervisorServiceVersion(ctx context.Context, id string, version string) error
ActivateSupervisorServiceVersion activates a version of an existing Supervisor Service. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/versionactiondeactivate/patch/
func (*Manager) ActivateSupervisorServices ¶ added in v0.28.0
ActivateSupervisorServices activates a previously registered Supervisor Service.
func (*Manager) CreateNamespace ¶ added in v0.37.0
func (c *Manager) CreateNamespace(ctx context.Context, spec NamespacesInstanceCreateSpec) error
CreateNamespace https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/api/vcenter/namespaces/instances/post/
func (*Manager) CreateNamespaceV2 ¶ added in v0.53.0
func (c *Manager) CreateNamespaceV2(ctx context.Context, spec NamespaceInstanceCreateSpecV2) error
CreateNamespaceV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/api/vcenter/namespaces/instances/v2/post/
func (*Manager) CreateSupervisorService ¶ added in v0.28.0
func (c *Manager) CreateSupervisorService(ctx context.Context, service *SupervisorService) error
CreateSupervisorService creates a new Supervisor Service on vCenter.
func (*Manager) CreateSupervisorServiceVersion ¶ added in v0.48.0
func (c *Manager) CreateSupervisorServiceVersion(ctx context.Context, id string, service *SupervisorServiceVersion) error
CreateSupervisorServiceVersion creates a new version for an existing Supervisor Service. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/post/
func (*Manager) CreateSupportBundle ¶
func (c *Manager) CreateSupportBundle(ctx context.Context, id string) (*SupportBundleLocation, error)
CreateSupportBundle retrieves the cluster's Namespaces-related support bundle.
func (*Manager) CreateVmClass ¶ added in v0.37.0
func (c *Manager) CreateVmClass(ctx context.Context, spec VirtualMachineClassCreateSpec) error
func (*Manager) DeactivateSupervisorServiceVersion ¶ added in v0.48.0
func (c *Manager) DeactivateSupervisorServiceVersion(ctx context.Context, id string, version string) error
DeactivateSupervisorServiceVersion deactivates a version of an existing Supervisor Service. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/versionactiondeactivate/patch/
func (*Manager) DeactivateSupervisorServices ¶ added in v0.28.0
DeactivateSupervisorServices deactivates a previously registered Supervisor Service.
func (*Manager) DeleteNamespace ¶ added in v0.37.0
DeleteNamespace https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/api/vcenter/namespaces/instances/namespace/delete/
func (*Manager) DeleteVmClass ¶ added in v0.37.0
func (*Manager) DisableCluster ¶
EnableCluster enables vSphere Namespaces on the specified cluster, using the given spec.
func (*Manager) EnableCluster ¶
EnableCluster enables vSphere Namespaces on the specified cluster, using the given spec. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/api/vcenter/namespace-management/clusters/clusteractionenable/post/
func (*Manager) EnableOnComputeCluster ¶ added in v0.53.0
func (c *Manager) EnableOnComputeCluster(ctx context.Context, id string, spec *EnableOnComputeClusterSpec) (string, error)
EnableOnComputeCluster enables a Supervisor on a single vSphere cluster https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/vcenter/namespace-management/supervisors/cluster__action=enable_on_compute_cluster/post
func (*Manager) EnableOnZones ¶ added in v0.53.0
EnableOnZones enables a Supervisor on a set of vSphere Zones https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/vcenter/namespace-management/supervisors__action=enable_on_zones/post
func (*Manager) GetNamespace ¶ added in v0.37.0
func (c *Manager) GetNamespace(ctx context.Context, namespace string) (NamespacesInstanceInfo, error)
GetNamespace https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/api/vcenter/namespaces/instances/namespace/get/
func (*Manager) GetNamespaceV2 ¶ added in v0.53.0
func (c *Manager) GetNamespaceV2(ctx context.Context, namespace string) (NamespaceInstanceInfoV2, error)
GetNamespaceV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/api/vcenter/namespaces/instances/v2/namespace/get/
func (*Manager) GetSupervisorService ¶ added in v0.28.0
func (c *Manager) GetSupervisorService(ctx context.Context, id string) (SupervisorServiceInfo, error)
GetSupervisorService gets the information of a specific Supervisor Service.
func (*Manager) GetSupervisorServiceVersion ¶ added in v0.48.0
func (c *Manager) GetSupervisorServiceVersion(ctx context.Context, id string, version string) (SupervisorServiceVersionInfo, error)
GetSupervisorServiceVersion gets the information of a specific Supervisor Service version. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/version/get/
func (*Manager) GetSupervisorSummaries ¶ added in v0.53.0
func (c *Manager) GetSupervisorSummaries(ctx context.Context) (SupervisorsSummaryResult, error)
GetSupervisorSummaries retrieves the list of Supervisor summaries https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/vcenter/namespace-management/supervisors/summaries/get/
func (*Manager) GetSupervisorSummary ¶ added in v0.53.0
func (c *Manager) GetSupervisorSummary(ctx context.Context, id string) (SupervisorSummaryInfo, error)
GetSupervisorSummary retrieves the summary of the specified Supervisor https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/vcenter/namespace-management/supervisors/supervisor/summary/get/
func (*Manager) GetSupervisorTopology ¶ added in v0.53.0
func (c *Manager) GetSupervisorTopology(ctx context.Context, id string) ([]SupervisorTopologyInfo, error)
GetSupervisorTopology retrieves the topology of the specified Supervisor https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/vcenter/namespace-management/supervisors/supervisor/topology/get/
func (*Manager) GetVmClass ¶ added in v0.37.0
func (*Manager) ListClusters ¶
func (c *Manager) ListClusters(ctx context.Context) ([]ClusterSummary, error)
ListClusters returns a summary of all clusters with vSphere Namespaces enabled.
func (*Manager) ListCompatibleDistributedSwitches ¶
func (*Manager) ListCompatibleEdgeClusters ¶
func (*Manager) ListNamespaces ¶ added in v0.37.0
func (c *Manager) ListNamespaces(ctx context.Context) ([]NamespacesInstanceSummary, error)
ListNamespaces https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/api/vcenter/namespaces/instances/get/
func (*Manager) ListNamespacesV2 ¶ added in v0.53.0
func (c *Manager) ListNamespacesV2(ctx context.Context) ([]NamespaceInstanceSummaryV2, error)
ListNamespacesV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/api/vcenter/namespaces/instances/v2/get/
func (*Manager) ListSupervisorServiceVersions ¶ added in v0.48.0
func (c *Manager) ListSupervisorServiceVersions(ctx context.Context, id string) ([]SupervisorServiceVersionSummary, error)
ListSupervisorServiceVersions lists all versions of the given Supervisor Service. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/get/
func (*Manager) ListSupervisorServices ¶ added in v0.28.0
func (c *Manager) ListSupervisorServices(ctx context.Context) ([]SupervisorServiceSummary, error)
ListSupervisorServices returns a summary of registered Supervisor Services.
func (*Manager) ListVmClasses ¶ added in v0.37.0
func (c *Manager) ListVmClasses(ctx context.Context) ([]VirtualMachineClassInfo, error)
func (*Manager) RegisterVM ¶ added in v0.43.0
func (*Manager) RemoveSupervisorService ¶ added in v0.28.0
RemoveSupervisorService removes a previously deactivated Supervisor Service.
func (*Manager) RemoveSupervisorServiceVersion ¶ added in v0.48.0
func (c *Manager) RemoveSupervisorServiceVersion(ctx context.Context, id string, version string) error
RemoveSupervisorServiceVersion removes a previously deactivated Supervisor Service version. https://developer.broadcom.com/xapis/vsphere-automation-api/8.0.3/vcenter/api/vcenter/namespace-management/supervisor-services/supervisor_service/versions/version/delete/
func (*Manager) SupportBundleRequest ¶
func (c *Manager) SupportBundleRequest(ctx context.Context, bundle *SupportBundleLocation) (*http.Request, error)
SupportBundleRequest returns an http.Request which can be used to download the given support bundle.
func (*Manager) UpdateNamespace ¶ added in v0.37.0
func (c *Manager) UpdateNamespace(ctx context.Context, namespace string, spec NamespacesInstanceUpdateSpec) error
UpdateNamespace https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/api/vcenter/namespaces/instances/namespace/patch/
func (*Manager) UpdateVmClass ¶ added in v0.37.0
type MasterManagementNetwork ¶
type MasterManagementNetwork struct {
Mode *IpAssignmentMode `json:"mode"`
FloatingIP string `json:"floating_IP,omitempty"`
AddressRange *AddressRange `json:"address_range,omitempty"`
Network string `json:"network"`
}
Since 7.0.0:-
type NSXAdvancedLBConfig ¶ added in v0.53.0
type NSXAdvancedLBConfig struct {
Server EdgeServer `json:"server"`
Username string `json:"username"`
Password string `json:"password"`
CertificateAuthorityChain string `json:"certificate_authority_chain"`
CloudName *string `json:"cloud_name,omitempty"`
}
NSXAdvancedLBConfig https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20NSXAdvancedLBConfig Since 8.0.0.1
type NTP ¶ added in v0.53.0
type NTP struct {
Servers []string `json:"servers"`
}
NTP https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Service%20NTP Since 8.0.0.1
type NamespaceInstanceCreateSpecV2 ¶ added in v0.53.0
type NamespaceInstanceCreateSpecV2 struct {
Namespace string `json:"namespace"`
Supervisor string `json:"supervisor"`
Description *string `json:"description,omitempty"`
StorageSpecs *[]StorageSpec `json:"storage_specs,omitempty"`
VmServiceSpec *VmServiceSpec `json:"vm_service_spec,omitempty"`
ContentLibraries *[]ContentLibraryV2 `json:"content_libraries,omitempty"`
SelfServiceNamespace *bool `json:"self_service_namespace,omitempty"`
}
NamespaceInstanceCreateSpecV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/data-structures/Vcenter%20Namespaces%20Instances%20CreateSpecV2 Since 8.0.0.1
type NamespaceInstanceInfoV2 ¶ added in v0.53.0
type NamespaceInstanceInfoV2 struct {
Supervisor string `json:"supervisor"`
ConfigStatus string `json:"config_status"`
Stats Stats `json:"stats"`
Description string `json:"description"`
StorageSpecs []StorageSpec `json:"storage_specs"`
VmServiceSpec VmServiceSpec `json:"vm_service_spec"`
ContentLibraries []ContentLibraryV2 `json:"content_libraries"`
SelfServiceNamespace bool `json:"self_service_namespace"`
}
NamespaceInstanceInfoV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/data-structures/Vcenter%20Namespaces%20Instances%20InfoV2 Since 8.0.0.1
type NamespaceInstanceSummaryV2 ¶ added in v0.53.0
type NamespaceInstanceSummaryV2 struct {
Supervisor string `json:"supervisor"`
Namespace string `json:"namespace"`
Description string `json:"description"`
ConfigStatus string `json:"config_status"`
Stats Stats `json:"stats"`
SelfServiceNamespace bool `json:"self_service_namespace"`
}
NamespaceInstanceSummaryV2 https://developer.broadcom.com/xapis/vsphere-automation-api/9.0/data-structures/Vcenter%20Namespaces%20Instances%20SummaryV2 Since 8.0.0.1
type NamespacesInstanceCreateSpec ¶ added in v0.37.0
type NamespacesInstanceCreateSpec struct {
Cluster string `json:"cluster"`
Namespace string `json:"namespace"`
VmServiceSpec VmServiceSpec `json:"vm_service_spec,omitempty"`
StorageSpecs []StorageSpec `json:"storage_specs,omitempty"`
}
NamespacesInstanceCreateSpec https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/CreateSpec/
type NamespacesInstanceInfo ¶ added in v0.37.0
type NamespacesInstanceInfo struct {
ClusterId string `json:"cluster"`
ConfigStatus string `json:"config_status"`
Description string `json:"description"`
Stats NamespacesInstanceStats `json:"stats"`
SelfServiceNamespace bool `json:"self_service_namespace,omitempty"`
Messages []LocalizableMessage `json:"message"`
VmServiceSpec VmServiceSpec `json:"vm_service_spec,omitempty"`
StorageSpecs []StorageSpec `json:"storage_specs,omitempty"`
}
NamespacesInstanceInfo https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/Info/
type NamespacesInstanceStats ¶ added in v0.37.0
type NamespacesInstanceStats struct {
CpuUsed int64 `json:"cpu_used"`
MemoryUsed int64 `json:"memory_used"`
StorageUsed int64 `json:"storage_used"`
}
NamespacesInstanceStats https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/Stats/
type NamespacesInstanceSummary ¶ added in v0.37.0
type NamespacesInstanceSummary struct {
ClusterId string `json:"cluster"`
Namespace string `json:"namespace"`
ConfigStatus string `json:"config_status"`
Description string `json:"description"`
Stats NamespacesInstanceStats `json:"stats"`
SelfServiceNamespace bool `json:"self_service_namespace,omitempty"`
}
NamespacesInstanceSummary https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/Summary/
type NamespacesInstanceUpdateSpec ¶ added in v0.37.0
type NamespacesInstanceUpdateSpec struct {
VmServiceSpec VmServiceSpec `json:"vm_service_spec,omitempty"`
StorageSpecs []StorageSpec `json:"storage_specs,omitempty"`
}
NamespacesInstanceUpdateSpec https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/UpdateSpec/
type NcpClusterNetworkSpec ¶
type NcpClusterNetworkSpec struct {
NsxEdgeCluster string `json:"nsx_edge_cluster,omitempty"`
PodCidrs []Cidr `json:"pod_cidrs"`
EgressCidrs []Cidr `json:"egress_cidrs"`
ClusterDistributedSwitch string `json:"cluster_distributed_switch,omitempty"`
IngressCidrs []Cidr `json:"ingress_cidrs"`
}
NcpClusterNetworkSpec defines an NSX-T network for a Tanzu Kubernetes Grid workload cluster in vSphere 7.0.0 until 7.0u1. Note: NcpClusterNetworkSpec is replaced by WorkloadNetworksSpec in 7.0u2+. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/NCPClusterNetworkEnableSpec/ TODO decide whether to rename this in the Go API to match the vSphere API. Since 7.0.0:-
type NetworkInterface ¶ added in v0.53.0
type NetworkInterface struct {
Personas []string `json:"personas"`
Network NetworkInterfaceNetwork `json:"network"`
}
NetworkInterface https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20NetworkInterface Since 9.0.0.0
type NetworkInterfaceNetwork ¶ added in v0.53.0
type NetworkInterfaceNetwork struct {
NetworkType string `json:"network_type"`
DVPGNetwork *DVPGNetwork `json:"dvpg_network,omitempty"`
}
NetworkInterfaceNetwork https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20Network Since 9.0.0.0
type NetworkNSX ¶ added in v0.53.0
type NetworkNSX struct {
DVS string `json:"dvs"`
NamespaceSubnetPrefix *int `json:"namespace_subnet_prefix,omitempty"`
}
NetworkNSX https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Workload%20NsxNetwork Since 8.0.0.1
type NetworkProvider ¶ added in v0.30.0
type NetworkProvider struct {
// contains filtered or unexported fields
}
NetworkProvider defines which type of See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/NetworkProvider/ Since 7.0.0:-
func ClusterNetworkProviderFromString ¶ added in v0.30.0
func ClusterNetworkProviderFromString(s string) NetworkProvider
func (*NetworkProvider) FromString ¶ added in v0.30.0
func (v *NetworkProvider) FromString(s string)
func (NetworkProvider) MarshalJSON ¶ added in v0.30.0
func (v NetworkProvider) MarshalJSON() ([]byte, error)
func (NetworkProvider) String ¶ added in v0.30.0
func (v NetworkProvider) String() string
func (*NetworkProvider) UnmarshalJSON ¶ added in v0.30.0
func (v *NetworkProvider) UnmarshalJSON(b []byte) error
type NetworkSegment ¶ added in v0.53.0
type NetworkSegment struct {
Networks []string `json:"networks"`
}
NetworkSegment https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20NetworkSegment Since 8.0.0.1
type NetworkVPC ¶ added in v0.53.0
type NetworkVPC struct {
NSXProject *string `json:"nsx_project,omitempty"`
VPCConnectivityProfile *string `json:"vpc_connectivity_profile,omitempty"`
DefaultPrivateCIDRs []Ipv4Cidr `json:"default_private_cidrs"`
}
NetworkVPC https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Workload%20VpcNetwork Since 8.0.0.1
type NetworkVSphere ¶ added in v0.53.0
type NetworkVSphere struct {
DVPG string `json:"dvpg"`
}
NetworkVSphere https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Workload%20VSphereNetwork Since 8.0.0.1
type NetworksCreateSpec ¶ added in v0.30.0
type NetworksCreateSpec struct {
Network string `json:"network"`
NetworkProvider *NetworkProvider `json:"network_provider"`
VSphereNetwork *VsphereDVPGNetworkCreateSpec `json:"vsphere_network,omitempty"`
// Since 7.0u3:-
NsxNetwork *NsxNetwork `json:"nsx_network,omitempty"`
}
NetworksCreateSpec specifies a Tanzu Kubernetes Grid Supervisor or Workload network that should be created. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Networks/CreateSpec/ Since 7.0u1:-
type NsxNetwork ¶ added in v0.30.0
type NsxNetwork struct {
EgressCidrs []Cidr `json:"egress_cidrs"`
IngressCidrs []Cidr `json:"ingress_cidrs"`
LoadBalancerSize string `json:"load_balancer_size"`
NamespaceNetworkCidrs []Cidr `json:"namespace_network_cidrs"`
NsxTier0Gateway string `json:"nsx_tier0_gateway"`
RoutedMode bool `json:"routed_mode"`
SubnetPrefixLength int `json:"subnet_prefix_length"`
}
NsxNetwork defines a supervisor or workload NSX-T network for use with a Tanzu Kubernetes Cluster. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Networks/NsxNetworkCreateSpec/ TODO decide whether to rename this in the Go API to match the vSphere API. Since 7.0u3:-
type Proxy ¶ added in v0.53.0
type Proxy struct {
ProxySettingsSource string `json:"proxy_settings_source"`
HTTPSProxyConfig *string `json:"https_proxy_config,omitempty"`
HTTPProxyConfig *string `json:"http_proxy_config,omitempty"`
NoProxyConfig *[]string `json:"no_proxy_config,omitempty"`
TLSRootCABundle *string `json:"tls_root_ca_bundle,omitempty"`
}
Proxy https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20ProxyConfiguration Since 8.0.0.1
type RegisterVMSpec ¶ added in v0.43.0
type RegisterVMSpec struct {
VM string `json:"vm"`
}
RegisterVMSpec https://developer.broadcom.com/xapis/vsphere-automation-api/latest/vcenter/data-structures/Namespaces_Instances_RegisterVMSpec/
type Services ¶ added in v0.53.0
Services https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Services Since 8.0.0.1
type SizingHint ¶ added in v0.30.0
type SizingHint struct {
// contains filtered or unexported fields
}
SizingHint determines the size of the Tanzu Kubernetes Grid Supervisor cluster's kubeapi instances. Note: Only use TinySizingHint in non-production environments. Note: This is a secure coding pattern to avoid Stringly typed fields. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/SizingHint/ Since 7.0.0
func SizingHintFromString ¶ added in v0.30.0
func SizingHintFromString(s string) SizingHint
func (*SizingHint) FromString ¶ added in v0.30.0
func (v *SizingHint) FromString(s string)
func (SizingHint) MarshalJSON ¶ added in v0.30.0
func (v SizingHint) MarshalJSON() ([]byte, error)
func (SizingHint) String ¶ added in v0.30.0
func (v SizingHint) String() string
func (*SizingHint) UnmarshalJSON ¶ added in v0.30.0
func (v *SizingHint) UnmarshalJSON(b []byte) error
type StorageSpec ¶ added in v0.38.0
type SupervisorService ¶ added in v0.28.0
type SupervisorService struct {
// The specification required to create a Supervisor Service with a version from inline content that is based on the vSphere application service format.
VsphereService *SupervisorServicesVSphereSpec `json:"vsphere_spec,omitempty"`
// The specification required to create a Supervisor Service with a version from inline content that is based on the Carvel application package format.
CarvelService *SupervisorServicesCarvelSpec `json:"carvel_spec,omitempty"`
}
SupervisorService defines a new SupervisorService specification
type SupervisorServiceInfo ¶ added in v0.28.0
type SupervisorServiceInfo struct {
Name string `json:"display_name"`
State string `json:"state"`
Description string `json:"description"`
MustBeInstalled bool `json:"must_be_installed"`
HasDefaultVersionsRegistered bool `json:"has_default_versions_registered"`
}
SupervisorServiceInfo for a supervisor service existent in vSphere.
type SupervisorServiceSummary ¶ added in v0.28.0
type SupervisorServiceSummary struct {
ID string `json:"supervisor_service"`
Name string `json:"display_name"`
State string `json:"state"`
}
SupervisorServiceSummary for a supervisor service existent in vSphere.
type SupervisorServiceVersion ¶ added in v0.48.0
type SupervisorServiceVersion struct {
// The specification required to create a Supervisor Service with a version from inline content that is based on the vSphere application service format.
VsphereService *SupervisorServicesVSphereVersionCreateSpec `json:"vsphere_spec,omitempty"`
// The specification required to create a Supervisor Service with a version from inline content that is based on the Carvel application package format.
CarvelService *CarvelVersionCreateSpec `json:"carvel_spec,omitempty"`
}
SupervisorServiceVersion defines a new SupervisorService version specification
type SupervisorServiceVersionInfo ¶ added in v0.48.0
type SupervisorServiceVersionInfo struct {
SupervisorServiceInfo
Eula string `json:"EULA"`
Content string `json:"content"`
ContentType string `json:"content_type"`
TrustVerified bool `json:"trust_verified"`
RegisteredByDefault bool `json:"registered_by_default"`
}
SupervisorServiceVersionInfo details a vSphere Supervisor Service version.
type SupervisorServiceVersionSummary ¶ added in v0.48.0
type SupervisorServiceVersionSummary struct {
SupervisorServiceInfo
Version string `json:"version"`
}
SupervisorServiceVersionSummary describes a vSphere Supervisor Service version.
type SupervisorServicesCarvelSpec ¶ added in v0.48.0
type SupervisorServicesCarvelSpec struct {
// Supervisor service version specification that provides the service definitions for one Supervisor Service version.
VersionSpec CarvelVersionCreateSpec `json:"version_spec"`
}
The “SupervisorServicesCarvelSpec“ class provides a specification required to create a Supervisor Service with a version from Carvel application package format (Package and PackageMetadata resources should be declared).
type SupervisorServicesVSphereSpec ¶ added in v0.28.0
type SupervisorServicesVSphereSpec struct {
VersionSpec SupervisorServicesVSphereVersionCreateSpec `json:"version_spec"`
}
SupervisorServicesVSphereSpec defines a new SupervisorService specification of vSphere type
type SupervisorServicesVSphereVersionCreateSpec ¶ added in v0.28.0
type SupervisorServicesVSphereVersionCreateSpec struct {
Content string `json:"content"`
TrustedProvider bool `json:"trusted_provider,omitempty"`
AcceptEula bool `json:"accept_EULA,omitempty"`
}
SupervisorServicesVSphereVersionCreateSpec defines a new SupervisorService specification for vSphere
type SupervisorSummaryInfo ¶ added in v0.53.0
type SupervisorSummaryInfo struct {
Name string `json:"name"`
Stats SupervisorSummaryInfoStats `json:"stats"`
ConfigStatus ConfigStatus `json:"config_status"`
KubernetesStatus KubernetesStatus `json:"kubernetes_status"`
}
type SupervisorSummaryInfoStats ¶ added in v0.53.0
type SupervisorTopologyInfo ¶ added in v0.53.0
type SupervisorTopologyInfo struct {
Zone string `json:"zone"`
Clusters []string `json:"clusters"`
}
SupervisorTopologyInfo https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Topology%20Info/ Since 8.0.0.1
type SupervisorsSummaryResult ¶ added in v0.53.0
type SupervisorsSummaryResult struct {
Items []SupervisorsSummaryResultItem `json:"items"`
}
SupervisorsSummaryResult https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Summary%20ListResult/ Since 8.0.0.1
type SupervisorsSummaryResultItem ¶ added in v0.53.0
type SupervisorsSummaryResultItem struct {
Supervisor string `json:"supervisor"`
Info SupervisorSummaryInfo `json:"info"`
}
SupervisorsSummaryResultItem https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Summary%20ListItem/ Since 8.0.0.1
type SupportBundleLocation ¶
type SupportBundleLocation struct {
Token SupportBundleToken `json:"wcp_support_bundle_token"`
URL string `json:"url"`
}
SupportBundleLocation contains the URL to download the per-cluster support bundle from, as well as a token required. Since 7.0.0:-
type SupportBundleToken ¶
SupportBundleToken information about the token required in the HTTP GET request to generate the support bundle. Since 7.0.0:-
type Syslog ¶ added in v0.53.0
type Syslog struct {
Endpoint *string `json:"endpoint,omitempty"`
CertificateAuthorityPEM *string `json:"certificate_authority_pem,omitempty"`
}
Syslog https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20Foundation%20Syslog Since 9.0.0.0
type VSphereFoundationConfig ¶ added in v0.53.0
type VSphereFoundationConfig struct {
DeploymentTarget *DeploymentTarget `json:"deployment_target,omitempty"`
Interfaces *[]NetworkInterface `json:"interfaces,omitempty"`
NetworkServices *EdgeNetworkServices `json:"network_services,omitempty"`
}
VSphereFoundationConfig https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Networks%20Edges%20VsphereFoundationConfig Since 8.0.0.1
type VgpuDevice ¶ added in v0.37.0
type VgpuDevice struct {
ProfileName string `json:"profile_name"`
}
type VirtualDevices ¶ added in v0.37.0
type VirtualDevices struct {
DirectPathIoDevices []DirectPathIoDevice `json:"direct_path_io_devices,omitempty"`
VgpuDevices []VgpuDevice `json:"vgpu_devices,omitempty"`
}
type VirtualMachineClassCreateSpec ¶ added in v0.37.0
type VirtualMachineClassCreateSpec struct {
Id string `json:"id"`
CpuCount int64 `json:"cpu_count"`
MemoryMb int64 `json:"memory_MB"`
CpuReservation int64 `json:"cpu_reservation,omitempty"`
MemoryReservation int64 `json:"memory_reservation,omitempty"`
Devices VirtualDevices `json:"devices"`
ConfigSpec json.RawMessage `json:"config_spec,omitempty"`
}
VirtualMachineClassCreateSpec https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/NamespaceManagement/VirtualMachineClasses/CreateSpec/
type VirtualMachineClassInfo ¶ added in v0.37.0
type VirtualMachineClassInfo struct {
ConfigStatus string `json:"config_status"`
Description string `json:"description"`
Id string `json:"id"`
CpuCount int64 `json:"cpu_count"`
MemoryMb int64 `json:"memory_mb"`
Messages []LocalizableMessage `json:"messages"`
Namespaces []string `json:"namespaces"`
Vms []string `json:"vms"`
Devices VirtualDevices `json:"devices"`
CpuReservation int64 `json:"cpu_reservation,omitempty"`
MemoryReservation int64 `json:"memory_reservation,omitempty"`
ConfigSpec json.RawMessage `json:"config_spec,omitempty"`
}
VirtualMachineClassInfo https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/NamespaceManagement/VirtualMachineClasses/Info/
type VirtualMachineClassUpdateSpec ¶ added in v0.37.0
type VirtualMachineClassUpdateSpec = VirtualMachineClassCreateSpec
VirtualMachineClassUpdateSpec https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/NamespaceManagement/VirtualMachineClasses/UpdateSpec/
type VmServiceSpec ¶ added in v0.37.0
type VmServiceSpec struct {
ContentLibraries []string `json:"content_libraries,omitempty"`
VmClasses []string `json:"vm_classes,omitempty"`
}
VmServiceSpec https://developer.vmware.com/apis/vsphere-automation/v7.0U3/vcenter/data-structures/Namespaces/Instances/VMServiceSpec/
type VsphereDVPGNetworkCreateSpec ¶ added in v0.30.0
type VsphereDVPGNetworkCreateSpec struct {
AddressRanges []IpRange `json:"address_ranges"`
Gateway string `json:"gateway"`
PortGroup string `json:"portgroup"`
SubnetMask string `json:"subnet_mask"`
// Since 7.0u3:-
IpAssignmentMode *IpAssignmentMode `json:"ip_assignment_mode,omitempty"`
}
See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Networks/VsphereDVPGNetworkCreateSpec/ Since 7.0u1:-
type WorkloadNetwork ¶ added in v0.53.0
type WorkloadNetwork struct {
Network *string `json:"network,omitempty"`
NetworkType string `json:"network_type"`
NSX *NetworkNSX `json:"nsx,omitempty"`
VSphere *NetworkVSphere `json:"vsphere,omitempty"`
NSXVPC *NetworkVPC `json:"nsx_vpc,omitempty"`
Services *Services `json:"services,omitempty"`
IPManagement *IPManagement `json:"ip_management,omitempty"`
}
WorkloadNetwork https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Networks%20Workload%20Network Since 8.0.0.1
type WorkloadNetworksEnableSpec ¶ added in v0.30.0
type WorkloadNetworksEnableSpec struct {
SupervisorPrimaryWorkloadNetwork *NetworksCreateSpec `json:"supervisor_primary_workload_network"`
}
WorkloadNetworksEnableSpec defines the primary workload network for a new Tanzu Kubernetes Grid supervisor cluster. This may be used by namespaces for workloads too. See https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/data-structures/NamespaceManagement/Clusters/WorkloadNetworksEnableSpec/ TODO decide whether to rename this in the Go API to match the vSphere API. Since 7.0u1:-
type Workloads ¶ added in v0.53.0
type Workloads struct {
Network WorkloadNetwork `json:"network"`
Edge Edge `json:"edge"`
KubeAPIServerOptions KubeAPIServerOptions `json:"kube_api_server_options"`
Images *Images `json:"images,omitempty"`
Storage *WorkloadsStorageConfig `json:"storage,omitempty"`
}
Workloads https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20Workloads Since 8.0.0.1
type WorkloadsStorageConfig ¶ added in v0.53.0
type WorkloadsStorageConfig struct {
CloudNativeFileVolume *CloudNativeFileVolume `json:"cloud_native_file_volume,omitempty"`
EphemeralStoragePolicy *string `json:"ephemeral_storage_policy,omitempty"`
ImageStoragePolicy *string `json:"image_storage_policy,omitempty"`
}
WorkloadsStorageConfig https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Vcenter%20NamespaceManagement%20Supervisors%20WorkloadsStorageConfig Since 8.0.0.1