Set-WMCluster
This cmdlet modifies the configuration of a Tanzu Kubernetes Grid cluster. Only the specified settings are changed and the rest of the configuration remains as it is.
Syntax
-WMCluster
< WMCluster >
[-ApiEndpointTlsCertificate
< String > ]
[-ContentLibrary
< ContentLibrary > ]
[-DefaultImageRegistryHostPort
< Int32 > ]
[-DefaultImageRegistryHostname
< String > ]
[-DefaultImageRepository
< String > ]
[-DefaultIngressTlsCertificate
< String > ]
[-EphemeralStoragePolicy
< SpbmStoragePolicy > ]
[-ExternalEgressCIDRs
< String[] > ]
[-ExternalIngressCIDRs
< String[] > ]
[-ImageStoragePolicy
< SpbmStoragePolicy > ]
[-LoginBanner
< String > ]
[-MasterDnsSearchDomain
< String[] > ]
[-MasterDnsServerIPAddress
< String[] > ]
[-MasterNtpServer
< String[] > ]
[-MasterStoragePolicy
< SpbmStoragePolicy > ]
[-PodCIDRs
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< VIServer[] > ]
[-SizeHint
< WMNamespaceManagementSizingHint > ]
[-WorkerDnsServer
< String[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
WMCluster | WMCluster | named |
|
Specifies the workload management cluster whose configuration you want to update. |
| optional | ApiEndpointTlsCertificate | String | named |
|
Specifies the certificate that the Tanzu Kubernetes API server uses. You must create the certificate by signing the Certificate Signing Request (CSR) obtained from com.vmware.vcenter.namespace_management.certificates.Request.create. |
| optional | ContentLibrary | ContentLibrary | named |
|
Specifies the content library which holds the virtual machine images for the Tanzu Kubernetes Grid Service. |
| optional | DefaultImageRegistryHostPort | Int32 | named |
|
Specifies the port number of the container image registry. If unset, the default value is 443. |
| optional | DefaultImageRegistryHostname | String | named |
|
Specifies the IP address or the host name of the container image registry. |
| optional | DefaultImageRepository | String | named |
|
Specifies the default image repository that you want to use when Kubernetes Pod container specification does not specify it as part of the container image name. |
| optional | DefaultIngressTlsCertificate | String | named |
|
Specifies the PEM-encoded Х.509 certificate that you want to use by NSX as a default fallback certificate for Tanzu Kubernetes Ingress Services. |
| optional | EphemeralStoragePolicy | SpbmStoragePolicy | named |
|
Specifies the storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. |
| optional | ExternalEgressCIDRs | String[] | named |
|
Specifies the classless inter-domain routing (CIDR) blocks from which NSX assigns IP addresses used for performing source network address translation (SNAT) from container IPs to external IPs. These ranges should not overlap with those in PodCIDRs, ServiceCIDR, IngressCIDRs, or other services running in the data center. The value is formatted as IPv4NetworkAddress/PrefixInteger. For example, this can be used to represent 256 IP addresses using the "10.10.10.0/24" value. |
| optional | ExternalIngressCIDRs | String[] | named |
|
Specifies the CIDR blocks from which NSX assigns IP addresses for Kubernetes Ingresses and Kubernetes Services of type LoadBalancer. These ranges should not overlap with those in PodCIDRs, ServiceCIDR, EgressCIDRs, or other services running in the data center. |
| optional | ImageStoragePolicy | SpbmStoragePolicy | named |
|
Specifies the storage policy associated with the storage that you want to use for the container images. |
| optional | LoginBanner | String | named |
|
Specifies the disclaimer that you want to be displayed before logging in through the vSphere Plugin for kubectl. |
| optional | MasterDnsSearchDomain | String[] | named |
|
Specifies the list of domains (for example "vmware.com") that you want to search when trying to look up a host name on the Tanzu Kubernetes API server specified in order of preference. |
| optional | MasterDnsServerIPAddress | String[] | named |
|
Specifies the list of Domain Name System (DNS) server IP addresses that you want to use on the Tanzu Kubernetes API server specified in order of preference. |
| optional | MasterNtpServer | String[] | named |
|
Specifies the list of Network Time Protocol (NTP) server DNS names or IP addresses that you want to use on the Tanzu Kubernetes API server specified in order of preference. |
| optional | MasterStoragePolicy | SpbmStoragePolicy | named |
|
Specifies the storage policy associated with the Tanzu Kubernetes API server. |
| optional | PodCIDRs | String[] | named |
|
Specifies the CIDR blocks from which Tanzu Kubernetes allocates pod IP addresses. This range should not overlap with those in ServiceCIDRs, IngressCIDRs, EgressCIDRs, or other services running in the data center. All Pod CIDR blocks must be of at least subnet size /23. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. |
| optional | SizeHint | WMNamespaceManagementSizingHint | named |
|
Specifies a hint about what size and resources to allocate to the Tanzu Kubernetes API server and the worker nodes. |
| optional | WorkerDnsServer | String[] | named |
|
Specifies the external DNS servers that you want to expose to the workloads. These DNS servers serve as the default fallback DNS servers to resolve domain names hosted outside of the Supervisor Cluster. |
Output
VMware.VimAutomation.WorkloadManagement.Types.V1.WMClusterExamples
Example 1
Set-WMCluster -WMCluster WorkloadsCluster1 -MasterDnsSearchDomain eng.domain.com,another-domain.com
Updates the list of domains that you want to search when trying to look up a host name on the Tanzu Kubernetes API server specified in order of preference.
Related Commands
WMCluster
This cmdlet deactivates the workload management feature on the specified cluster.
Enables the workload management feature on the specified cluster.
This cmdlet retrieves the configuration for the workload management feature of the clusters in the vCenter Server system.
This cmdlet modifies the workload settings of a Tanzu Kubernetes Grid cluster.