| copyright |
|
||
|---|---|---|---|
| lastupdated | 2026-09-21 | ||
| keywords | kubernetes, containers | ||
| subcollection | containers |
{{site.data.keyword.attribute-definition-list}}
{: #icks_map}
This page lists all ibmcloud ks commands as they are structured in the CLI. For more details on a specific command, click the command or see the {{site.data.keyword.containerlong_notm}} CLI reference.
{: #icks_map_api}
View the current API endpoint.
{: #icks_map_api-key}
View information about the API key for a cluster or reset it to a new key.
{: #icks_map_cluster}
View and modify cluster and cluster service settings.
cluster addon: View, enable, update, and disable cluster add-ons.cluster ca: Manage the Certificate Authority (CA) certificates of a cluster.cluster create: Create a classic or VPC cluster.cluster image-security: Manage image security enforcement in your cluster.cluster master: View and modify the master for a cluster.cluster pull-secret: Manage image pull secrets for the cluster to access images in IBM Cloud Container Registry.cluster service: View, bind, and unbind IBM Cloud services on a cluster.cluster subnet: Add and create portable subnets for a classic cluster.ibmcloud ks cluster addon disable acmibmcloud ks cluster addon disable alb-oauth-proxyibmcloud ks cluster addon disable cluster-autoscaleribmcloud ks cluster addon disable debug-tool- Beta
ibmcloud ks cluster addon disable headlamp ibmcloud ks cluster addon disable helpibmcloud ks cluster addon disable hpcs-router- Beta
ibmcloud ks cluster addon disable ibm-storage-operator ibmcloud ks cluster addon disable image-key-synchronizeribmcloud ks cluster addon disable istio- Deprecated
ibmcloud ks cluster addon disable istio-extras - Deprecated
ibmcloud ks cluster addon disable istio-sample-bookinfo ibmcloud ks cluster addon disable knativeibmcloud ks cluster addon disable kube-terminalibmcloud ks cluster addon disable openshift-data-foundationibmcloud ks cluster addon disable static-routeibmcloud ks cluster addon disable vpc-block-csi-driveribmcloud ks cluster addon enable acmibmcloud ks cluster addon enable alb-oauth-proxyibmcloud ks cluster addon enable cluster-autoscaleribmcloud ks cluster addon enable debug-tool- Beta
ibmcloud ks cluster addon enable headlamp ibmcloud ks cluster addon enable helpibmcloud ks cluster addon enable hpcs-router- Beta
ibmcloud ks cluster addon enable ibm-storage-operator ibmcloud ks cluster addon enable image-key-synchronizeribmcloud ks cluster addon enable istio- Deprecated
ibmcloud ks cluster addon enable istio-extras - Deprecated
ibmcloud ks cluster addon enable istio-sample-bookinfo ibmcloud ks cluster addon enable openshift-data-foundationibmcloud ks cluster addon enable static-routeibmcloud ks cluster addon enable vpc-block-csi-driveribmcloud ks cluster addon getibmcloud ks cluster addon helpibmcloud ks cluster addon lsibmcloud ks cluster addon optionsibmcloud ks cluster addon update acmibmcloud ks cluster addon update alb-oauth-proxyibmcloud ks cluster addon update cluster-autoscaleribmcloud ks cluster addon update debug-tool- Beta
ibmcloud ks cluster addon update headlamp ibmcloud ks cluster addon update helpibmcloud ks cluster addon update hpcs-router- Beta
ibmcloud ks cluster addon update ibm-storage-operator ibmcloud ks cluster addon update image-key-synchronizeribmcloud ks cluster addon update istio- Deprecated
ibmcloud ks cluster addon update istio-extras - Deprecated
ibmcloud ks cluster addon update istio-sample-bookinfo ibmcloud ks cluster addon update knativeibmcloud ks cluster addon update kube-terminalibmcloud ks cluster addon update openshift-data-foundationibmcloud ks cluster addon update static-routeibmcloud ks cluster addon update vpc-block-csi-driveribmcloud ks cluster addon versionsibmcloud ks cluster ca createibmcloud ks cluster ca getibmcloud ks cluster ca helpibmcloud ks cluster ca rotateibmcloud ks cluster ca statusibmcloud ks cluster configibmcloud ks cluster create classicibmcloud ks cluster create helpibmcloud ks cluster create satelliteibmcloud ks cluster create vpc-classicibmcloud ks cluster create vpc-gen2ibmcloud ks cluster getibmcloud ks cluster helpibmcloud ks cluster image-security disableibmcloud ks cluster image-security enableibmcloud ks cluster image-security helpibmcloud ks cluster lsibmcloud ks cluster master audit-webhook getibmcloud ks cluster master audit-webhook helpibmcloud ks cluster master audit-webhook setibmcloud ks cluster master audit-webhook unsetibmcloud ks cluster master console-oauth-access getibmcloud ks cluster master console-oauth-access helpibmcloud ks cluster master console-oauth-access setibmcloud ks cluster master helpibmcloud ks cluster master pod-security getibmcloud ks cluster master pod-security helpibmcloud ks cluster master pod-security policy disableibmcloud ks cluster master pod-security policy enableibmcloud ks cluster master pod-security policy getibmcloud ks cluster master pod-security policy helpibmcloud ks cluster master pod-security setibmcloud ks cluster master pod-security unset- Deprecated
ibmcloud ks cluster master private-service-endpoint allowlist add - Deprecated
ibmcloud ks cluster master private-service-endpoint allowlist disable - Deprecated
ibmcloud ks cluster master private-service-endpoint allowlist enable - Deprecated
ibmcloud ks cluster master private-service-endpoint allowlist get ibmcloud ks cluster master private-service-endpoint allowlist help- Deprecated
ibmcloud ks cluster master private-service-endpoint allowlist rm ibmcloud ks cluster master private-service-endpoint enableibmcloud ks cluster master private-service-endpoint helpibmcloud ks cluster master public-service-endpoint disableibmcloud ks cluster master public-service-endpoint enableibmcloud ks cluster master public-service-endpoint helpibmcloud ks cluster master refreshibmcloud ks cluster master satellite-service-endpoint allowlist addibmcloud ks cluster master satellite-service-endpoint allowlist disableibmcloud ks cluster master satellite-service-endpoint allowlist enableibmcloud ks cluster master satellite-service-endpoint allowlist getibmcloud ks cluster master satellite-service-endpoint allowlist helpibmcloud ks cluster master satellite-service-endpoint allowlist rmibmcloud ks cluster master satellite-service-endpoint helpibmcloud ks cluster master updateibmcloud ks cluster pull-secret applyibmcloud ks cluster pull-secret helpibmcloud ks cluster rmibmcloud ks cluster service bindibmcloud ks cluster service helpibmcloud ks cluster service lsibmcloud ks cluster service unbindibmcloud ks cluster subnet addibmcloud ks cluster subnet createibmcloud ks cluster subnet detachibmcloud ks cluster subnet help
{: #icks_map_credential}
Set and unset credentials that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.
credential set: Set credentials that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account. This command applies to the targeted resource group, or to the default resource group if no resource group is targeted.
{: #icks_map_experimental}
[Expires on 2026-10-21] Experiment with new commands. IMPORTANT: Commands here will retire after the [date] in their description.
experimental trusted-profile: [Expires on 2026-10-21] View and set the trusted profile on a cluster or the default trusted profile for clusters created in a resource-group.experimental vni: [Deactivated on 2026-05-20! Useibmcloud ks vniinstead] Attach, detach, and list Virtual Network Interfaces on worker nodes.ibmcloud ks experimental helpibmcloud ks experimental trusted-profile default getibmcloud ks experimental trusted-profile default helpibmcloud ks experimental trusted-profile default setibmcloud ks experimental trusted-profile getibmcloud ks experimental trusted-profile helpibmcloud ks experimental trusted-profile set
{: #icks_map_flavor}
Getting flavor related information. Flavors determine how much virtual CPU, memory, and disk space is available to each worker node.
{: #icks_map_infra-permissions}
View information about infrastructure permissions that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.
{: #icks_map_ingress}
View and modify Ingress services and settings
ingress alb: View and configure an Ingress application load balancer (ALB).ingress domain: Manage a cluster's Ingress domains.ingress instance: Manage registered instances of the IBM Cloud Secrets Manager.ingress load-balancer: Modify load balancers that expose Ingress ALBs in your cluster.ingress secret: Manage Ingress secrets in a cluster.ingress security: Modify the ingress security configuration for your cluster.ingress status-report: View and configure Ingress status reports.ibmcloud ks ingress alb autoscale getibmcloud ks ingress alb autoscale helpibmcloud ks ingress alb autoscale setibmcloud ks ingress alb autoscale unsetibmcloud ks ingress alb autoupdate disableibmcloud ks ingress alb autoupdate enableibmcloud ks ingress alb autoupdate getibmcloud ks ingress alb autoupdate helpibmcloud ks ingress alb create classicibmcloud ks ingress alb create helpibmcloud ks ingress alb create vpc-gen2ibmcloud ks ingress alb disableibmcloud ks ingress alb enable classicibmcloud ks ingress alb enable helpibmcloud ks ingress alb enable vpc-gen2ibmcloud ks ingress alb getibmcloud ks ingress alb health-checker disableibmcloud ks ingress alb health-checker enableibmcloud ks ingress alb health-checker getibmcloud ks ingress alb health-checker helpibmcloud ks ingress alb helpibmcloud ks ingress alb lsibmcloud ks ingress alb updateibmcloud ks ingress alb versionsibmcloud ks ingress domain createibmcloud ks ingress domain default helpibmcloud ks ingress domain default replaceibmcloud ks ingress domain getibmcloud ks ingress domain helpibmcloud ks ingress domain lsibmcloud ks ingress domain rmibmcloud ks ingress domain secret helpibmcloud ks ingress domain secret regenerateibmcloud ks ingress domain secret rmibmcloud ks ingress domain updateibmcloud ks ingress helpibmcloud ks ingress instance default helpibmcloud ks ingress instance default setibmcloud ks ingress instance default unsetibmcloud ks ingress instance getibmcloud ks ingress instance helpibmcloud ks ingress instance lsibmcloud ks ingress instance registeribmcloud ks ingress instance unregisteribmcloud ks ingress load-balancer backend helpibmcloud ks ingress load-balancer backend setibmcloud ks ingress load-balancer getibmcloud ks ingress load-balancer helpibmcloud ks ingress load-balancer proxy-protocol disableibmcloud ks ingress load-balancer proxy-protocol enableibmcloud ks ingress load-balancer proxy-protocol helpibmcloud ks ingress secret createibmcloud ks ingress secret field addibmcloud ks ingress secret field helpibmcloud ks ingress secret field lsibmcloud ks ingress secret field rmibmcloud ks ingress secret getibmcloud ks ingress secret helpibmcloud ks ingress secret lsibmcloud ks ingress secret rmibmcloud ks ingress secret updateibmcloud ks ingress security helpibmcloud ks ingress security port80 disableibmcloud ks ingress security port80 enableibmcloud ks ingress security port80 getibmcloud ks ingress security port80 helpibmcloud ks ingress status-report disableibmcloud ks ingress status-report enableibmcloud ks ingress status-report getibmcloud ks ingress status-report helpibmcloud ks ingress status-report ignored-errors addibmcloud ks ingress status-report ignored-errors helpibmcloud ks ingress status-report ignored-errors lsibmcloud ks ingress status-report ignored-errors rm
{: #icks_map_kms}
View and configure Key Management Service integrations.
kms crk: List and configure the root keys for a Key Management Service instance.kms instance: View and configure available Key Management Service instances.
{: #icks_map_locations}
List supported IBM Cloud Kubernetes Service locations.
{: #icks_map_logging}
Forward logs from your cluster.
logging autoupdate: Manage automatic updates of the Fluentd add-on in a cluster.logging config: View or modify log forwarding configurations for a cluster.logging filter: View or modify log filters for a cluster.ibmcloud ks logging autoupdate disableibmcloud ks logging autoupdate enableibmcloud ks logging autoupdate getibmcloud ks logging autoupdate helpibmcloud ks logging config createibmcloud ks logging config getibmcloud ks logging config helpibmcloud ks logging config rmibmcloud ks logging config updateibmcloud ks logging filter createibmcloud ks logging filter getibmcloud ks logging filter helpibmcloud ks logging filter rmibmcloud ks logging filter updateibmcloud ks logging helpibmcloud ks logging refresh
{: #icks_map_messages}
View the current user messages.
{: #icks_map_nlb-dns}
Create and manage host names for network load balancer (NLB) IP addresses in a cluster and health check monitors for host names.
nlb-dns create: Create a DNS host name.nlb-dns monitor: Create and manage health check monitors for network load balancer (NLB) IP addresses and host names in a clusternlb-dns rm: Remove an NLB IP or load balancer host name from an NLB host name.nlb-dns secret: Manage the secret for an NLB subdomain.ibmcloud ks nlb-dns addibmcloud ks nlb-dns create classicibmcloud ks nlb-dns create helpibmcloud ks nlb-dns create vpc-gen2ibmcloud ks nlb-dns getibmcloud ks nlb-dns helpibmcloud ks nlb-dns lsibmcloud ks nlb-dns monitor configureibmcloud ks nlb-dns monitor disableibmcloud ks nlb-dns monitor enableibmcloud ks nlb-dns monitor getibmcloud ks nlb-dns monitor helpibmcloud ks nlb-dns monitor lsibmcloud ks nlb-dns replaceibmcloud ks nlb-dns rm classicibmcloud ks nlb-dns rm helpibmcloud ks nlb-dns rm vpc-gen2ibmcloud ks nlb-dns secret helpibmcloud ks nlb-dns secret regenerateibmcloud ks nlb-dns secret rm
{: #icks_map_quota}
View the quota and limits for cluster-related resources in your IBM Cloud account.
{: #icks_map_script}
Rewrite scripts that call IBM Cloud Kubernetes Service plug-in commands. Legacy-structured commands are replaced with beta-structured commands.
{: #icks_map_security-group}
Run operations against a security group.
ibmcloud ks security-group helpibmcloud ks security-group lsibmcloud ks security-group resetibmcloud ks security-group sync
{: #icks_map_storage}
View and modify storage resources.
storage attachment: View and modify storage volume attachments of worker nodes in your cluster.storage volume: View a list of storage volumes.- Beta
ibmcloud ks storage attachment create - Beta
ibmcloud ks storage attachment get ibmcloud ks storage attachment help- Beta
ibmcloud ks storage attachment ls - Beta
ibmcloud ks storage attachment rm ibmcloud ks storage help- Beta
ibmcloud ks storage volume get ibmcloud ks storage volume help- Beta
ibmcloud ks storage volume ls
- Beta
{: #icks_map_subnets}
List available portable subnets in your IBM Cloud infrastructure account.
{: #icks_map_versions}
List all the container platform versions that are available for IBM Cloud Kubernetes Service clusters.
{: #icks_map_vlan}
List public and private VLANs for a zone and view the VLAN spanning status.
vlan spanning: View the VLAN spanning status for your IBM Cloud classic infrastructure account.
{: #icks_map_vni}
Attach, detach, and list Virtual Network Interfaces on worker nodes.
vni attach: Attach a Virtual Network Interface to a worker node.
{: #icks_map_vpc}
Get information about VPCs and manage VPC clusters.
vpc outbound-traffic-protection: Change the outbound traffic protection for a Secure By Default VPC cluster.vpc secure-by-default: Modify Secure By Default Network settings for a VPC cluster.
{: #icks_map_webhook-create}
Register a webhook in a cluster.
{: #icks_map_worker}
View and modify worker nodes for a cluster.
ibmcloud ks worker getibmcloud ks worker helpibmcloud ks worker lsibmcloud ks worker rebootibmcloud ks worker reloadibmcloud ks worker replaceibmcloud ks worker rmibmcloud ks worker update
{: #icks_map_worker-pool}
View and modify worker pools for a cluster.
worker-pool create: Add a worker pool to a cluster. No worker nodes are created until zones are added to the worker pool.worker-pool label: Set and remove custom Kubernetes labels for all worker nodes in a worker pool.worker-pool operating-system: Manage the operating system of a worker pool.worker-pool taint: Set and remove Kubernetes taints for all worker nodes in a worker pool.ibmcloud ks worker-pool create classicibmcloud ks worker-pool create helpibmcloud ks worker-pool create satelliteibmcloud ks worker-pool create vpc-classicibmcloud ks worker-pool create vpc-gen2ibmcloud ks worker-pool getibmcloud ks worker-pool helpibmcloud ks worker-pool label helpibmcloud ks worker-pool label rmibmcloud ks worker-pool label setibmcloud ks worker-pool lsibmcloud ks worker-pool operating-system helpibmcloud ks worker-pool operating-system setibmcloud ks worker-pool rebalanceibmcloud ks worker-pool resizeibmcloud ks worker-pool rmibmcloud ks worker-pool taint helpibmcloud ks worker-pool taint rmibmcloud ks worker-pool taint setibmcloud ks worker-pool zones
{: #icks_map_zone}
List availability zones and modify the zones attached to a worker pool.
zone add: Add a zone to one or more worker pools in a cluster.