Set Cluster Namespace Management

Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.

Request

URI

PUT

https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}

COPY

Path Parameters

string

cluster

Required

Identifier for the cluster on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

Request Body

NamespaceManagement_Clusters_SetSpec of type(s) application/json

Required

Show optional properties

{
    "size_hint": "string",
    "network_provider": "string",
    "master_storage_policy": "string",
    "ephemeral_storage_policy": "string",
    "image_storage": {
        "storage_policy": "string"
    }
}

{
    "size_hint": "string",
    "floating_IP": "string",
    "network_provider": "string",
    "ncp_cluster_network_spec": {
        "pod_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "ingress_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "egress_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "default_ingress_tls_certificate": "string"
    },
    "master_DNS": [
        "string"
    ],
    "worker_DNS": [
        "string"
    ],
    "master_DNS_search_domains": [
        "string"
    ],
    "master_NTP_servers": [
        "string"
    ],
    "master_storage_policy": "string",
    "ephemeral_storage_policy": "string",
    "cns_file_config": {
        "vsan_clusters": [
            "string"
        ]
    },
    "login_banner": "string",
    "Master_DNS_names": [
        "string"
    ],
    "image_storage": {
        "storage_policy": "string"
    },
    "default_image_registry": {
        "hostname": "string",
        "port": 0
    },
    "default_image_repository": "string",
    "default_kubernetes_service_content_library": "string",
    "workload_ntp_servers": [
        "string"
    ],
    "cluster_proxy_config": {
        "proxy_settings_source": "string",
        "https_proxy_config": "string",
        "http_proxy_config": "string",
        "no_proxy_config": [
            "string"
        ],
        "tls_root_ca_bundle": "string"
    },
    "content_libraries": [
        {
            "content_library": "string"
        }
    ]
}

NamespaceManagement_SizingHint

size_hint

Required

The SizingHint enumerated type determines the configuration of Kubernetes API server and the worker nodes. It also determines the default values associated with the maximum number of pods and services. Use ClusterSizeInfo.get to get information associated with a SizingHint.
TINY : Cluster size of 'tiny'.
SMALL : Cluster size of 'small'.
MEDIUM : Cluster size of 'medium'.
LARGE : Cluster size of 'large'.

string

floating_IP

Optional

Optionally, you can edit the floating IP address that is assigned to the Supervisor in case the DHCP server fails during the Supervisor enablement process. The field is only relevant when the DHCP mode of the Supervisor management network is set with Clusters.EnableSpec.master-management-network. Set this floating IP parameter to remediate a supervisor enablement failure in the case where it was detected that the DHCP server does not support DHCP client identifiers.

If unset, the existing effective management network floating IP will not be modified.

NamespaceManagement_Clusters_NetworkProvider

network_provider

Required

Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster.
NSXT_CONTAINER_PLUGIN : NSX-T Container Plugin.
VSPHERE_NETWORK : vSphere Networking.

NamespaceManagement_Clusters_NCPClusterNetworkSetSpec

ncp_cluster_network_spec

Optional

The Clusters.NCPClusterNetworkSetSpec structure encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Set operation.

array of string

master_DNS

Optional

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. If unset, DNS servers set on Kubernetes API server will be cleared.

array of string

worker_DNS

Optional

List of DNS server IP addresses to use on the worker nodes, specified in order of preference. If unset, DNS servers set on worker nodes will be cleared.

array of string

master_DNS_search_domains

Optional

List of domains (for example "vmware.com") to be searched when trying to lookup a host name on Kubernetes API server, specified in order of preference. If unset, DNS search domains set on Kubernetes API server will be cleared.

array of string

master_NTP_servers

Optional

List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. If unset, VMware Tools based time synchronization is enabled and any set NTP servers are cleared.

string

master_storage_policy

Required

Identifier of storage policy associated with Kubernetes API server. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.

string

ephemeral_storage_policy

Required

Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.

NamespaceManagement_CNSFileConfig

cns_file_config

Optional

The CNSFileConfig structure contains the specification required to set the configuration for Cloud Native Storage file volume support on Supervisor.

string

login_banner

Optional

Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, disclaimer to be displayed prior to login via the Kubectl plugin will be cleared.

array of string

Master_DNS_names

Optional

List of DNS names to associate with the Kubernetes API server. These DNS names are embedded in the CSR for TLS certificate presented by the API server. The provided value will replace existing DNS names. If unset, existing DNS names will be cleared.

NamespaceManagement_Clusters_ImageStorageSpec

image_storage

Required

The Clusters.ImageStorageSpec structure contains the specification required to configure storage used for container images.

NamespaceManagement_Clusters_ImageRegistry

default_image_registry

Optional

The Clusters.ImageRegistry structure contains the specification required to configure container image registry endpoint.

string

default_image_repository

Optional

Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, default image repository will be set to Docker Hub official repository in case of Docker Hub image registry, otherwise will be set to empty string.

string

