vcluster_list
Retrieve a list of all vclusters in the current Kubernetes context, with optional kubeconfig path support.
Instructions
List all vclusters in the current Kubernetes context.
This function retrieves all vclusters managed by the vcluster platform in the current Kubernetes context. It sets up the Kubernetes client internally and returns the list of vclusters as serialized JSON on success, or an error object if the command failed.
Args: kubeconfig_path: Optional path to a kubeconfig file. If not provided, the default kubeconfig from the environment will be used.
Returns: Union[Dict, List, str]: List of vclusters on success, or error object if failed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kubeconfig_path | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |