Cluster Exec Mode Command Reference

cluster

Displays the cluster details.

Command Mode

Exec

Syntax

show cluster

Usage Guidelines

Use this command to view the cluster details.

cluster configmaps

Displays the current configuration maps.

Command Mode

Exec

Syntax

show cluster configmaps namespace configmap_name detail

configmap_name

Specify the configuration map name.

Must be a string.

namespace

Specify the configmap namespace.

Must be a string.

Usage Guidelines

Use this command to view the current configuration maps.

cluster configmaps detail

Displays configmap details.

Command Mode

Exec

Syntax

cluster configmaps namespace configmap_name details

Usage Guidelines

Use this command to view configmap details.

cluster connect

Connect to and debug K8s pods and containers.

Command Mode

Exec

Syntax

cluster connect namespace namespace pod-namepod_name containercontainer_name

namespace

Specify the node namespace.

Must be a string.

pod_name

Specify the pod name.

Must be a string.

container_name

Specify the container name.

Must be a string.

Usage Guidelines

Use this command to connect to and debug the K8s pods and containers.

cluster ingresses

Displays the current ingresses.

Command Mode

Exec

Syntax

show cluster ingresses namespace ingress-name ingress_name host-name host_name

host-name host_name

Specify the host name.

Must be a string.

ingress-name ingress_name

Specify the ingress name.

Must be a string.

namespace

Specify the ingress namespace.

Must be a string.

Usage Guidelines

Use this command to view the current ingresses.

cluster ingresses detail

Displays ingress details.

Command Mode

Exec

Syntax

cluster ingresses namespace ingress-name ingress_name host-name host_name details

Usage Guidelines

Use this command to view ingress details.

cluster namespaces

Configures the current namespace.

Command Mode

Exec

Syntax

show cluster namespaces namespace smi-application smi_application_name istio-enabled { true | false}

istio-enabled { true | false}

Enables or disables Istio.

Must be one of the following:

  • false

  • true

smi-application smi_application_name

Specify the name of the SMI application.

Must be a string.

namespace

Specify the cluster's namespace.

Must be a string.

Usage Guidelines

Use this command to configure the current namespace.

cluster nodes

Displays the current nodes in the cluster.

Command Mode

Exec

Syntax

show cluster nodes node_name status status version version ip ip_address os-image os_image kernel-version kernel_version container-runtime container_runtime

container-runtime container_runtime

Specify the container runtime.

Must be a string.

ip ip_address

Specify the node's IP address.

Must be a string.

kernel-version kernel_version

Specify the Kernel version.

Must be a string.

os-image os_image

Specify the OS image.

Must be a string.

status status

Specify the status of the nodes.

Must be a string.

version version

Specify the K8s version of the nodes.

Must be a string.

name

Specify the name of the nodes.

Must be a string.

Usage Guidelines

Use this command to view the current nodes in the cluster.

cluster nodes detail

Displays node details.

Command Mode

Exec

Syntax

cluster nodes node_name detail

Usage Guidelines

Use this command to view node details.

cluster persistent-volume-claims

Displays the current persistent volume claims.

Command Mode

Exec

Syntax

show cluster persistent-volume-claims namespace pvc_name status volume volume capacity capcity storageclass storage_class

capacity capacity

Specify the volume capacity.

Must be a string.

pvc-name pvc_name

Specify the persistent volume class name.

Must be a string.

status

Specify the status of the persistent volume claims.

Must be a string.

storageclass storage_class

Specify the storage class.

Must be a string.

volume volume

Specify the volume.

Must be a string.

namespace

Specify the namespace of the volume persistent claims.

Must be a string.

Usage Guidelines

Use this command to view the current persistent volume claims.

cluster persistent-volumes

Displays the current presistent volume details.

Command Mode

Exec

Syntax

show cluster persistent-volumes pvc_name status

pvc_name

Specify the persistent volume class (PVC) name.

Must be a string.

status

Specify the status of the persistent volume.

Must be a string.

Usage Guidelines

Use this command to view details of the current persistent volumes.

cluster pods

Displays the current pod details.

Command Mode

Exec

Syntax

show cluster pods namespace pod-name pod_name ready readiness status restarts start-time start_time

pod-name pod_name

Specify the name of the pod.

Must be a string.

ready readiness

Specify the container readiness.

Must be a string.

restarts

Restarts the pods.

Must be an integer.

start-time start_time

Specify the start time.

Must be a string.

status

Specify the status of the pods.

Must be a string.

namespace

Specify the namespace of the cluster services.

Must be a string.

Usage Guidelines

Use this command to view the current pod details.

cluster pods delete

Deletes pods.

Command Mode

Exec

Syntax

cluster pods namespace pod_name delete

Usage Guidelines

Use this command to delete pods.

cluster pods detail

Displays pod details.

Command Mode

Exec

Syntax

cluster pods namespace pod_name detail

Usage Guidelines

Use this command to view pod details.

cluster services

Displays the current services in the cluster.

Command Mode

Exec

Syntax

show cluster services namespace service-name service_name cluster-ip cluster_ip external-ips external_ips

cluster-ip cluster_ip

Specify the IP address of the cluster.

Must be a string.

external-ips external_ips

Specify the etxernal IPs.

Must be a string.

service-name service_name

Specify the service name.

Must be a string.

namespace

Specify the namespace of the cluster services.

Must be a string.

Usage Guidelines

Use this command to view the current services in the cluster.

cluster services detail

Displays cluster service details.

Command Mode

Exec

Syntax

cluster services namespace service_name detail

Usage Guidelines

Use this command to view cluster service details.