default_kubernetes_service_content_library

Optional

Identifier of the Content Library which holds the VM Images for vSphere Kubernetes Service.

This Content Library should be subscribed to VMware's hosted vSphere Kubernetes Service Repository.

Modifying or clearing the Content Library identifier will not affect existing vSphere Kubernetes Service clusters. However, upgrades or scale-out of existing clusters may be affected if the new Content Library doesn't have the necessary VM Images.

If unset, the Content Library identifier will be cleared. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.

array of string

workload_ntp_servers

Optional

List of NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. If unset, NTP for Kubernetes API servers will be used.

NamespaceManagement_ProxyConfiguration

cluster_proxy_config

Optional

The ProxyConfiguration structure defines proxy configuration to be used by the Supervisor.

array of NamespaceManagement_Clusters_ContentLibrarySpec

content_libraries

Optional

List of Content Libraries that will be associated a the Supervisor. This list should refer to existing Content Libraries in the vSphere inventory. These Content Libraries and the Content Library items belonging to them will be read-only across all vSphere Namespaces. This list does not overlap with the #defaultKubernetesServiceContentLibrary. If unset, no additional Content Libraries will be set for the Supervisor apart from the default Kubernetes Service Content Library.

Authentication

This operation uses the following authentication methods.

api_key

Responses

204

Operation doesn't return any data structure

400

com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if vSphere Namespaces is being disabled on this Supervisor cluster or if the Supervisor cluster is being restored from a backup. When a Supervisor cluster is restored, there's a window of time during which the restored Supervisor cluster's state is being synchronized back to vCenter. During that time, Supervisor cluster's configuration modifications are not allowed. | com.vmware.vapi.std.errors.unsupported : if the Supervisor cluster's hosts are not configured with sufficient resources for the new Kubernetes API Server size.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

401

com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

403

com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

404

com.vmware.vapi.std.errors.not_found : if the Supervisor cluster could not be located.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

500

com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"size_hint:"string","network_provider:"string","master_storage_policy:"string","ephemeral_storage_policy:"string","image_storage":"{}"}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}

Power CLI Samples

# Module 'VMware.Sdk.vSphere.vCenter.NamespaceManagement'

$NamespaceManagementClustersImageStorageSpec = Initialize-NamespaceManagementClustersImageStorageSpec -StoragePolicy "MyStoragePolicy" $NamespaceManagementClustersSetSpec = Initialize-NamespaceManagementClustersSetSpec -SizeHint "TINY" -NetworkProvider "NSXT_CONTAINER_PLUGIN" -MasterStoragePolicy "MyMasterStoragePolicy" -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -ImageStorage $NamespaceManagementClustersImageStorageSpec Invoke-SetClusterNamespaceManagement -Cluster "MyCluster" -NamespaceManagementClustersSetSpec $NamespaceManagementClustersSetSpec

# Module 'VMware.Sdk.vSphere.vCenter.NamespaceManagement'

$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0 $NamespaceManagementClustersNCPClusterNetworkSetSpec = Initialize-NamespaceManagementClustersNCPClusterNetworkSetSpec -PodCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr -DefaultIngressTlsCertificate "MyDefaultIngressTlsCertificate" $NamespaceManagementCNSFileConfig = Initialize-NamespaceManagementCNSFileConfig -VsanClusters "MyVsanClusters" $NamespaceManagementClustersImageStorageSpec = Initialize-NamespaceManagementClustersImageStorageSpec -StoragePolicy "MyStoragePolicy" $NamespaceManagementClustersImageRegistry = Initialize-NamespaceManagementClustersImageRegistry -Hostname "MyHostname" -Port 0 $NamespaceManagementClustersSetSpec = Initialize-NamespaceManagementClustersSetSpec -SizeHint "TINY" -FloatingIP "MyFloatingIP" -NetworkProvider "NSXT_CONTAINER_PLUGIN" -NcpClusterNetworkSpec $NamespaceManagementClustersNCPClusterNetworkSetSpec -MasterDNS "MyMasterDNS" -WorkerDNS "MyWorkerDNS" -MasterDNSSearchDomains "MyMasterDNSSearchDomains" -MasterNTPServers "MyMasterNTPServers" -MasterStoragePolicy "MyMasterStoragePolicy" -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -CnsFileConfig $NamespaceManagementCNSFileConfig -LoginBanner "MyLoginBanner" -ImageStorage $NamespaceManagementClustersImageStorageSpec -DefaultImageRegistry $NamespaceManagementClustersImageRegistry -DefaultImageRepository "MyDefaultImageRepository" -DefaultKubernetesServiceContentLibrary "MyDefaultKubernetesServiceContentLibrary" -WorkloadNtpServers "MyWorkloadNtpServers" Invoke-SetClusterNamespaceManagement -Cluster "MyCluster" -NamespaceManagementClustersSetSpec $NamespaceManagementClustersSetSpec

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Namespace Management Operations

POST

Disable Cluster