{ "Locale": "en_US", "Plugins": { "container-service": { "Name": "container-service", "Aliases": [ "kubernetes-service", "ks" ], "Version": { "Major": 1, "Minor": 0, "Build": 706 }, "MinCliVersion": { "Major": 0, "Minor": 18, "Build": 2 }, "Namespaces": [ { "ParentName": "ks", "Name": "api-key", "Aliases": null, "Description": "View information about the API key for a cluster or reset it to a new key.", "Stage": "" }, { "ParentName": "ks credential", "Name": "set", "Aliases": null, "Description": "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.", "Stage": "" }, { "ParentName": "ks", "Name": "credential", "Aliases": null, "Description": "Set and unset credentials that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.", "Stage": "" }, { "ParentName": "ks", "Name": "infra-permissions", "Aliases": null, "Description": "View information about infrastructure permissions that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.", "Stage": "" }, { "ParentName": "ks logging", "Name": "config", "Aliases": null, "Description": "View or modify log forwarding configurations for a cluster.", "Stage": "" }, { "ParentName": "ks logging", "Name": "filter", "Aliases": null, "Description": "View or modify log filters for a cluster.", "Stage": "" }, { "ParentName": "ks logging", "Name": "autoupdate", "Aliases": null, "Description": "Manage automatic updates of the Fluentd add-on in a cluster.", "Stage": "" }, { "ParentName": "ks", "Name": "logging", "Aliases": null, "Description": "Forward logs from your cluster.", "Stage": "" }, { "ParentName": "ks", "Name": "quota", "Aliases": null, "Description": "View the quota and limits for cluster-related resources in your IBM Cloud account.", "Stage": "" }, { "ParentName": "ks", "Name": "script", "Aliases": null, "Description": "Rewrite scripts that call IBM Cloud Kubernetes Service plug-in commands. Legacy-structured commands are replaced with beta-structured commands.", "Stage": "" }, { "ParentName": "ks vpc", "Name": "outbound-traffic-protection", "Aliases": null, "Description": "Change the outbound traffic protection for a Secure By Default VPC cluster.", "Stage": "" }, { "ParentName": "ks vpc", "Name": "secure-by-default", "Aliases": null, "Description": "Modify Secure By Default Network settings for a VPC cluster.", "Stage": "" }, { "ParentName": "ks", "Name": "vpc", "Aliases": null, "Description": "Get information about VPCs and manage VPC clusters.", "Stage": "" }, { "ParentName": "ks", "Name": "flavor", "Aliases": null, "Description": "Getting flavor related information. Flavors determine how much virtual CPU, memory, and disk space is available to each worker node.", "Stage": "" }, { "ParentName": "ks alb", "Name": "create", "Aliases": null, "Description": "Create and enable an Ingress ALB in a cluster.", "Stage": "deprecated" }, { "ParentName": "ks alb", "Name": "configure", "Aliases": null, "Description": "Enable or disable an Ingress ALB in a cluster.", "Stage": "deprecated" }, { "ParentName": "ks alb", "Name": "autoupdate", "Aliases": null, "Description": "Manage automatic updates for the Ingress ALB add-on in a cluster.", "Stage": "deprecated" }, { "ParentName": "ks alb", "Name": "cert", "Aliases": null, "Description": "Manage Ingress ALB certificates in a cluster.", "Stage": "deprecated" }, { "ParentName": "ks alb", "Name": "migrate", "Aliases": null, "Description": "Migrate your IBM Cloud Ingress configmap and resources to the Kubernetes Ingress format.", "Stage": "deprecated" }, { "ParentName": "ks", "Name": "alb", "Aliases": null, "Description": "View and configure an Ingress application load balancer (ALB).", "Stage": "deprecated" }, { "ParentName": "ks cluster", "Name": "create", "Aliases": null, "Description": "Create a classic or VPC cluster.", "Stage": "" }, { "ParentName": "ks cluster addon", "Name": "enable", "Aliases": null, "Description": "Enable cluster add-ons.", "Stage": "" }, { "ParentName": "ks cluster addon", "Name": "update", "Aliases": null, "Description": "Update cluster add-ons.", "Stage": "" }, { "ParentName": "ks cluster addon", "Name": "disable", "Aliases": null, "Description": "Disable cluster add-ons.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "addon", "Aliases": null, "Description": "View, enable, update, and disable cluster add-ons.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "autoupdate", "Aliases": null, "Description": "Manage automatic patch updates of the cluster master.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "user-subnet", "Aliases": null, "Description": "Add and remove user-managed portable subnets for a classic cluster.", "Stage": "deprecated" }, { "ParentName": "ks cluster", "Name": "subnet", "Aliases": null, "Description": "Add and create portable subnets for a classic cluster.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "service", "Aliases": null, "Description": "View, bind, and unbind IBM Cloud services on a cluster.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "pull-secret", "Aliases": null, "Description": "Manage image pull secrets for the cluster to access images in IBM Cloud Container Registry.", "Stage": "" }, { "ParentName": "ks cluster master", "Name": "audit-webhook", "Aliases": null, "Description": "View and modify the audit webhook configuration for a cluster's Kubernetes API server. The webhook backend forwards API server audit logs to a remote server.", "Stage": "" }, { "ParentName": "ks cluster master private-service-endpoint", "Name": "allowlist", "Aliases": null, "Description": "Manage the private service endpoint allowlist for a non-Satellite cluster", "Stage": "deprecated" }, { "ParentName": "ks cluster master", "Name": "private-service-endpoint", "Aliases": null, "Description": "Manage the private service endpoint of a cluster.", "Stage": "" }, { "ParentName": "ks cluster master", "Name": "public-service-endpoint", "Aliases": null, "Description": "Manage the public service endpoint of a non Satellite cluster.", "Stage": "" }, { "ParentName": "ks cluster master satellite-service-endpoint", "Name": "allowlist", "Aliases": null, "Description": "Manage the Satellite service endpoint allowlist for a Satellite cluster with CoreOS enabled. This allowlist applies to all traffic to the Satellite cluster master.", "Stage": "" }, { "ParentName": "ks cluster master", "Name": "satellite-service-endpoint", "Aliases": null, "Description": "Manage the public service endpoints accessability of a satellite cruiser.", "Stage": "" }, { "ParentName": "ks cluster master", "Name": "console-oauth-access", "Aliases": null, "Description": "View and modify the web console and OAuth server access type for Red Hat OpenShift on IBM Cloud VPC infrastructure.\nChanging has effect only if the cluster is created without public service endpoint.", "Stage": "" }, { "ParentName": "ks cluster master pod-security", "Name": "policy", "Aliases": null, "Description": "View and modify the deprecated PodSecurityPolicy configuration for a cluster's Kubernetes API server.", "Stage": "" }, { "ParentName": "ks cluster master", "Name": "pod-security", "Aliases": null, "Description": "View and modify the PodSecurity admission settings for a cluster's Kubernetes API server.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "master", "Aliases": null, "Description": "View and modify the master for a cluster.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "ca", "Aliases": null, "Description": "Manage the Certificate Authority (CA) certificates of a cluster.", "Stage": "" }, { "ParentName": "ks cluster", "Name": "image-security", "Aliases": null, "Description": "Manage image security enforcement in your cluster.", "Stage": "" }, { "ParentName": "ks cluster feature", "Name": "enable", "Aliases": null, "Description": "Enable cluster features.", "Stage": "deprecated" }, { "ParentName": "ks cluster feature", "Name": "disable", "Aliases": null, "Description": "Disable cluster features.", "Stage": "deprecated" }, { "ParentName": "ks cluster", "Name": "feature", "Aliases": null, "Description": "Enable and disable cluster features.", "Stage": "deprecated" }, { "ParentName": "ks", "Name": "cluster", "Aliases": null, "Description": "View and modify cluster and cluster service settings.", "Stage": "" }, { "ParentName": "ks ingress status-report", "Name": "ignored-errors", "Aliases": null, "Description": "View and configure ignored warnings for a cluster.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "status-report", "Aliases": null, "Description": "View and configure Ingress status reports.", "Stage": "" }, { "ParentName": "ks ingress load-balancer", "Name": "proxy-protocol", "Aliases": null, "Description": "VPC Gen 2 only: Modify the PROXY protocol configuration for ALB load balancers. After you run these commands, existing load balancers are deleted and recreated, which can cause service disruptions. Two unused IP addresses must be available in each subnet during the load balancer recreation.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "load-balancer", "Aliases": [ "lb" ], "Description": "Modify load balancers that expose Ingress ALBs in your cluster.\n\nDOCS:\n\t\t\t\tFor more information, see 'https://cloud.ibm.com/docs/containers?topic=containers-comm-ingress-annotations#preserve_source_ip'\n", "Stage": "" }, { "ParentName": "ks ingress secret", "Name": "field", "Aliases": null, "Description": "Manage the fields of an Ingress secret.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "secret", "Aliases": null, "Description": "Manage Ingress secrets in a cluster.\n\nDOCS:\n\t\t\t\tFor more information, see 'https://cloud.ibm.com/docs/containers?topic=containers-secrets'\n", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "create", "Aliases": null, "Description": "Create and enable an Ingress ALB in a cluster.", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "enable", "Aliases": null, "Description": "Enable an Ingress ALB in a cluster.", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "autoupdate", "Aliases": null, "Description": "Manage automatic updates for the Ingress ALB add-on in a cluster.", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "health-checker", "Aliases": null, "Description": "Manage the Ingress health checker.", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "migrate", "Aliases": null, "Description": "Migrate your IBM Cloud Ingress configmap and resources to the Kubernetes Ingress format.", "Stage": "" }, { "ParentName": "ks ingress alb", "Name": "autoscale", "Aliases": null, "Description": "Manage autoscaling configuration for Ingress ALBs.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "alb", "Aliases": null, "Description": "View and configure an Ingress application load balancer (ALB).\n\nDOCS:\n\t\t\t\tFor more information, see 'https://cloud.ibm.com/docs/containers?topic=containers-ingress-alb-manage'\n", "Stage": "" }, { "ParentName": "ks ingress instance", "Name": "default", "Aliases": null, "Description": "Update the default configuration of a registered IBM Cloud Secrets Manager instance.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "instance", "Aliases": null, "Description": "Manage registered instances of the IBM Cloud Secrets Manager.\n\nDOCS:\n\t\t\t\tFor more information, see 'https://cloud.ibm.com/docs/containers?topic=containers-secrets-mgr'\n", "Stage": "" }, { "ParentName": "ks ingress domain credential", "Name": "set", "Aliases": null, "Description": "Add an external domain provider credential for the cluster.", "Stage": "" }, { "ParentName": "ks ingress domain", "Name": "credential", "Aliases": null, "Description": "Manage a cluster's external domain provider credentials.", "Stage": "" }, { "ParentName": "ks ingress domain", "Name": "default", "Aliases": null, "Description": "Manage a cluster's default Ingress domain.", "Stage": "" }, { "ParentName": "ks ingress domain", "Name": "secret", "Aliases": null, "Description": "Manage the secrets for an Ingress domain.", "Stage": "" }, { "ParentName": "ks ingress", "Name": "domain", "Aliases": null, "Description": "Manage a cluster's Ingress domains.\n\nDOCS:\n\t\t\t\tFor more information, see 'https://cloud.ibm.com/docs/containers?topic=containers-ingress-domains'\n", "Stage": "" }, { "ParentName": "ks", "Name": "ingress", "Aliases": null, "Description": "View and modify Ingress services and settings", "Stage": "" }, { "ParentName": "ks kms", "Name": "instance", "Aliases": null, "Description": "View and configure available Key Management Service instances.", "Stage": "" }, { "ParentName": "ks kms", "Name": "crk", "Aliases": null, "Description": "List and configure the root keys for a Key Management Service instance.", "Stage": "" }, { "ParentName": "ks", "Name": "kms", "Aliases": null, "Description": "View and configure Key Management Service integrations.", "Stage": "" }, { "ParentName": "ks nlb-dns", "Name": "create", "Aliases": null, "Description": "Create a DNS host name.", "Stage": "" }, { "ParentName": "ks nlb-dns", "Name": "rm", "Aliases": null, "Description": "Remove an NLB IP or load balancer host name from an NLB host name.", "Stage": "" }, { "ParentName": "ks nlb-dns", "Name": "monitor", "Aliases": null, "Description": "Create and manage health check monitors for network load balancer (NLB) IP addresses and host names in a cluster", "Stage": "" }, { "ParentName": "ks nlb-dns", "Name": "secret", "Aliases": null, "Description": "Manage the secret for an NLB subdomain.", "Stage": "" }, { "ParentName": "ks", "Name": "nlb-dns", "Aliases": null, "Description": "Create and manage host names for network load balancer (NLB) IP addresses in a cluster and health check monitors for host names.", "Stage": "" }, { "ParentName": "ks storage", "Name": "attachment", "Aliases": null, "Description": "View and modify storage volume attachments of worker nodes in your cluster.", "Stage": "beta" }, { "ParentName": "ks storage", "Name": "volume", "Aliases": null, "Description": "View a list of storage volumes.", "Stage": "beta" }, { "ParentName": "ks", "Name": "storage", "Aliases": null, "Description": "View and modify storage resources.", "Stage": "beta" }, { "ParentName": "ks vlan", "Name": "spanning", "Aliases": null, "Description": "View the VLAN spanning status for your IBM Cloud classic infrastructure account.", "Stage": "" }, { "ParentName": "ks", "Name": "vlan", "Aliases": null, "Description": "List public and private VLANs for a zone and view the VLAN spanning status.", "Stage": "" }, { "ParentName": "ks", "Name": "worker", "Aliases": null, "Description": "View and modify worker nodes for a cluster.", "Stage": "" }, { "ParentName": "ks worker-pool", "Name": "create", "Aliases": null, "Description": "Add a worker pool to a cluster. No worker nodes are created until zones are added to the worker pool.", "Stage": "" }, { "ParentName": "ks worker-pool", "Name": "taint", "Aliases": null, "Description": "Set and remove Kubernetes taints for all worker nodes in a worker pool.", "Stage": "" }, { "ParentName": "ks worker-pool", "Name": "label", "Aliases": null, "Description": "Set and remove custom Kubernetes labels for all worker nodes in a worker pool.", "Stage": "" }, { "ParentName": "ks worker-pool", "Name": "operating-system", "Aliases": null, "Description": "Manage the operating system of a worker pool.", "Stage": "" }, { "ParentName": "ks", "Name": "worker-pool", "Aliases": null, "Description": "View and modify worker pools for a cluster.", "Stage": "" }, { "ParentName": "ks zone", "Name": "add", "Aliases": null, "Description": "Add a zone to one or more worker pools in a cluster.", "Stage": "" }, { "ParentName": "ks", "Name": "zone", "Aliases": null, "Description": "List availability zones and modify the zones attached to a worker pool.", "Stage": "" }, { "ParentName": "ks", "Name": "security-group", "Aliases": null, "Description": "Run operations against a security group.", "Stage": "" }, { "ParentName": "ks dedicated host", "Name": "placement", "Aliases": null, "Description": "Enable or disable dedicated host placement.", "Stage": "experimental" }, { "ParentName": "ks dedicated", "Name": "host", "Aliases": null, "Description": "View, create, and delete a dedicated host.", "Stage": "experimental" }, { "ParentName": "ks dedicated", "Name": "pool", "Aliases": null, "Description": "View, create, and delete a dedicated host pool.", "Stage": "experimental" }, { "ParentName": "ks", "Name": "dedicated", "Aliases": null, "Description": "View, create, and remove a dedicated host or dedicated host pool.", "Stage": "experimental" }, { "ParentName": "", "Name": "ks", "Aliases": [ "cs", "oc" ], "Description": "Manage Kubernetes and OpenShift clusters in IBM Cloud. Aliases include 'ibmcloud oc'.", "Stage": "" }, { "ParentName": "sat", "Name": "connector", "Aliases": null, "Description": "Create, view, and modify Satellite connectors.", "Stage": "" }, { "ParentName": "sat location", "Name": "dns", "Aliases": null, "Description": "Set and manage subdomains for the hosts assigned to the control plane in a Satellite location.", "Stage": "" }, { "ParentName": "sat", "Name": "location", "Aliases": null, "Description": "Create, view, and modify Satellite locations.", "Stage": "" }, { "ParentName": "sat endpoint", "Name": "authn", "Aliases": null, "Description": "Configure authentication settings for an endpoint.", "Stage": "" }, { "ParentName": "sat", "Name": "endpoint", "Aliases": null, "Description": "View and manage Satellite endpoints.", "Stage": "" }, { "ParentName": "sat acl", "Name": "subnet", "Aliases": null, "Description": "Configure subnets for an ACL.", "Stage": "" }, { "ParentName": "sat acl", "Name": "endpoint", "Aliases": null, "Description": "Configure endpoints for an ACL.", "Stage": "" }, { "ParentName": "sat", "Name": "acl", "Aliases": null, "Description": "View and manage Satellite access control lists (ACLs).", "Stage": "" }, { "ParentName": "sat", "Name": "agent", "Aliases": null, "Description": "Attach or view Satellite Connector Agents.", "Stage": "" }, { "ParentName": "sat", "Name": "host", "Aliases": null, "Description": "View and modify Satellite hosts.", "Stage": "" }, { "ParentName": "sat", "Name": "cluster", "Aliases": null, "Description": "Register and manage clusters for use with Satellite configurations.", "Stage": "" }, { "ParentName": "sat", "Name": "group", "Aliases": null, "Description": "View and manage Satellite cluster groups. Cluster groups are used to subscribe clusters to Satellite configurations of Kubernetes resources.", "Stage": "" }, { "ParentName": "sat", "Name": "key", "Aliases": [], "Description": "View and manage Satellite Config keys.", "Stage": "" }, { "ParentName": "sat config", "Name": "version", "Aliases": null, "Description": "View and manage Satellite configuration versions.", "Stage": "" }, { "ParentName": "sat", "Name": "config", "Aliases": null, "Description": "View and manage Satellite Configuration.", "Stage": "" }, { "ParentName": "sat resource", "Name": "history", "Aliases": null, "Description": "Get history for a Kubernetes resource.", "Stage": "" }, { "ParentName": "sat", "Name": "resource", "Aliases": null, "Description": "Search and view Kubernetes resources that are managed by a Satellite configuration.", "Stage": "" }, { "ParentName": "sat", "Name": "service", "Aliases": null, "Description": "View Satellite service clusters.", "Stage": "" }, { "ParentName": "sat storage", "Name": "template", "Aliases": null, "Description": "View the Satellite storage templates.", "Stage": "" }, { "ParentName": "sat storage config", "Name": "param", "Aliases": null, "Description": "Set the configuration and secret parameters of a Satellite storage configuration.", "Stage": "" }, { "ParentName": "sat storage config", "Name": "class", "Aliases": [ "sc" ], "Description": "View and manage the storage classes in your Satellite storage configuration.", "Stage": "" }, { "ParentName": "sat storage", "Name": "config", "Aliases": null, "Description": "View and manage Satellite storage configurations.", "Stage": "" }, { "ParentName": "sat storage assignment", "Name": "autopatch", "Aliases": null, "Description": "Manage automatic patches for your Satellite storage assignments.", "Stage": "beta" }, { "ParentName": "sat storage", "Name": "assignment", "Aliases": null, "Description": "View and manage Satellite storage assignments.", "Stage": "" }, { "ParentName": "sat", "Name": "storage", "Aliases": null, "Description": "View and manage Satellite storage resources.", "Stage": "" }, { "ParentName": "sat subscription", "Name": "identity", "Aliases": null, "Description": "Manage the identity used to apply the Satellite subscription.", "Stage": "" }, { "ParentName": "sat", "Name": "subscription", "Aliases": [ "sub" ], "Description": "View and manage Satellite subscriptions to deploy Kubernetes configuration files to your clusters.", "Stage": "" }, { "ParentName": "sat", "Name": "mesh", "Aliases": null, "Description": "View and modify Satellite Mesh instances.", "Stage": "experimental" }, { "ParentName": "sat experimental acl", "Name": "subnet", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl subnet' instead] Configure subnets for an ACL.", "Stage": "" }, { "ParentName": "sat experimental acl", "Name": "endpoint", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl endpoint' instead] Configure endpoints for an ACL.", "Stage": "" }, { "ParentName": "sat experimental", "Name": "acl", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl' instead] View and manage Satellite access control lists (ACLs).", "Stage": "" }, { "ParentName": "sat experimental", "Name": "agent", "Aliases": null, "Description": "[Deactivated on 2024-09-01! Use 'ibmcloud sat agent' instead] Attach or view Satellite Connector Agents.", "Stage": "" }, { "ParentName": "sat experimental endpoint", "Name": "authn", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat endpoint authn' instead] Configure authentication settings for an endpoint.", "Stage": "" }, { "ParentName": "sat experimental", "Name": "endpoint", "Aliases": null, "Description": "[Expires on 2024-10-01] View and manage Satellite endpoints.", "Stage": "" }, { "ParentName": "sat experimental", "Name": "connector", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector' instead] Create, view, and modify Satellite connectors.", "Stage": "" }, { "ParentName": "sat experimental", "Name": "location", "Aliases": null, "Description": "[Deactivated on 2024-11-25! Use 'ibmcloud sat location' instead] Create, view, and modify Satellite locations.", "Stage": "" }, { "ParentName": "sat", "Name": "experimental", "Aliases": null, "Description": "[Expires on 2024-11-25] Experiment with new commands. IMPORTANT: Commands here will retire after the [date] in their description.", "Stage": "" }, { "ParentName": "", "Name": "sat", "Aliases": null, "Description": "Manage IBM Cloud Satellite clusters.", "Stage": "" } ], "Commands": [ { "Namespace": "ks", "Name": "api", "Alias": "", "Aliases": null, "Description": "View or set the API endpoint and API version for the service.", "Usage": "ibmcloud ks api [--api-version VERSION] [--endpoint ENDPOINT] [--insecure] [-q] [--skip-ssl-validation]", "Flags": [ { "Name": "endpoint", "Description": "Set the API endpoint for the service.", "HasValue": true, "Hidden": false }, { "Name": "insecure", "Description": "Allow an insecure HTTP connection.", "HasValue": false, "Hidden": false }, { "Name": "skip-ssl-validation", "Description": "Allow insecure SSL certificates.", "HasValue": false, "Hidden": false }, { "Name": "api-version", "Description": "Specify the API version of the service that you want to use.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks api-key", "Name": "info", "Alias": "", "Aliases": null, "Description": "View information about the API key owner for a cluster.", "Usage": "ibmcloud ks api-key info --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks api-key", "Name": "reset", "Alias": "", "Aliases": null, "Description": "Replace the API key for all clusters in the specified region and targeted resource group. If no resource group is targeted the command applies to the default resource group. For more information, see 'http://ibm.biz/api-key'.", "Usage": "ibmcloud ks api-key reset --region REGION [-f] [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks api-key", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks api-key help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks credential", "Name": "get", "Alias": "", "Aliases": [ "credentials-get" ], "Description": "If you set up your IBM Cloud account to use different credentials to access the IBM Cloud classic infrastructure portfolio, get the infrastructure user name. This command applies to the targeted resource group, or to the default resource group if no resource group is targeted.", "Usage": "ibmcloud ks credential get --region REGION [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks credential set", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Set credentials that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.", "Usage": "ibmcloud ks credential set classic --infrastructure-api-key KEY --infrastructure-username USERNAME --region REGION [-q]", "Flags": [ { "Name": "infrastructure-username", "Description": "The user name of your IBM Cloud classic infrastructure account.", "HasValue": true, "Hidden": false }, { "Name": "infrastructure-api-key", "Description": "The API key of your IBM Cloud classic infrastructure account.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks credential set", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks credential set help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks credential", "Name": "unset", "Alias": "", "Aliases": [ "credentials-unset" ], "Description": "Remove the 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.", "Usage": "ibmcloud ks credential unset --region REGION [-q]", "Flags": [ { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks credential", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks credential help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks infra-permissions", "Name": "get", "Alias": "", "Aliases": null, "Description": "Check whether the credentials that allow access to the IBM Cloud classic infrastructure portfolio for the targeted resource group are missing suggested or required infrastructure permissions. This command applies to the targeted resource group, or to the default resource group if no resource group is targeted.", "Usage": "ibmcloud ks infra-permissions get [--output OUTPUT] [-q] [--region REGION]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "Specify the region to target. If a region is not already targeted, this argument must be specified. To check if a region is targeted, run 'ibmcloud target'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks infra-permissions", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks infra-permissions help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "init", "Alias": "", "Aliases": null, "Description": "Initialize the Kubernetes Service plug-in and get authentication tokens.", "Usage": "ibmcloud ks init [--host HOST] [--insecure] [-p P] [-q] [-u U]", "Flags": [ { "Name": "host", "Description": "The API endpoint for the service.", "HasValue": true, "Hidden": false }, { "Name": "u", "Description": "The IBM Cloud user ID.", "HasValue": true, "Hidden": false }, { "Name": "p", "Description": "The IBM Cloud password.", "HasValue": true, "Hidden": false }, { "Name": "insecure", "Description": "Allow an insecure HTTP connection.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "key-protect-enable", "Alias": "", "Aliases": null, "Description": "Enable Key Protect as a key management service (KMS) in your cluster to encrypt your secrets.", "Usage": "ibmcloud ks key-protect-enable --cluster CLUSTER --crk CRK --key-protect-instance INSTANCE --key-protect-url URL [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "key-protect-url", "Description": "Key Protect endpoint. To get the endpoint, see 'https://ibm.biz/kp-endpoints'", "HasValue": true, "Hidden": false }, { "Name": "key-protect-instance", "Description": "Key Protect instance ID. To get the instance ID, run 'ibmcloud resource service-instance \u003ckp_service\u003e --id' and copy the second value (not the full CRN)", "HasValue": true, "Hidden": false }, { "Name": "crk", "Description": "Key Protect customer root key. To get the CRK, see 'https://ibm.biz/kp-viewcrk'", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks logging", "Name": "refresh", "Alias": "", "Aliases": null, "Description": "Refresh the logging configuration for a cluster.", "Usage": "ibmcloud ks logging refresh --cluster CLUSTER [--force-update] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging config", "Name": "get", "Alias": "", "Aliases": null, "Description": "View log forwarding configurations for a cluster.", "Usage": "ibmcloud ks logging config get --cluster CLUSTER [--logsource LOGSOURCE] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "logsource", "Description": "The kind of log source you want to filter for. Accepted values are 'container', 'application', 'ingress', 'worker', 'storage' and 'kubernetes'. If you do not pass a log source, all logging configurations for the cluster are returned.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging config", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update a log forwarding configuration for a cluster.", "Usage": "ibmcloud ks logging config update --cluster CLUSTER --id ID --logsource LOGSOURCE --type TYPE [--force-update] [--hostname HOSTNAME] [--output OUTPUT] [--port PORT] [-q] (--ca-cert CERT --syslog-protocol PROTOCOL --verify-mode MODE | --org ORG --skip-validation --space SPACE) (--namespace NAMESPACE | -C CONTAINER -p PATH)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "id", "Description": "Specify the ID of the logging configuration.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The namespace you want to apply the log forwarding configuration to. Only use this flag with the 'container' log source or if you do not specify a log source. If you do not specify a namespace, then all namespaces use this configuration.", "HasValue": true, "Hidden": false }, { "Name": "logsource", "Description": "The source of the logs to forward. Supported values are 'container', 'application', 'ingress', 'worker', 'storage', and 'kubernetes'. This argument supports a comma separated list of log sources. If you do not provide a log source, logs for 'container' and 'ingress' are forwarded.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The log forwarding protocol that you want to use. The only supported value is 'syslog'.", "HasValue": true, "Hidden": false }, { "Name": "syslog-protocol", "Description": "When the logging type is 'syslog', the transport layer protocol. Supported values are 'tls', 'tcp' and the default 'udp'. When forwarding to an rsyslog server with the UDP protocol, logs that are over 1KB are truncated.", "HasValue": true, "Hidden": false }, { "Name": "ca-cert", "Description": "When the logging type is 'syslog' and the protocol is tls, the Kubernetes secret name that contains the Certificate Authority certificate.", "HasValue": true, "Hidden": false }, { "Name": "verify-mode", "Description": "When the logging type is 'syslog' and the protocol is tls, the verification mode. Supported values are 'verify-peer' and the default 'verify-none'.", "HasValue": true, "Hidden": false }, { "Name": "hostname", "Description": "When logging type is 'syslog', the hostname or IP address of the log collector. When logging type is 'ibm' (deprecated), the logging ingest endpoint. If you do not provide the logging ingest endpoint, then the current region's endpoint is used.", "HasValue": true, "Hidden": false }, { "Name": "port", "Description": "The port of the log collector. If you do not specify a port, the default port for the ingestion endpoint is used for 'ibm' (deprecated) and '514' is used for 'syslog'.", "HasValue": true, "Hidden": false }, { "Name": "org", "Description": "::deprecated::The org name to send logs to. This flag is only valid when the logging type is 'ibm'. The org name is required when you specify a space name. If you do not specify a space name, then logs are forwarded at the account level.", "HasValue": true, "Hidden": false }, { "Name": "space", "Description": "::deprecated::The space name to send logs to. This flag is only valid when the logging type is 'ibm'. The space name is required when you specify an org name. If you do not specify a space name, then logs are forwarded at the account level.", "HasValue": true, "Hidden": false }, { "Name": "skip-validation", "Description": "Skips validation of the org and space names when they are specified. This can result in a broken logging config if the values are invalid but will take less time to process.", "HasValue": true, "Hidden": false }, { "Name": "app-containers", "Description": "Specify the containers that you want to collect logs for. To specify more than one path, use multiple flags, such as '-C container1 -C container2'. This option is required for the 'application' log source. If not provided, logs are collected from all containers from the application log paths passed in.", "HasValue": true, "Hidden": false }, { "Name": "C, app-container", "Description": "Specify the containers that you want to collect logs for. To specify more than one path, use multiple flags, such as '-C container1 -C container2'. This option is required for the 'application' log source. If not provided, logs are collected from all containers from the application log paths passed in.", "HasValue": true, "Hidden": false }, { "Name": "app-paths", "Description": "Specify the absolute file path to collect logs from inside the container. To specify more than one path, use multiple flags, such as `-p path1 -p path2`. Required parameter when specifying 'application' for the log source. Wildcards such as '/var/log/*.log' are accepted but recursive globs such are '/var/log/**/test.log' are not.", "HasValue": true, "Hidden": false }, { "Name": "p, app-path", "Description": "Specify the absolute file path to collect logs from inside the container. To specify more than one path, use multiple flags, such as `-p path1 -p path2`. Required parameter when specifying 'application' for the log source. Wildcards such as '/var/log/*.log' are accepted but recursive globs such are '/var/log/**/test.log' are not.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging config", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a logging configuration. If you are using a Dedicated account, you must log in to the public IBM Cloud endpoint and target your public org and space to enable log forwarding.", "Usage": "ibmcloud ks logging config create --cluster CLUSTER --logsource LOGSOURCE --type TYPE [--force-update] [--hostname HOSTNAME] [--output OUTPUT] [--port PORT] [-q] (--ca-cert CERT --syslog-protocol PROTOCOL --verify-mode MODE | --org ORG --skip-validation --space SPACE) (--namespace NAMESPACE | -C CONTAINER -p PATH)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The namespace you want to apply the log forwarding configuration to. Only use this flag with the 'container' log source or if you do not specify a log source. If you do not specify a namespace, then all namespaces use this configuration.", "HasValue": true, "Hidden": false }, { "Name": "logsource", "Description": "The source of the logs to forward. Supported values are 'container', 'application', 'ingress', 'worker', 'storage', and 'kubernetes'. This argument supports a comma separated list of log sources. If you do not provide a log source, logs for 'container' and 'ingress' are forwarded.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The log forwarding protocol that you want to use. The only supported value is 'syslog'.", "HasValue": true, "Hidden": false }, { "Name": "syslog-protocol", "Description": "When the logging type is 'syslog', the transport layer protocol. Supported values are 'tls', 'tcp' and the default 'udp'. When forwarding to an rsyslog server with the UDP protocol, logs that are over 1KB are truncated.", "HasValue": true, "Hidden": false }, { "Name": "ca-cert", "Description": "When the logging type is 'syslog' and the protocol is tls, the Kubernetes secret name that contains the Certificate Authority certificate.", "HasValue": true, "Hidden": false }, { "Name": "verify-mode", "Description": "When the logging type is 'syslog' and the protocol is tls, the verification mode. Supported values are 'verify-peer' and the default 'verify-none'.", "HasValue": true, "Hidden": false }, { "Name": "hostname", "Description": "When logging type is 'syslog', the hostname or IP address of the log collector. When logging type is 'ibm' (deprecated), the logging ingest endpoint. If you do not provide the logging ingest endpoint, then the current region's endpoint is used.", "HasValue": true, "Hidden": false }, { "Name": "port", "Description": "The port of the log collector. If you do not specify a port, the default port for the ingestion endpoint is used for 'ibm' (deprecated) and '514' is used for 'syslog'.", "HasValue": true, "Hidden": false }, { "Name": "org", "Description": "::deprecated::The org name to send logs to. This flag is only valid when the logging type is 'ibm'. The org name is required when you specify a space name. If you do not specify a space name, then logs are forwarded at the account level.", "HasValue": true, "Hidden": false }, { "Name": "space", "Description": "::deprecated::The space name to send logs to. This flag is only valid when the logging type is 'ibm'. The space name is required when you specify an org name. If you do not specify a space name, then logs are forwarded at the account level.", "HasValue": true, "Hidden": false }, { "Name": "skip-validation", "Description": "Skips validation of the org and space names when they are specified. This can result in a broken logging config if the values are invalid but will take less time to process.", "HasValue": true, "Hidden": false }, { "Name": "app-containers", "Description": "Specify the containers that you want to collect logs for. To specify more than one path, use multiple flags, such as '-C container1 -C container2'. This option is required for the 'application' log source. If not provided, logs are collected from all containers from the application log paths passed in.", "HasValue": true, "Hidden": false }, { "Name": "C, app-container", "Description": "Specify the containers that you want to collect logs for. To specify more than one path, use multiple flags, such as '-C container1 -C container2'. This option is required for the 'application' log source. If not provided, logs are collected from all containers from the application log paths passed in.", "HasValue": true, "Hidden": false }, { "Name": "app-paths", "Description": "Specify the absolute file path to collect logs from inside the container. To specify more than one path, use multiple flags, such as `-p path1 -p path2`. Required parameter when specifying 'application' for the log source. Wildcards such as '/var/log/*.log' are accepted but recursive globs such are '/var/log/**/test.log' are not.", "HasValue": true, "Hidden": false }, { "Name": "p, app-path", "Description": "Specify the absolute file path to collect logs from inside the container. To specify more than one path, use multiple flags, such as `-p path1 -p path2`. Required parameter when specifying 'application' for the log source. Wildcards such as '/var/log/*.log' are accepted but recursive globs such are '/var/log/**/test.log' are not.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging config", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a log forwarding configuration from a cluster.", "Usage": "ibmcloud ks logging config rm --cluster CLUSTER [--force-update] [-q] (--all | --id ID | --namespace NAMESPACE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The namespace you want to remove the log forwarding configuration from. If there is more than one config for the same namespace, use the '--id \u003clogging configuration ID\u003e' flag instead.", "HasValue": true, "Hidden": false }, { "Name": "id", "Description": "Specify the ID of the logging configuration.", "HasValue": true, "Hidden": false }, { "Name": "all", "Description": "Remove all log forwarding configurations.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging config", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks logging config help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging filter", "Name": "create", "Alias": "", "Aliases": null, "Description": "Filter out logs that are forwarded by your logging configuration.", "Usage": "ibmcloud ks logging filter create --cluster CLUSTER [--container CONTAINER] [--force-update] [--lc LOGGING-CONFIG ...] [--level LEVEL] [--namespace NAMESPACE] [--output OUTPUT] [-q] [--type TYPE] (--message MESSAGE | --regex-message MESSAGE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The type of logs that you want to apply the filter to. Currently all, container, and host are supported.", "HasValue": true, "Hidden": false }, { "Name": "logging-configs", "Description": "A comma separated list of your logging configuration IDs. If not provided, the filter is applied to all the cluster logging configurations that are passed to the filter. You can view log configurations that match the filter by using the --show-matching-configs flag with the command.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The Kubernetes namespace from which you want to filter logs.", "HasValue": true, "Hidden": false }, { "Name": "container", "Description": "The name of the container from which you want to filter out logs. This flag applies only when you are using log type container.", "HasValue": true, "Hidden": false }, { "Name": "level", "Description": "Filters out logs that are at the specified level and less. Acceptable values in their canonical order are fatal, error, warn/warning, info, debug, and trace. As an example, if you filtered logs at the info level, debug, and trace are also filtered. **Note**: You can use this flag only when log messages are in JSON format and contain a level field. Example output: {\"log\": \"hello\", \"level\": \"info\"}", "HasValue": true, "Hidden": false }, { "Name": "message", "Description": "Filters out any logs that contain a specified message anywhere in the log. The message is matched literally and not as an expression. Example: The messages \"Hello\", \"!\", and \"Hello, World!\", would apply to the log \"Hello, World!\".", "HasValue": true, "Hidden": false }, { "Name": "regex-message", "Description": "Filters out any logs that contain a specified message regex pattern in the log. The message is matched as a regular expression. Example: The pattern \"hello [0-9]\" would apply to \"hello 1\", \"hello 2\", \"hello 9\"", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "lc, logging-config", "Description": "A logging configuration ID. If not provided, the filter is applied to all the cluster logging configurations that are passed to the filter. You can view log configurations that match the filter by using the --show-matching-configs flag with the command.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging filter", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update a logging filter.", "Usage": "ibmcloud ks logging filter update --cluster CLUSTER --id ID [--container CONTAINER] [--force-update] [--lc LOGGING-CONFIG ...] [--level LEVEL] [--namespace NAMESPACE] [--output OUTPUT] [-q] [--type TYPE] (--message MESSAGE | --regex-message MESSAGE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "id", "Description": "Specify the ID of the logging filter.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The type of logs that you want to apply the filter to. Currently all, container, and host are supported.", "HasValue": true, "Hidden": false }, { "Name": "logging-configs", "Description": "A comma separated list of your logging configuration IDs. If not provided, the filter is applied to all the cluster logging configurations that are passed to the filter. You can view log configurations that match the filter by using the --show-matching-configs flag with the command.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The Kubernetes namespace from which you want to filter logs.", "HasValue": true, "Hidden": false }, { "Name": "container", "Description": "The name of the container from which you want to filter out logs. This flag applies only when you are using log type container.", "HasValue": true, "Hidden": false }, { "Name": "level", "Description": "Filters out logs that are at the specified level and less. Acceptable values in their canonical order are fatal, error, warn/warning, info, debug, and trace. As an example, if you filtered logs at the info level, debug, and trace are also filtered. **Note**: You can use this flag only when log messages are in JSON format and contain a level field. Example output: {\"log\": \"hello\", \"level\": \"info\"}", "HasValue": true, "Hidden": false }, { "Name": "message", "Description": "Filters out any logs that contain a specified message anywhere in the log. The message is matched literally and not as an expression. Example: The messages \"Hello\", \"!\", and \"Hello, World!\", would apply to the log \"Hello, World!\".", "HasValue": true, "Hidden": false }, { "Name": "regex-message", "Description": "Filters out any logs that contain a specified message regex pattern in the log. The message is matched as a regular expression. Example: The pattern \"hello [0-9]\" would apply to \"hello 1\", \"hello 2\", \"hello 9\"", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "lc, logging-config", "Description": "A logging configuration ID. If not provided, the filter is applied to all the cluster logging configurations that are passed to the filter. You can view log configurations that match the filter by using the --show-matching-configs flag with the command.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging filter", "Name": "get", "Alias": "", "Aliases": null, "Description": "View a logging filter configuration.", "Usage": "ibmcloud ks logging filter get --cluster CLUSTER [--id ID] [--output OUTPUT] [-q] [--show-covering-filters] [--show-matching-configs]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "id", "Description": "Specify the ID of the logging filter.", "HasValue": true, "Hidden": false }, { "Name": "show-matching-configs", "Description": "Show the logging configurations that match the configuration that you're viewing.", "HasValue": false, "Hidden": false }, { "Name": "show-covering-filters", "Description": "Show the logging filters that render previous filters obsolete.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging filter", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a logging filter.", "Usage": "ibmcloud ks logging filter rm --cluster CLUSTER [--force-update] [-q] (--all | --id ID)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "id", "Description": "Specify the ID of the logging filter.", "HasValue": true, "Hidden": false }, { "Name": "all", "Description": "Delete all log forwarding filters.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Force an update of the Fluentd pods in the cluster to the latest version.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging filter", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks logging filter help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging autoupdate", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable automatic updates of all Fluentd pods in a cluster.", "Usage": "ibmcloud ks logging autoupdate disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging autoupdate", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable automatic updates of all Fluentd pods in a cluster.", "Usage": "ibmcloud ks logging autoupdate enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging autoupdate", "Name": "get", "Alias": "", "Aliases": null, "Description": "View whether your Fluentd pods are set to automatically update in a cluster.", "Usage": "ibmcloud ks logging autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging autoupdate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks logging autoupdate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks logging", "Name": "collect", "Alias": "", "Aliases": null, "Description": "This command is no longer supported.", "Usage": "ibmcloud ks logging collect [--cluster CLUSTER] [--cos-bucket BUCKET] [--cos-endpoint ENDPOINT] [--hmac-key KEY] [--hmac-key-id ID] [-q] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "cos-bucket", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "cos-endpoint", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "hmac-key-id", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "hmac-key", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks logging", "Name": "collect-status", "Alias": "", "Aliases": null, "Description": "This command is no longer supported.", "Usage": "ibmcloud ks logging collect-status [--cluster CLUSTER] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks logging", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks logging help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "messages", "Alias": "", "Aliases": null, "Description": "View the current user messages.", "Usage": "ibmcloud ks messages [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks quota", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all quota and limits for cluster-related resources in your IBM Cloud account.", "Usage": "ibmcloud ks quota ls [--output OUTPUT] [--provider PROVIDER] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks quota", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks quota help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks script", "Name": "update", "Alias": "", "Aliases": null, "Description": "Rewrite scripts that call IBM Cloud Kubernetes Service plug-in commands. Legacy-structured commands are replaced with beta-structured commands.", "Usage": "ibmcloud ks script update [--in-place] FILE [FILE ...]", "Flags": [ { "Name": "version", "Description": "The version of the CLI to update a script to.", "HasValue": true, "Hidden": false }, { "Name": "in-place", "Description": "Rewrite the source file with the updated command structure.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks script", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks script help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "subnets", "Alias": "", "Aliases": null, "Description": "List available portable subnets in your IBM Cloud infrastructure account.", "Usage": "ibmcloud ks subnets --provider PROVIDER [-l LOCATION ...] [--output OUTPUT] [-q] [--vpc-id ID] [--zone ZONE]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "Required for provider types 'vpc-classic' and 'vpc-gen2': The ID of the VPC to list subnets for. To list VPC IDs, run 'ibmcloud ks vpcs'.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Required for provider types 'vpc-classic' and 'vpc-gen2': The zone to list VPC subnets for. To list available zones, run 'ibmcloud ks zone ls --provider vpc-classic|vpc-gen2'.", "HasValue": true, "Hidden": false }, { "Name": "l, location", "Description": "A location to filter for. To list available locations, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "webhook-create", "Alias": "", "Aliases": null, "Description": "Register a webhook in a cluster.", "Usage": "ibmcloud ks webhook-create --cluster CLUSTER --type TYPE --url URL [--level LEVEL] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The type of webhook that you want to use. Currently 'slack' is supported.", "HasValue": true, "Hidden": false }, { "Name": "url", "Description": "The webhook URL.", "HasValue": true, "Hidden": false }, { "Name": "level", "Description": "Set the notification level. Accepted values are 'Normal' or 'Warning'. The default is 'Warning'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "vpcs", "Alias": "", "Aliases": null, "Description": "List all VPCs in the targeted resource group. If no resource group is targeted, all VPCs in the account are listed.", "Usage": "ibmcloud ks vpcs [--output OUTPUT] [--provider PROVIDER] [-q]", "Flags": [ { "Name": "provider", "Description": "The VPC infrastructure provider type. Supported values are 'vpc-classic' and 'vpc-gen2'. By default, VPCs of all provider types are returned.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all VPCs in the targeted resource group. If no resource group is targeted, all VPCs in the account are listed.", "Usage": "ibmcloud ks vpc ls [--output OUTPUT] [--provider PROVIDER] [-q]", "Flags": [ { "Name": "provider", "Description": "The VPC infrastructure provider type. Supported values are 'vpc-classic' and 'vpc-gen2'. By default, VPCs of all provider types are returned.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc outbound-traffic-protection", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable outbound traffic protection for a Secure By Default VPC cluster.", "Usage": "ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc outbound-traffic-protection", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable outbound traffic protection for a Secure By Default VPC cluster.", "Usage": "ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc outbound-traffic-protection", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks vpc outbound-traffic-protection help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc secure-by-default", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable Secure By Default VPC Networking for a VPC cluster using legacy Security Groups.", "Usage": "ibmcloud ks vpc secure-by-default enable --cluster CLUSTER [--disable-outbound-traffic-protection] [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "disable-outbound-traffic-protection", "Description": "Include this option to allow public outbound access from the cluster workers. By default, public outbound access is blocked.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc secure-by-default", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks vpc secure-by-default help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks vpc", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks vpc help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "flavors", "Alias": "", "Aliases": null, "Description": "List available flavors for a zone.", "Usage": "ibmcloud ks flavors --zone ZONE [--output OUTPUT] [--provider PROVIDER] [-q] [--show-os] [--show-storage]", "Flags": [ { "Name": "zone", "Description": "Specify the zone to list available flavors for. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "show-storage", "Description": "Show additional storage drives.", "HasValue": false, "Hidden": false }, { "Name": "show-os", "Description": "List supported operating systems.", "HasValue": false, "Hidden": false }, { "Name": "provider", "Description": "The provider type to get the flavors for.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks flavor", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the information of a flavor for a zone and provider.", "Usage": "ibmcloud ks flavor get --flavor FLAVOR --provider PROVIDER --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "zone", "Description": "Specify the zone to list available flavors for. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Specify a provider. Available options are `classic`, `vpc-classic` and `vpc-gen2`.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks flavor", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List available flavors for a zone.", "Usage": "ibmcloud ks flavor ls --zone ZONE [--output OUTPUT] [--provider PROVIDER] [-q] [--show-os] [--show-storage]", "Flags": [ { "Name": "zone", "Description": "Specify the zone to list available flavors for. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "show-storage", "Description": "Show additional storage drives.", "HasValue": false, "Hidden": false }, { "Name": "show-os", "Description": "List supported operating systems.", "HasValue": false, "Hidden": false }, { "Name": "provider", "Description": "The provider type to get the flavors for.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks flavor", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks flavor help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "addon-versions", "Alias": "", "Aliases": null, "Description": "List supported versions for managed add-ons. To enable add-ons, use the 'ibmcloud ks cluster addon enable \u003caddon\u003e' command.", "Usage": "ibmcloud ks addon-versions [--addon ADDON] [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "addon", "Description": "Specify an add-on name to filter versions for.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "albs", "Alias": "", "Aliases": null, "Description": "List all Ingress ALB IDs in a cluster and whether ALB pods are at the latest version.", "Usage": "ibmcloud ks albs --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb", "Name": "types", "Alias": "", "Aliases": null, "Description": "List Ingress ALB types that are supported in the region.", "Usage": "ibmcloud ks alb types [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb", "Name": "versions", "Alias": "", "Aliases": null, "Description": "List Ingress ALB image versions that are available.", "Usage": "ibmcloud ks alb versions [--output OUTPUT] [-q] [--region REGION]", "Flags": [ { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Ingress ALB IDs in a cluster and whether ALB pods are at the latest version.", "Usage": "ibmcloud ks alb ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an Ingress ALB in a cluster.", "Usage": "ibmcloud ks alb get --alb-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "alb-id", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb create", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a classic cluster.", "Usage": "ibmcloud ks alb create classic --cluster CLUSTER --type TYPE --vlan VLAN --zone ZONE [-q] [--user-ip IP] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The zone where you want to create the ALB.", "HasValue": true, "Hidden": false }, { "Name": "vlan", "Description": "The VLAN ID. This VLAN must match the ALB 'type' and must be in the same 'zone' as the ALB that you want to create.", "HasValue": true, "Hidden": false }, { "Name": "user-ip", "Description": "Specify a portable public or private IP address that is available on the 'vlan' and in the 'zone' of the ALB to be created or configured.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb create", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a VPC Gen 1 cluster.", "Usage": "ibmcloud ks alb create vpc-classic --cluster CLUSTER --type TYPE --zone ZONE [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The zone where you want to create the ALB.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb create", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a VPC Gen 2 cluster.", "Usage": "ibmcloud ks alb create vpc-gen2 --cluster CLUSTER --type TYPE --zone ZONE [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The zone where you want to create the ALB.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb create", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb create help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks alb configure", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Enable or disable an Ingress ALB in a classic cluster.", "Usage": "ibmcloud ks alb configure classic --alb-id ID [-q] [--user-ip IP] [--version VERSION] (--disable | --disable-deployment | --enable)", "Flags": [ { "Name": "alb-id", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "enable", "Description": "Enable an ALB for the cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "disable", "Description": "Disable an ALB for the cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "disable-deployment", "Description": "Disable the ALB deployment only. If provided, the ALB deployment is deleted but the IBM-provided Ingress subdomain remains. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "user-ip", "Description": "Specify a portable public or private IP address that is available on the 'vlan' and in the 'zone' of the ALB to be created or configured.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb configure", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Enable or disable an Ingress ALB in a VPC Gen 1 cluster.", "Usage": "ibmcloud ks alb configure vpc-classic --alb-id ID [-q] [--version VERSION] (--disable | --enable)", "Flags": [ { "Name": "alb-id", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "enable", "Description": "Enable an ALB for the VPC cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "disable", "Description": "Disable an ALB for the VPC cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb configure", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Enable or disable an Ingress ALB in a VPC Gen 2 cluster.", "Usage": "ibmcloud ks alb configure vpc-gen2 --alb-id ID [-q] [--version VERSION] (--disable | --enable)", "Flags": [ { "Name": "alb-id", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "enable", "Description": "Enable an ALB for the VPC cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "disable", "Description": "Disable an ALB for the VPC cluster. Must include either '--enable', '--disable', or '--disable-deployment' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb configure", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb configure help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks alb", "Name": "rollback", "Alias": "", "Aliases": null, "Description": "Roll back the Ingress ALB add-on to the previous build. All ALB pods in your cluster revert to their previously running state.", "Usage": "ibmcloud ks alb rollback --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb", "Name": "update", "Alias": "", "Aliases": null, "Description": "Force a one-time update of the pods for individual or all ALBs in the cluster.", "Usage": "ibmcloud ks alb update --cluster CLUSTER [--alb-id ID ...] [--output OUTPUT] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "[Beta] Specify the ALB image version. To see supported image versions, run 'ibmcloud ks alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "alb-id", "Description": "To update a specific ALB, specify the ALB ID. To see available ALB IDs, run 'ibmcloud ks alb ls'. To update more than one ALB, specify one ALB ID in each flag, such as '--alb-id ID_1 --alb-id ID_2'. To update all ALBs, do not include this flag.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb autoupdate", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable automatic updates of all Ingress ALB pods in a cluster.", "Usage": "ibmcloud ks alb autoupdate disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb autoupdate", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable automatic updates of all Ingress ALB pods in a cluster.", "Usage": "ibmcloud ks alb autoupdate enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb autoupdate", "Name": "get", "Alias": "", "Aliases": null, "Description": "View whether the Ingress ALB pods in a cluster are set to automatically update and whether ALB pods are at the latest version.", "Usage": "ibmcloud ks alb autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb autoupdate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb autoupdate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks alb", "Name": "certs", "Alias": "", "Aliases": null, "Description": "List all Ingress ALB certificates available in the cluster.", "Usage": "ibmcloud ks alb certs --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb cert", "Name": "deploy", "Alias": "", "Aliases": null, "Description": "Deploy or update a certificate from IBM Cloud Certificate Manager to the Ingress ALB.", "Usage": "ibmcloud ks alb cert deploy --cert-crn CRN --cluster CLUSTER --secret-name NAME [-q] [--update]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "secret-name", "Description": "Specify a name for the ALB secret when it is created in the cluster. This value is required.", "HasValue": true, "Hidden": false }, { "Name": "cert-crn", "Description": "Specify the certificate CRN.", "HasValue": true, "Hidden": false }, { "Name": "update", "Description": "Update the existing ALB certificate secret for the cluster.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb cert", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove an Ingress ALB certificate from a cluster.", "Usage": "ibmcloud ks alb cert rm --cluster CLUSTER [-q] (--cert-crn CRN | --secret-name NAME)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "secret-name", "Description": "Specify a name for the ALB secret when it is created in the cluster. This value is required. Must include either '--secret-name' or '--cert-crn' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "cert-crn", "Description": "Specify the certificate CRN. Must include either '--secret-name' or '--cert-crn' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb cert", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an Ingress ALB certificate in a cluster.", "Usage": "ibmcloud ks alb cert get --cluster CLUSTER [--output OUTPUT] [-q] (--cert-crn CRN | --secret-name NAME)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "secret-name", "Description": "Specify a name for the ALB secret when it is created in the cluster. This value is required. Must include either '--secret-name' or '--cert-crn' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "cert-crn", "Description": "Specify the certificate CRN. Must include either '--secret-name' or '--cert-crn' in the command, but must not include more than one flag.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb cert", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Ingress ALB certificates available in the cluster.", "Usage": "ibmcloud ks alb cert ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb cert", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb cert help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks alb migrate", "Name": "start", "Alias": "", "Aliases": null, "Description": "Start a migration of your IBM Cloud Ingress configmap and resources to use with ALBs that run the Kubernetes Ingress image. This command does not change the image type of your ALBs. For more info, see 'https://ibm.biz/ingress-migrate'", "Usage": "ibmcloud ks alb migrate start --cluster CLUSTER [-f] [-q] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "Specify the migration type.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb migrate", "Name": "status", "Alias": "", "Aliases": null, "Description": "Get the status of the migration process.", "Usage": "ibmcloud ks alb migrate status --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb migrate", "Name": "clean", "Alias": "", "Aliases": null, "Description": "Clean up any resources and ConfigMaps that you no longer need, such as after an Ingress migration.", "Usage": "ibmcloud ks alb migrate clean --cluster CLUSTER [-f] [--generated-resources] [--iks-ingresses] [--kube-ingresses] [--output OUTPUT] [-q] [--reset-kube-controller-configmap] [--test-ingresses]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "generated-resources", "Description": "Delete all resources that were automatically generated during an Ingress migration, including the Ingress resources and ConfigMaps listed in the Migrated to sections in the output of ibmcloud ks ingress alb migrate status.", "HasValue": false, "Hidden": false }, { "Name": "test-ingresses", "Description": "Delete automatically generated and manually created Ingress resources of class test for the test ALB service running the Kubernetes Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "kube-ingresses", "Description": "Delete automatically generated and manually created Ingress resources of class public-iks-k8s-nginx or private-iks-k8s-nginx for public or private ALBs that run the Kubernetes Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "iks-ingresses", "Description": "Delete Ingress resources of class iks-nginx, class nginx, or of no class for public or private ALBs that run the IBM Cloud Kubernetes Service Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "reset-kube-controller-configmap", "Description": "Reset the ibm-k8s-controller-config ConfigMap to the default settings. The ConfigMap is deleted and re-deployed.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks alb migrate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb migrate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks alb", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks alb help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "clusters", "Alias": "", "Aliases": null, "Description": "List all clusters in your IBM Cloud account.", "Usage": "ibmcloud ks clusters [-l LOCATION ...] [--output OUTPUT] [--provider PROVIDER] [-q]", "Flags": [ { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format. If you do not include the provider flag, only classic clusters are returned.", "HasValue": true, "Hidden": false }, { "Name": "l, location", "Description": "A location to filter for. To list available locations, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster create", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Create a cluster with worker nodes on classic infrastructure.", "Usage": "ibmcloud ks cluster create classic --flavor FLAVOR --name NAME --zone ZONE [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--hardware HARDWARE] [--location LOCATION] [--no-subnet] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--private-service-endpoint] [--private-service-endpoint-allowlist] [--private-vlan VLAN] [--public-service-endpoint] [-q] [--service-subnet SUBNET] [--skip-advance-permissions-check] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT] (--private-only | --public-vlan VLAN)", "Flags": [ { "Name": "name", "Description": "Enter a name for the cluster.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Conditional: Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'. If you do not have a private VLAN yet, do not specify this option because one will be automatically created for you. When you specify a private VLAN, you must also specify either the '--public-vlan' flag or the '--private-only' flag.", "HasValue": true, "Hidden": false }, { "Name": "public-vlan", "Description": "Conditional: Specify the ID of the public VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'. If you do not have a public VLAN yet, do not specify this option because one will be automatically created for you.", "HasValue": true, "Hidden": false }, { "Name": "private-only", "Description": "Use this flag to prevent a public VLAN from being created. Required only when you specify the '--private-vlan' flag without specifying the '--public-vlan' flag.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of cluster worker nodes. Defaults to 1.", "HasValue": true, "Hidden": false }, { "Name": "hardware", "Description": "The level of hardware isolation for your worker node. Use 'dedicated' to have available physical resources dedicated to you only, or 'shared' to allow physical resources to be shared with other IBM customers. For IBM Cloud Public accounts, the default value is shared. For IBM Cloud Dedicated accounts, dedicated is the only available option.", "HasValue": true, "Hidden": false }, { "Name": "no-subnet", "Description": "Prevent the creation of a portable subnet when creating the cluster. By default, both a public and a private portable subnet are created on the associated VLAN, and this flag prevents that behavior. To add a subnet to the cluster later, run 'ibmcloud ks cluster subnet add'.", "HasValue": false, "Hidden": false }, { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least '/23' or larger. For more info, see 'https://ibm.biz/cluster-create-classic'", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least '/24' or larger. For more info, see 'https://ibm.biz/cluster-create-classic'. Default value: '172.21.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "disable-disk-encrypt", "Description": "Disable encryption on a worker node.", "HasValue": false, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "file", "Description": "Provide a file that contains input parameters in YAML format.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "::deprecated::Flag maintained for compatibility with an earlier version. Use the '--zone' flag instead.", "HasValue": true, "Hidden": false }, { "Name": "public-service-endpoint", "Description": "Enable the public service endpoint to make the master publicly accessible.", "HasValue": false, "Hidden": false }, { "Name": "private-service-endpoint", "Description": "Enable the private service endpoint to make the master privately accessible.", "HasValue": false, "Hidden": false }, { "Name": "private-service-endpoint-allowlist", "Description": "::deprecated::Enable access control to a cluster master via a private service endpoint allowlist. For more info, see 'https://ibm.biz/se_allowlist'.", "HasValue": false, "Hidden": false }, { "Name": "skip-advance-permissions-check", "Description": "Skip checking for infrastructure permissions before completing this action. Note that if you do not have the correct infrastructure permissions, this action might only partially succeed.", "HasValue": false, "Hidden": false }, { "Name": "sm-instance", "Description": "The CRN of the IBM Cloud Secrets Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "sm-group", "Description": "The Secret Group ID of the IBM Cloud Secrets Manager instance where your secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "trusted-profile-id", "Description": "The trusted profile ID to create the cluster with.", "HasValue": true, "Hidden": false }, { "Name": "machine-type", "Description": "The flavor of the worker node. To see available flavors, run 'ibmcloud ks machine-types --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks machine-types' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the Kubernetes or OpenShift version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "kube-version", "Description": "Specify the Kubernetes version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster create", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Create a cluster with worker nodes on Virtual Private Cloud (VPC) Gen 1 infrastructure.", "Usage": "ibmcloud ks cluster create vpc-classic --flavor FLAVOR --name NAME --subnet-id ID --vpc-id ID --zone ZONE [--disable-public-service-endpoint] [--entitlement ENTITLEMENT] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--private-service-endpoint-allowlist] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT]", "Flags": [ { "Name": "name", "Description": "Enter a name for the cluster.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "The ID of the VPC in which to create the worker nodes. To list available IDs, run 'ibmcloud ks vpcs'.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "The VPC subnet to assign the cluster. To list available subnets, run 'ibmcloud ks subnets --provider vpc-classic --vpc-id \u003cvpc-id\u003e --zone \u003cvpc-zone\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least '/24' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'. Default value: '172.21.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least '/23' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of worker nodes per zone in the default worker pool. For OpenShift clusters, you must set this value to at least 2. For Kubernetes clusters, this value is optional.", "HasValue": true, "Hidden": false }, { "Name": "private-service-endpoint-allowlist", "Description": "::deprecated::Enable access control to a cluster master via a private service endpoint allowlist. For more info, see 'https://ibm.biz/se_allowlist'.", "HasValue": false, "Hidden": false }, { "Name": "disable-public-service-endpoint", "Description": "Disable the public service endpoint to prevent public access to the master.", "HasValue": false, "Hidden": false }, { "Name": "sm-instance", "Description": "The CRN of the IBM Cloud Secrets Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "sm-group", "Description": "The Secret Group ID of the IBM Cloud Secrets Manager instance where your secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "trusted-profile-id", "Description": "The trusted profile ID to create the cluster with.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the Kubernetes or OpenShift version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "kube-version", "Description": "Specify the Kubernetes version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster create", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Create a cluster with worker nodes on Virtual Private Cloud (VPC) Gen 2 infrastructure.", "Usage": "ibmcloud ks cluster create vpc-gen2 --flavor FLAVOR --name NAME --subnet-id ID --vpc-id ID --zone ZONE [--cluster-security-group GROUP ...] [--cos-instance INSTANCE] [--crk CRK] [--disable-outbound-traffic-protection] [--disable-public-service-endpoint] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance INSTANCE] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--private-service-endpoint-allowlist] [-q] [--secondary-storage STORAGE] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT]", "Flags": [ { "Name": "name", "Description": "Enter a name for the cluster.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "The ID of the VPC in which to create the worker nodes. To list available IDs, run 'ibmcloud ks vpcs'.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "The VPC subnet to assign the cluster. To list available subnets, run 'ibmcloud ks subnets --provider vpc-gen2 --vpc-id \u003cvpc-id\u003e --zone \u003cvpc-zone\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "secondary-storage", "Description": "The secondary storage option for the flavor. To view the secondary storage options that are available for a flavor, run 'ibmcloud ks flavor get --provider vpc-gen2 --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "cos-instance", "Description": "Required for OpenShift clusters only. The CRN for the standard cloud object storage instance to back up the internal registry in your OpenShift cluster. To list the CRNs of your cloud object storage instances, run 'ibmcloud resource service-instances --long --service-name cloud-object-storage'.", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least '/24' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'. Default value: '172.21.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "cluster-security-group", "Description": "Optional. Specify one or more security group IDs to apply to all workers on the cluster. For OpenShift version 4.15 and Kubernetes version 1.30 and later, these security groups are applied in addition to the IBM-managed 'kube-clusterID' security group. For earlier cluster versions, specify the '--cluster-security-group cluster' option to apply the 'kube-clusterID' security group. If no value is specified, a default set of security groups including 'kube-clusterID' are applied.", "HasValue": true, "Hidden": false }, { "Name": "disable-outbound-traffic-protection", "Description": "Include this option to allow public outbound access from the cluster workers. By default, public outbound access is blocked in OpenShift versions 4.15 and later and Kubernetes versions 1.30 and later.", "HasValue": false, "Hidden": false }, { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least '/23' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of worker nodes per zone in the default worker pool. For OpenShift clusters, you must set this value to at least 2. For Kubernetes clusters, this value is optional.", "HasValue": true, "Hidden": false }, { "Name": "private-service-endpoint-allowlist", "Description": "::deprecated::Enable access control to a cluster master via a private service endpoint allowlist. For more info, see 'https://ibm.biz/se_allowlist'.", "HasValue": false, "Hidden": false }, { "Name": "disable-public-service-endpoint", "Description": "Disable the public service endpoint to prevent public access to the master.", "HasValue": false, "Hidden": false }, { "Name": "sm-instance", "Description": "The CRN of the IBM Cloud Secrets Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "sm-group", "Description": "The Secret Group ID of the IBM Cloud Secrets Manager instance where your secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "kms-instance", "Description": "The ID of the KMS instance to use for local disk encryption. To list available KMS instances, run 'ibmcloud ks kms instance ls'.", "HasValue": true, "Hidden": false }, { "Name": "crk", "Description": "The ID of the root key in your KMS instance to use for local disk encryption. To list available root keys, run 'ibmcloud ks kms crk ls --instance-id \u003ckms_instance\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "dedicated-host-pool", "Description": "The ID of the dedicated host pool to run your workers.", "HasValue": true, "Hidden": false }, { "Name": "kms-account-id", "Description": "The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.", "HasValue": true, "Hidden": false }, { "Name": "preview", "Description": "Optional. Specify one or more cluster level preview features.", "HasValue": true, "Hidden": false }, { "Name": "trusted-profile-id", "Description": "The trusted profile ID to create the cluster with.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the Kubernetes or OpenShift version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "kube-version", "Description": "Specify the Kubernetes version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster create", "Name": "vpc-gz", "Alias": "", "Aliases": null, "Description": "Create a cluster in your Virtual Private Cloud (VPC) with Hyper Protect virtual servers.", "Usage": "ibmcloud ks cluster create vpc-gz --flavor FLAVOR --name NAME --subnet-id ID --vpc-id ID --zone ZONE [--disable-public-service-endpoint] [--entitlement ENTITLEMENT] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--private-service-endpoint-allowlist] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT]", "Flags": [ { "Name": "name", "Description": "Enter a name for the cluster.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "The ID of the VPC in which to create the worker nodes. To list available IDs, run 'ibmcloud ks vpcs'.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "The VPC subnet to assign the cluster. To list available subnets, run 'ibmcloud ks subnets --provider vpc-classic --vpc-id \u003cvpc-id\u003e --zone \u003cvpc-zone\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least '/24' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'. Default value: '172.21.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least '/23' or larger. For more info, see 'https://ibm.biz/cluster-create-vpc'", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of worker nodes per zone in the default worker pool. For OpenShift clusters, you must set this value to at least 2. For Kubernetes clusters, this value is optional.", "HasValue": true, "Hidden": false }, { "Name": "private-service-endpoint-allowlist", "Description": "::deprecated::Enable access control to a cluster master via a private service endpoint allowlist. For more info, see 'https://ibm.biz/se_allowlist'.", "HasValue": false, "Hidden": false }, { "Name": "disable-public-service-endpoint", "Description": "Disable the public service endpoint to prevent public access to the master.", "HasValue": false, "Hidden": false }, { "Name": "sm-instance", "Description": "The CRN of the IBM Cloud Secrets Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "sm-group", "Description": "The Secret Group ID of the IBM Cloud Secrets Manager instance where your secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "trusted-profile-id", "Description": "The trusted profile ID to create the cluster with.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the Kubernetes or OpenShift version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "kube-version", "Description": "Specify the Kubernetes version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks cluster create", "Name": "satellite", "Alias": "", "Aliases": null, "Description": "Create an IBM Cloud Satellite cluster on your own infrastructure.", "Usage": "ibmcloud ks cluster create satellite --location LOCATION --name NAME --version VERSION [--enable-config-admin] [--entitlement ENTITLEMENT] [--host-label LABEL ...] [--infrastructure-topology TOPOLOGY] [--operating-system SYSTEM] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--pull-secret SECRET] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--workers COUNT] [--zone ZONE]", "Flags": [ { "Name": "host-label, hl", "Description": "Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run 'ibmcloud sat host get --host \u003chost_name_or_ID\u003e --location \u003clocation_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Enter a name for the cluster.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "The Red Hat OpenShift on IBM Cloud version, including at least the major.minor version. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "enable-config-admin", "Description": "Grant cluster 'admin' access to Satellite Config to manage Kubernetes resources.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The zone for the default worker pool in a multizone cluster. To list zones for your location, run 'ibmcloud sat location get'.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of worker nodes per zone in the default worker pool. Required when '--host-label' is specified.", "HasValue": true, "Hidden": false }, { "Name": "pod-network-interface-selection", "Description": "The method for selecting the node network interface for the internal pod network. This option can be used only if the Satellite location that you specify has Red Hat CoreOS enabled. To provide a direct URL or IP address, specify `can-reach=\u003curl\u003e` or `can-reach=\u003cip_address\u003e`. To choose a network interface, specify 'interface=\u003cnetwork_interface\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least '/24' or larger. For more info, see 'https://ibm.biz/cluster-create-satellite'. Default value: '172.21.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least '/23' or larger. For more info, see 'https://ibm.biz/cluster-create-satellite'. Default value: '172.30.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "infrastructure-topology", "Description": "Specify whether the cluster should run a single worker node or the default number of worker nodes. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default.", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "pull-secret", "Description": "Specify an existing OpenShift entitlement for this cluster's worker nodes by providing your Red Hat account pull secret.", "HasValue": true, "Hidden": false }, { "Name": "sm-instance", "Description": "The CRN of the IBM Cloud Secrets Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "sm-group", "Description": "The Secret Group ID of the IBM Cloud Secrets Manager instance where your secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "trusted-profile-id", "Description": "The trusted profile ID to create the cluster with.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster create", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster create help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "config", "Alias": "", "Aliases": null, "Description": "Download the Kubernetes configuration files and certificates to connect to your cluster by using kubectl commands.", "Usage": "ibmcloud ks cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT] [--network] [--output OUTPUT] [-q] [--skip-rbac]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "admin", "Description": "Retrieve administrator certificates and PEM keys.", "HasValue": false, "Hidden": false }, { "Name": "network", "Description": "Retrieve the Calico network config with the Admin config.", "HasValue": false, "Hidden": false }, { "Name": "skip-rbac", "Description": "Skip adding RBAC roles. Include this option only if you manage your own Kubernetes RBAC roles. If you use IAM service access roles to manage all your RBAC users, do not include this option.", "HasValue": false, "Hidden": false }, { "Name": "endpoint", "Description": "The server URL to use for the cluster context. If you do not include this flag, the default cluster service endpoint is used. For more info, see 'https://ibm.biz/context-kube' for Kubernetes or 'https://ibm.biz/context-ocp' for OpenShift clusters.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format and skips 'kubeconfig' merges.", "HasValue": true, "Hidden": false }, { "Name": "yaml", "Description": "Format output in YAML.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a cluster.", "Usage": "ibmcloud ks cluster get --cluster CLUSTER [--output OUTPUT] [-q] [--show-resources]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "show-resources", "Description": "Show additional cluster resources such as add-ons, VLANs, and subnets.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all clusters in your IBM Cloud account.", "Usage": "ibmcloud ks cluster ls [-l LOCATION ...] [--output OUTPUT] [--provider PROVIDER] [-q]", "Flags": [ { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format. If you do not include the provider flag, only classic clusters are returned.", "HasValue": true, "Hidden": false }, { "Name": "l, location", "Description": "A location to filter for. To list available locations, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a cluster. All worker nodes, apps, and containers are permanently deleted. This action cannot be undone.", "Usage": "ibmcloud ks cluster rm --cluster CLUSTER [--delete-openshift-registry-cos-bucket] [--delete-storage] [-f] [-q] [--skip-advance-permissions-check]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts. The cluster's persistent storage is not deleted unless the 'delete-storage' option is also provided. The COS bucket and it's associated service key is not deleted unless the 'delete-openshift-registry-cos-bucket' option is also provided.", "HasValue": false, "Hidden": false }, { "Name": "delete-storage", "Description": "Force the removal of the cluster's persistent storage. Deleted data cannot be recovered.", "HasValue": false, "Hidden": false }, { "Name": "force-delete-storage", "Description": "Force the removal of the cluster's persistent storage. Deleted data cannot be recovered.", "HasValue": false, "Hidden": false }, { "Name": "delete-openshift-registry-cos-bucket", "Description": "Remove the COS bucket and the associated service key that holds the OpenShift registry backups on ROKS clusters", "HasValue": false, "Hidden": false }, { "Name": "skip-advance-permissions-check", "Description": "Skip checking for infrastructure permissions before completing this action. Note that if you do not have the correct infrastructure permissions, this action might only partially succeed.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "addons", "Alias": "", "Aliases": null, "Description": "List enabled add-ons.", "Usage": "ibmcloud ks cluster addons --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "alb-oauth-proxy", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service ALB OAuth Proxy add-on.", "Usage": "ibmcloud ks cluster addon enable alb-oauth-proxy --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "cluster-autoscaler", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Cluster Autoscaler.", "Usage": "ibmcloud ks cluster addon enable cluster-autoscaler --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "ibm-storage-operator", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Storage operator add-on.", "Usage": "ibmcloud ks cluster addon enable ibm-storage-operator --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon enable", "Name": "debug-tool", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Diagnostics and Debug Tool.", "Usage": "ibmcloud ks cluster addon enable debug-tool --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "istio", "Alias": "", "Aliases": null, "Description": "The managed Istio service mesh.", "Usage": "ibmcloud ks cluster addon enable istio --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "istio-extras", "Alias": "", "Aliases": null, "Description": "Extra components for Istio, including Grafana, Jaeger, and Kiali.", "Usage": "ibmcloud ks cluster addon enable istio-extras --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon enable", "Name": "istio-sample-bookinfo", "Alias": "", "Aliases": null, "Description": "The BookInfo sample application for Istio.", "Usage": "ibmcloud ks cluster addon enable istio-sample-bookinfo --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon enable", "Name": "knative", "Alias": "", "Aliases": null, "Description": "The Knative serverless framework.", "Usage": "ibmcloud ks cluster addon enable knative --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "kube-terminal", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service web terminal.", "Usage": "ibmcloud ks cluster addon enable kube-terminal --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "service-catalog", "Alias": "", "Aliases": null, "Description": "The IBM Cloud service catalog.", "Usage": "ibmcloud ks cluster addon enable service-catalog --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "static-route", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service static route add-on.", "Usage": "ibmcloud ks cluster addon enable static-route --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "vpc-block-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC Block Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon enable vpc-block-csi-driver --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "openshift-container-storage", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Container Storage on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon enable openshift-container-storage --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "param", "Description": "Specify installation options for the add-on. If no parameters are specified, the default values are used. Review the available options with the 'ibmcloud ks cluster addon options' command.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "openshift-data-foundation", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Data Foundation on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon enable openshift-data-foundation --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "param", "Description": "Specify installation options for the add-on. If no parameters are specified, the default values are used. Review the available options with the 'ibmcloud ks cluster addon options' command.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "hpcs-router", "Alias": "", "Aliases": null, "Description": "The IBM Cloud HPCS Router Operator add-on for Red Hat OpenShift on IBM Cloud.", "Usage": "ibmcloud ks cluster addon enable hpcs-router --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "image-key-synchronizer", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Image Key Synchronizer add-on.", "Usage": "ibmcloud ks cluster addon enable image-key-synchronizer --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "worker-recovery", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Worker Node Recovery add-on.", "Usage": "ibmcloud ks cluster addon enable worker-recovery --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "csutil", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon enable csutil --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "csutil-experimental", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil-Experimental add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon enable csutil-experimental --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "vpc-file-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC File Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon enable vpc-file-csi-driver --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon enable", "Name": "ibm-object-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Object Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon enable ibm-object-csi-driver --cluster CLUSTER [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon enable", "Name": "openshift-ai", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift AI on IBM Cloud add-on.", "Usage": "ibmcloud ks cluster addon enable openshift-ai --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "param", "Description": "Specify installation options for the add-on. If no parameters are specified, the default values are used. Review the available options with the 'ibmcloud ks cluster addon options' command.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "acm", "Alias": "", "Aliases": null, "Description": "The Red Hat Advanced Cluster Management add-on", "Usage": "ibmcloud ks cluster addon enable acm --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Enable all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "param", "Description": "Specify installation options for the add-on. If no parameters are specified, the default values are used. Review the available options with the 'ibmcloud ks cluster addon options' command.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon enable", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster addon enable help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "alb-oauth-proxy", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service ALB OAuth Proxy add-on.", "Usage": "ibmcloud ks cluster addon update alb-oauth-proxy --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "cluster-autoscaler", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Cluster Autoscaler.", "Usage": "ibmcloud ks cluster addon update cluster-autoscaler --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "ibm-storage-operator", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Storage operator add-on.", "Usage": "ibmcloud ks cluster addon update ibm-storage-operator --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon update", "Name": "debug-tool", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Diagnostics and Debug Tool.", "Usage": "ibmcloud ks cluster addon update debug-tool --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "istio", "Alias": "", "Aliases": null, "Description": "The managed Istio service mesh.", "Usage": "ibmcloud ks cluster addon update istio --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "istio-extras", "Alias": "", "Aliases": null, "Description": "Extra components for Istio, including Grafana, Jaeger, and Kiali.", "Usage": "ibmcloud ks cluster addon update istio-extras --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon update", "Name": "istio-sample-bookinfo", "Alias": "", "Aliases": null, "Description": "The BookInfo sample application for Istio.", "Usage": "ibmcloud ks cluster addon update istio-sample-bookinfo --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon update", "Name": "knative", "Alias": "", "Aliases": null, "Description": "The Knative serverless framework.", "Usage": "ibmcloud ks cluster addon update knative --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "kube-terminal", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service web terminal.", "Usage": "ibmcloud ks cluster addon update kube-terminal --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "service-catalog", "Alias": "", "Aliases": null, "Description": "The IBM Cloud service catalog.", "Usage": "ibmcloud ks cluster addon update service-catalog --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "static-route", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service static route add-on.", "Usage": "ibmcloud ks cluster addon update static-route --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "vpc-block-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC Block Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon update vpc-block-csi-driver --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "openshift-container-storage", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Container Storage on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon update openshift-container-storage --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "openshift-data-foundation", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Data Foundation on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon update openshift-data-foundation --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "hpcs-router", "Alias": "", "Aliases": null, "Description": "The IBM Cloud HPCS Router Operator add-on for Red Hat OpenShift on IBM Cloud.", "Usage": "ibmcloud ks cluster addon update hpcs-router --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "image-key-synchronizer", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Image Key Synchronizer add-on.", "Usage": "ibmcloud ks cluster addon update image-key-synchronizer --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "worker-recovery", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Worker Node Recovery add-on.", "Usage": "ibmcloud ks cluster addon update worker-recovery --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "csutil", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon update csutil --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "csutil-experimental", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil-Experimental add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon update csutil-experimental --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "vpc-file-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC File Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon update vpc-file-csi-driver --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon update", "Name": "ibm-object-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Object Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon update ibm-object-csi-driver --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon update", "Name": "openshift-ai", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift AI on IBM Cloud add-on.", "Usage": "ibmcloud ks cluster addon update openshift-ai --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "acm", "Alias": "", "Aliases": null, "Description": "The Red Hat Advanced Cluster Management add-on", "Usage": "ibmcloud ks cluster addon update acm --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "y", "Description": "Update all add-on dependencies.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the version of the add-on to install. If no version is specified, the default version is installed.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon update", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster addon update help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "alb-oauth-proxy", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service ALB OAuth Proxy add-on.", "Usage": "ibmcloud ks cluster addon disable alb-oauth-proxy --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "cluster-autoscaler", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Cluster Autoscaler.", "Usage": "ibmcloud ks cluster addon disable cluster-autoscaler --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "ibm-storage-operator", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Storage operator add-on.", "Usage": "ibmcloud ks cluster addon disable ibm-storage-operator --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon disable", "Name": "debug-tool", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service Diagnostics and Debug Tool.", "Usage": "ibmcloud ks cluster addon disable debug-tool --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "istio", "Alias": "", "Aliases": null, "Description": "The managed Istio service mesh.", "Usage": "ibmcloud ks cluster addon disable istio --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "istio-extras", "Alias": "", "Aliases": null, "Description": "Extra components for Istio, including Grafana, Jaeger, and Kiali.", "Usage": "ibmcloud ks cluster addon disable istio-extras --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon disable", "Name": "istio-sample-bookinfo", "Alias": "", "Aliases": null, "Description": "The BookInfo sample application for Istio.", "Usage": "ibmcloud ks cluster addon disable istio-sample-bookinfo --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster addon disable", "Name": "knative", "Alias": "", "Aliases": null, "Description": "The Knative serverless framework.", "Usage": "ibmcloud ks cluster addon disable knative --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "kube-terminal", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service web terminal.", "Usage": "ibmcloud ks cluster addon disable kube-terminal --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "service-catalog", "Alias": "", "Aliases": null, "Description": "The IBM Cloud service catalog.", "Usage": "ibmcloud ks cluster addon disable service-catalog --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "static-route", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Kubernetes Service static route add-on.", "Usage": "ibmcloud ks cluster addon disable static-route --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "vpc-block-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC Block Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon disable vpc-block-csi-driver --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "openshift-container-storage", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Container Storage on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon disable openshift-container-storage --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "openshift-data-foundation", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift Data Foundation on IBM Cloud add-on", "Usage": "ibmcloud ks cluster addon disable openshift-data-foundation --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "hpcs-router", "Alias": "", "Aliases": null, "Description": "The IBM Cloud HPCS Router Operator add-on for Red Hat OpenShift on IBM Cloud.", "Usage": "ibmcloud ks cluster addon disable hpcs-router --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "image-key-synchronizer", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Image Key Synchronizer add-on.", "Usage": "ibmcloud ks cluster addon disable image-key-synchronizer --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "worker-recovery", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Worker Node Recovery add-on.", "Usage": "ibmcloud ks cluster addon disable worker-recovery --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "csutil", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon disable csutil --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "csutil-experimental", "Alias": "", "Aliases": null, "Description": "Internal only. The IBM Cloud CSUtil-Experimental add-on for IBM service teams.", "Usage": "ibmcloud ks cluster addon disable csutil-experimental --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "vpc-file-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud VPC File Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon disable vpc-file-csi-driver --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon disable", "Name": "ibm-object-csi-driver", "Alias": "", "Aliases": null, "Description": "The IBM Cloud Object Storage CSI Driver.", "Usage": "ibmcloud ks cluster addon disable ibm-object-csi-driver --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks cluster addon disable", "Name": "openshift-ai", "Alias": "", "Aliases": null, "Description": "The Red Hat OpenShift AI on IBM Cloud add-on.", "Usage": "ibmcloud ks cluster addon disable openshift-ai --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "acm", "Alias": "", "Aliases": null, "Description": "The Red Hat Advanced Cluster Management add-on", "Usage": "ibmcloud ks cluster addon disable acm --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon disable", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster addon disable help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List enabled add-ons.", "Usage": "ibmcloud ks cluster addon ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon", "Name": "versions", "Alias": "", "Aliases": null, "Description": "List supported versions for managed add-ons.", "Usage": "ibmcloud ks cluster addon versions [--addon ADDON] [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "addon", "Description": "Specify an add-on name to filter versions for.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon", "Name": "get", "Alias": "", "Aliases": null, "Description": "View details of an installed add-on.", "Usage": "ibmcloud ks cluster addon get --addon ADDON --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "addon", "Description": "The add-on name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon", "Name": "options", "Alias": "", "Aliases": null, "Description": "View installation options for an add-on.", "Usage": "ibmcloud ks cluster addon options --addon ADDON [--output OUTPUT] [-q] [--version VERSION]", "Flags": [ { "Name": "addon", "Description": "The add-on name or ID.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify an add-on version to display options for. If no version is specified, the default version's options are displayed.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster addon", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster addon help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster autoupdate", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable automatic updates of the master to the latest patch version.", "Usage": "ibmcloud ks cluster autoupdate disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster autoupdate", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable automatic updates of the master to the latest patch version.", "Usage": "ibmcloud ks cluster autoupdate enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster autoupdate", "Name": "get", "Alias": "", "Aliases": null, "Description": "View whether your cluster is set to automatically update the master to the latest patch version.", "Usage": "ibmcloud ks cluster autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster autoupdate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster autoupdate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster user-subnet", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add portable private IPs by making your own portable subnet on a private VLAN available to a classic cluster.", "Usage": "ibmcloud ks cluster user-subnet add --cluster CLUSTER --private-vlan VLAN --subnet-cidr CIDR [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "subnet-cidr", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster user-subnet", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove your own portable subnet on a private VLAN from a classic cluster.", "Usage": "ibmcloud ks cluster user-subnet rm --cluster CLUSTER --private-vlan VLAN --subnet-cidr CIDR [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "subnet-cidr", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster user-subnet", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster user-subnet help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster subnet", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a portable subnet on your public or private VLAN and make it available to a classic cluster.", "Usage": "ibmcloud ks cluster subnet create --cluster CLUSTER --size SIZE --vlan VLAN [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "size", "Description": "Specify the size of the portable subnet. The size must be one of 8, 16, 32, 64.", "HasValue": true, "Hidden": false }, { "Name": "vlan", "Description": "Specify the public or private VLAN ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster subnet", "Name": "add", "Alias": "", "Aliases": null, "Description": "Make an existing public or private portable subnet in your IBM Cloud infrastructure account available to a classic cluster.", "Usage": "ibmcloud ks cluster subnet add --cluster CLUSTER --subnet-id ID [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "Specify the subnet ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster subnet", "Name": "detach", "Alias": "", "Aliases": null, "Description": "Detach an existing public or private portable subnet from a classic cluster.", "Usage": "ibmcloud ks cluster subnet detach --cluster CLUSTER --subnet-id ID [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "subnet-id", "Description": "Specify the subnet ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster subnet", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster subnet help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "services", "Alias": "", "Aliases": null, "Description": "List services bound to a Kubernetes namespace.", "Usage": "ibmcloud ks cluster services --cluster CLUSTER [--output OUTPUT] [-q] (--all-namespaces | --namespace NAMESPACE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The Kubernetes namespace. Will use the 'default' namespace if not specified.", "HasValue": true, "Hidden": false }, { "Name": "all-namespaces", "Description": "Include all Kubernetes namespaces.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster service", "Name": "bind", "Alias": "", "Aliases": null, "Description": "Add an IBM Cloud service to a cluster by binding the service instance to a Kubernetes namespace.", "Usage": "ibmcloud ks cluster service bind --cluster CLUSTER --namespace NAMESPACE --service SERVICE [-q] (--key KEY | --role ROLE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "key", "Description": "Specify the name or GUID of an existing service key. If you define a service key, you cannot set the '--role' option at the same time.", "HasValue": true, "Hidden": false }, { "Name": "role", "Description": "Specify the IAM role for the service key. This flag does not work if you specify an existing key to use or for services that are not IAM-enabled, such as Cloud Foundry services.", "HasValue": true, "Hidden": false }, { "Name": "service", "Description": "Specify the name of the service instance. To see a list of available service instances, run 'ibmcloud service list' for Cloud Foundry services, or 'ibmcloud resource service-instances' for IAM-enabled services.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster service", "Name": "unbind", "Alias": "", "Aliases": null, "Description": "Remove an IBM Cloud service from a cluster by unbinding it from a Kubernetes namespace.", "Usage": "ibmcloud ks cluster service unbind --cluster CLUSTER --namespace NAMESPACE --service SERVICE [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "service", "Description": "Specify the name of the service instance. To see a list of available service instances, run 'ibmcloud service list' for Cloud Foundry services, or 'ibmcloud resource service-instances' for IAM-enabled services.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster service", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List services bound to a Kubernetes namespace.", "Usage": "ibmcloud ks cluster service ls --cluster CLUSTER [--output OUTPUT] [-q] (--all-namespaces | --namespace NAMESPACE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "The Kubernetes namespace. Will use the 'default' namespace if not specified.", "HasValue": true, "Hidden": false }, { "Name": "all-namespaces", "Description": "Include all Kubernetes namespaces.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster service", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster service help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster pull-secret", "Name": "apply", "Alias": "", "Aliases": null, "Description": "Generate a new image pull secret that stores IAM credentials for the cluster to access images in IBM Cloud Container Registry.", "Usage": "ibmcloud ks cluster pull-secret apply --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster pull-secret", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster pull-secret help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master audit-webhook", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the audit webhook configuration for a cluster's Kubernetes API server. The webhook backend forwards API server audit logs to a remote server.", "Usage": "ibmcloud ks cluster master audit-webhook get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master audit-webhook", "Name": "unset", "Alias": "", "Aliases": null, "Description": "Remove the audit webhook configuration for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master audit-webhook unset --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master audit-webhook", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set the audit webhook configuration for a cluster's Kubernetes API server. The webhook backend forwards API server audit logs to a remote server.", "Usage": "ibmcloud ks cluster master audit-webhook set --cluster CLUSTER [--ca-cert CERT] [--client-cert CERT] [--client-key KEY] [--policy POLICY] [-q] [--remote-server SERVER]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "remote-server", "Description": "The URL or IP address for the remote logging service.", "HasValue": true, "Hidden": false }, { "Name": "ca-cert", "Description": "The filepath of the CA cert used to verify the remote logging service.", "HasValue": true, "Hidden": false }, { "Name": "client-cert", "Description": "The filepath for the client cert that is used to authenticate against the remote logging service.", "HasValue": true, "Hidden": false }, { "Name": "client-key", "Description": "The filepath for the corresponding client key that is used to connect to the remote logging service.", "HasValue": true, "Hidden": false }, { "Name": "policy", "Description": "Specify the audit policy type.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master audit-webhook", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master audit-webhook help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master", "Name": "refresh", "Alias": "", "Aliases": null, "Description": "Restart the cluster master nodes to apply new Kubernetes API configuration changes. Your worker nodes, apps, and resources are not modified and continue to run.", "Usage": "ibmcloud ks cluster master refresh --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update the cluster master to the latest version.", "Usage": "ibmcloud ks cluster master update --cluster CLUSTER [-f] [--force-update] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Attempt the update even if the change is greater than two minor versions from the worker node's current version.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "version", "Description": "Specify the Kubernetes or OpenShift version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "kube-version", "Description": "Specify the Kubernetes version, including at least the major.minor version. If you do not include this flag, the default version is used. To see available versions, run 'ibmcloud ks versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master private-service-endpoint", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the private service endpoint to make the master privately accessible.", "Usage": "ibmcloud ks cluster master private-service-endpoint enable --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master private-service-endpoint", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the private service endpoint to make the master only publicly accessible.", "Usage": "ibmcloud ks cluster master private-service-endpoint disable --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the allowlist. When enabled, only authorized requests to the cluster master from subnets in the allowlist are permitted through the private service endpoint.", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the allowlist. When disabled, authorized requests to the cluster master from any subnet are permitted through the private service endpoint.", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get a cluster's private service endpoint allowlist.", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist get --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add subnets to a cluster's private service endpoint allowlist.", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove subnets from a cluster's private service endpoint allowlist.", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "subnet", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster master private-service-endpoint allowlist", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master private-service-endpoint allowlist help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master private-service-endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master private-service-endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master public-service-endpoint", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the public service endpoint to make the master publicly accessible.", "Usage": "ibmcloud ks cluster master public-service-endpoint enable --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master public-service-endpoint", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the public service endpoint to make the master only privately accessible.", "Usage": "ibmcloud ks cluster master public-service-endpoint disable --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master public-service-endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master public-service-endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the allowlist for a Satellite cluster. When enabled, only authorized requests to the cluster master from subnets in the allowlist are permitted through the Satellite service endpoint.", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the allowlist for a Satellite cluster. When disabled, authorized requests to the cluster master from any subnet are permitted through the Satellite service endpoint.", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get a Satellite cluster's service endpoint allowlist.", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist get --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add subnets to a Satellite cluster's service endpoint allowlist.", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove subnets from a Satellite cluster's service endpoint allowlist.", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "subnet", "Description": "Specify the subnet CIDR.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint allowlist", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master satellite-service-endpoint allowlist help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master satellite-service-endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master satellite-service-endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master console-oauth-access", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the OpenShift web console and OAuth server access type.", "Usage": "ibmcloud ks cluster master console-oauth-access get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master console-oauth-access", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set the OpenShift web console and OAuth server access type.", "Usage": "ibmcloud ks cluster master console-oauth-access set --cluster CLUSTER [-f] [-q] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "Specify the OpenShift web console and OAuth server access type.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master console-oauth-access", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master console-oauth-access help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security policy", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the PodSecurityPolicy configuration for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security policy get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security policy", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable PodSecurityPolicy for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security policy enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security policy", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable PodSecurityPolicy for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security policy disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security policy", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master pod-security policy help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the PodSecurity admission configuration for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set and enable the PodSecurity admission configuration for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security set --cluster CLUSTER [--config-file FILE] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "config-file", "Description": "The filepath of a custom PodSecurity configuration. If not specified, the Kubernetes defaults are applied. For more information, see https://ibm.biz/BdPtUB", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security", "Name": "unset", "Alias": "", "Aliases": null, "Description": "Remove the PodSecurity admission configuration for a cluster's Kubernetes API server.", "Usage": "ibmcloud ks cluster master pod-security unset --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master pod-security", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master pod-security help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster master", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster master help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster ca", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a CA certificate for your cluster. Then, you must rotate the previous certificates to use the new certificates.", "Usage": "ibmcloud ks cluster ca create --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster ca", "Name": "rotate", "Alias": "", "Aliases": null, "Description": "Rotate the CA certificates of a cluster, which requires that you previously created CA certificates. Rotating invalidates the previous certificates and refreshes the API server of the cluster.", "Usage": "ibmcloud ks cluster ca rotate --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster ca", "Name": "status", "Alias": "", "Aliases": null, "Description": "View the rotation status of CA certificates for a cluster.", "Usage": "ibmcloud ks cluster ca status --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster ca", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a cluster's CA certificate.", "Usage": "ibmcloud ks cluster ca get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster ca", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster ca help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster image-security", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable image security enforcement in your cluster.", "Usage": "ibmcloud ks cluster image-security enable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster image-security", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable image security enforcement in your cluster.", "Usage": "ibmcloud ks cluster image-security disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster image-security", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster image-security help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster feature enable", "Name": "private-service-endpoint", "Alias": "", "Aliases": null, "Description": "Enable the private service endpoint to make the master privately accessible.", "Usage": "ibmcloud ks cluster feature enable private-service-endpoint --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster feature enable", "Name": "public-service-endpoint", "Alias": "", "Aliases": null, "Description": "Enable the public service endpoint to make the master publicly accessible.", "Usage": "ibmcloud ks cluster feature enable public-service-endpoint --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster feature enable", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster feature enable help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster feature disable", "Name": "public-service-endpoint", "Alias": "", "Aliases": null, "Description": "Disable the public service endpoint to make the master only privately accessible.", "Usage": "ibmcloud ks cluster feature disable public-service-endpoint --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster feature disable", "Name": "private-service-endpoint", "Alias": "", "Aliases": null, "Description": "Disable the private service endpoint to make the master only publicly accessible.", "Usage": "ibmcloud ks cluster feature disable private-service-endpoint --cluster CLUSTER [-f] [-q] [-y]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "y", "Description": "If the feature requires further action, such as reloading workers or refreshing the cluster master, then perform those actions with no user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks cluster feature disable", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster feature disable help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster feature", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster feature help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks cluster", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks cluster help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the status report for Ingress components in a cluster.", "Usage": "ibmcloud ks ingress status-report get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable status reporting for Ingress components in a cluster.", "Usage": "ibmcloud ks ingress status-report enable --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable status reporting for Ingress components in a cluster.", "Usage": "ibmcloud ks ingress status-report disable --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report ignored-errors", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add warnings to be ignored by Ingress status for a cluster.", "Usage": "ibmcloud ks ingress status-report ignored-errors add --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]", "Flags": [ { "Name": "code", "Description": "Code of the warning to be ignored.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report ignored-errors", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove warnings that are currently ignored by Ingress status for a cluster.", "Usage": "ibmcloud ks ingress status-report ignored-errors rm --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]", "Flags": [ { "Name": "code", "Description": "Code of the warning to be removed.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report ignored-errors", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List warnings that are currently ignored by Ingress status for a cluster.", "Usage": "ibmcloud ks ingress status-report ignored-errors ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report ignored-errors", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress status-report ignored-errors help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress status-report", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress status-report help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress load-balancer", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the configuration of load balancers that expose Ingress ALBs in your cluster.", "Usage": "ibmcloud ks ingress load-balancer get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress load-balancer proxy-protocol", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the PROXY protocol so that client connection information is passed in request headers to ALBs.", "Usage": "ibmcloud ks ingress load-balancer proxy-protocol enable --cluster CLUSTER [--cidr CIDR ...] [-f] [--header-timeout TIMEOUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "cidr", "Description": "[Beta] The IP address ranges of your load balancers in CIDR format. PROXY headers that are forwarded by load balancers in other IP ranges are not processed.", "HasValue": true, "Hidden": false }, { "Name": "header-timeout", "Description": "[Beta] ALBs that run Kubernetes Ingress image only: The timeout value, in seconds, for the load balancer to receive the PROXY protocol headers.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress load-balancer proxy-protocol", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the PROXY protocol so that client connection information is no longer passed in request headers to ALBs.", "Usage": "ibmcloud ks ingress load-balancer proxy-protocol disable --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress load-balancer proxy-protocol", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress load-balancer proxy-protocol help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress load-balancer", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress load-balancer help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create an Ingress secret in a cluster for a secret stored in IBM Cloud Secret Manager.", "Usage": "ibmcloud ks ingress secret create --cluster CLUSTER --name NAME [--cert-crn CRN] [--field FIELD] [--namespace NAMESPACE] [--persist] [-q] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "cert-crn", "Description": "The certificate CRN.", "HasValue": true, "Hidden": false }, { "Name": "field", "Description": "The secret CRN to include as a field. To pull in the secret without specifying the name, use '--field \u003ccrn\u003e'. To specify the field name, use '--field name=\u003ccrn\u003e'. To use the IBM Cloud Secrets Manager secret as the prefix, use '--field prefix=\u003ccrn\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The Ingress secret type. Can be TLS or Opaque. If no option is specified, TLS is applied by default.", "HasValue": true, "Hidden": false }, { "Name": "persist", "Description": "Persist the secret in the cluster so that it cannot be deleted.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update an existing Ingress secret.", "Usage": "ibmcloud ks ingress secret update --cluster CLUSTER --name NAME --namespace NAMESPACE [--cert-crn CRN] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "cert-crn", "Description": "The certificate CRN.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove an Ingress secret from a cluster.", "Usage": "ibmcloud ks ingress secret rm --cluster CLUSTER --name NAME --namespace NAMESPACE [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Ingress secrets in a cluster.", "Usage": "ibmcloud ks ingress secret ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-crn] [--show-deleted]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "show-deleted", "Description": "Show secrets that were deleted from the cluster.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "show-crn", "Description": "Show CRN value of secret.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an Ingress secret.", "Usage": "ibmcloud ks ingress secret get --cluster CLUSTER --name NAME --namespace NAMESPACE [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret field", "Name": "ls", "Alias": "", "Aliases": null, "Description": "View the fields of an Ingress secret.", "Usage": "ibmcloud ks ingress secret field ls --cluster CLUSTER --name NAME --namespace NAMESPACE [--output OUTPUT] [-q] [--show-crn]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "show-crn", "Description": "Show CRN value of secret.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret field", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add fields to an existing Ingress secret.", "Usage": "ibmcloud ks ingress secret field add --cluster CLUSTER --name NAME --namespace NAMESPACE [--field FIELD] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "field", "Description": "The secret CRN to include as a field. To pull in the secret without specifying the name, use '--field \u003ccrn\u003e'. To specify the field name, use '--field name=\u003ccrn\u003e'. To use the IBM Cloud Secrets Manager secret as the prefix, use '--field prefix=\u003ccrn\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret field", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove fields from an existing Ingress secret.", "Usage": "ibmcloud ks ingress secret field rm --cluster CLUSTER --name NAME --namespace NAMESPACE [--field-name NAME] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "A name for the Ingress secret that is created in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "namespace, n", "Description": "Specify the Kubernetes namespace.", "HasValue": true, "Hidden": false }, { "Name": "field-name", "Description": "The name of the field to remove from the secret.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret field", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress secret field help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress secret", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress secret help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Ingress ALB IDs in a cluster and whether ALB pods are at the latest version.", "Usage": "ibmcloud ks ingress alb ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an Ingress ALB in a cluster.", "Usage": "ibmcloud ks ingress alb get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb create", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a classic cluster.", "Usage": "ibmcloud ks ingress alb create classic --cluster CLUSTER --type TYPE --vlan VLAN --zone ZONE [--ip IP] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "vlan", "Description": "The VLAN ID. This VLAN must match the ALB 'type' and must be in the same 'zone' as the ALB that you want to create.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "Specify a portable public or private IP address that is available on the 'vlan' and in the 'zone' of the ALB to be created or enabled.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb create", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a VPC Gen 1 cluster.", "Usage": "ibmcloud ks ingress alb create vpc-classic --cluster CLUSTER --type TYPE --zone ZONE [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb create", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Create and enable an Ingress ALB in a VPC Gen 2 cluster.", "Usage": "ibmcloud ks ingress alb create vpc-gen2 --cluster CLUSTER --type TYPE --zone ZONE [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb create", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb create help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb enable", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Enable an Ingress ALB in a classic cluster.", "Usage": "ibmcloud ks ingress alb enable classic --alb ALB --cluster CLUSTER [--ip IP] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "Specify a portable public or private IP address that is available on the 'vlan' and in the 'zone' of the ALB to be created or enabled.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb enable", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Enable an Ingress ALB in a VPC Gen 1 cluster.", "Usage": "ibmcloud ks ingress alb enable vpc-classic --alb ALB --cluster CLUSTER [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb enable", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Enable an Ingress ALB in a VPC Gen 2 cluster.", "Usage": "ibmcloud ks ingress alb enable vpc-gen2 --alb ALB --cluster CLUSTER [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb enable", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb enable help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable an Ingress ALB in a cluster.", "Usage": "ibmcloud ks ingress alb disable --alb ALB --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "update", "Alias": "", "Aliases": null, "Description": "Force a one-time update of the pods for individual or all ALBs in the cluster.", "Usage": "ibmcloud ks ingress alb update --cluster CLUSTER [--alb ALB ...] [--output OUTPUT] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the ALB image version. To see supported image versions, run 'ibmcloud ks ingress alb versions'.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "To update a specific ALB, specify the ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'. To update more than one ALB, specify one ALB ID in each flag, such as '--alb ID_1 --alb ID_2'. To update all ALBs, do not include this flag.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "versions", "Alias": "", "Aliases": null, "Description": "List Ingress ALB image versions that are available.", "Usage": "ibmcloud ks ingress alb versions [--output OUTPUT] [-q] [--region REGION]", "Flags": [ { "Name": "region", "Description": "Specify the region to target.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoupdate", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable automatic updates of all Ingress ALB pods in a cluster.", "Usage": "ibmcloud ks ingress alb autoupdate disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoupdate", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable automatic updates of all Ingress ALB pods in a cluster.", "Usage": "ibmcloud ks ingress alb autoupdate enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoupdate", "Name": "get", "Alias": "", "Aliases": null, "Description": "View whether the Ingress ALB pods in a cluster are set to automatically update and whether ALB pods are at the latest version.", "Usage": "ibmcloud ks ingress alb autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoupdate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb autoupdate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb health-checker", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable the Ingress health checker.", "Usage": "ibmcloud ks ingress alb health-checker disable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb health-checker", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable the Ingress health checker.", "Usage": "ibmcloud ks ingress alb health-checker enable --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb health-checker", "Name": "get", "Alias": "", "Aliases": null, "Description": "View status of the Ingress health checker.", "Usage": "ibmcloud ks ingress alb health-checker get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb health-checker", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb health-checker help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb migrate", "Name": "start", "Alias": "", "Aliases": null, "Description": "Start a migration of your IBM Cloud Ingress configmap and resources to use with ALBs that run the Kubernetes Ingress image. This command does not change the image type of your ALBs. For more info, see 'https://ibm.biz/ingress-migrate'", "Usage": "ibmcloud ks ingress alb migrate start --cluster CLUSTER [-f] [-q] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "Specify the migration type.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb migrate", "Name": "status", "Alias": "", "Aliases": null, "Description": "Get the status of the migration process.", "Usage": "ibmcloud ks ingress alb migrate status --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb migrate", "Name": "clean", "Alias": "", "Aliases": null, "Description": "Clean up any resources and ConfigMaps that you no longer need, such as after an Ingress migration.", "Usage": "ibmcloud ks ingress alb migrate clean --cluster CLUSTER [-f] [--generated-resources] [--iks-ingresses] [--kube-ingresses] [--output OUTPUT] [-q] [--reset-kube-controller-configmap] [--test-ingresses]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "generated-resources", "Description": "Delete all resources that were automatically generated during an Ingress migration, including the Ingress resources and ConfigMaps listed in the Migrated to sections in the output of ibmcloud ks ingress alb migrate status.", "HasValue": false, "Hidden": false }, { "Name": "test-ingresses", "Description": "Delete automatically generated and manually created Ingress resources of class test for the test ALB service running the Kubernetes Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "kube-ingresses", "Description": "Delete automatically generated and manually created Ingress resources of class public-iks-k8s-nginx or private-iks-k8s-nginx for public or private ALBs that run the Kubernetes Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "iks-ingresses", "Description": "Delete Ingress resources of class iks-nginx, class nginx, or of no class for public or private ALBs that run the IBM Cloud Kubernetes Service Ingress image.", "HasValue": false, "Hidden": false }, { "Name": "reset-kube-controller-configmap", "Description": "Reset the ibm-k8s-controller-config ConfigMap to the default settings. The ConfigMap is deleted and re-deployed.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb migrate", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb migrate help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoscale", "Name": "set", "Alias": "", "Aliases": null, "Description": "Configure autoscaling for Ingress ALBs.", "Usage": "ibmcloud ks ingress alb autoscale set --alb ALB --cluster CLUSTER --max-replicas REPLICAS --min-replicas REPLICAS [--output OUTPUT] [-q] (--cpu-average-utilization PERCENT | --custom-metrics-file FILE)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "max-replicas", "Description": "The maximum replicas for the given ALB. Ensure you have enough workers.", "HasValue": true, "Hidden": false }, { "Name": "min-replicas", "Description": "The minimum replicas for the given ALB. Must be greater or equal to 1. (Recommended minimum is 2 for high availability purposes.)", "HasValue": true, "Hidden": false }, { "Name": "cpu-average-utilization", "Description": "Average CPU utilization threshold. Used to dynamically calculate the number of replicas.", "HasValue": true, "Hidden": false }, { "Name": "custom-metrics-file", "Description": "Path for the custom metric file. See https://ibm.biz/iks-ingress-custom-metrics for more details.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoscale", "Name": "unset", "Alias": "", "Aliases": null, "Description": "Delete the autoscaling configuration for Ingress ALBs.", "Usage": "ibmcloud ks ingress alb autoscale unset --alb ALB --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoscale", "Name": "get", "Alias": "", "Aliases": null, "Description": "See autoscaling status and configuration for Ingress ALBs.", "Usage": "ibmcloud ks ingress alb autoscale get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "alb", "Description": "The ALB ID. To see available ALB IDs, run 'ibmcloud ks ingress alb ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb autoscale", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb autoscale help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress alb", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress alb help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance", "Name": "register", "Alias": "", "Aliases": null, "Description": "Register an IBM Cloud Secrets Manager instance to a cluster.", "Usage": "ibmcloud ks ingress instance register --cluster CLUSTER --crn CRN [--is-default] [-q] [--secret-group GROUP]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "crn", "Description": "CRN of the IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "is-default", "Description": "Set the IBM Cloud Secrets Manager instance as the default. If an existing default instance exists, it is unset.", "HasValue": false, "Hidden": false }, { "Name": "secret-group", "Description": "Secret Group ID of the IBM Cloud Secret Manager instance where the secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance", "Name": "unregister", "Alias": "", "Aliases": null, "Description": "Unregister an IBM Cloud Secrets Manager instance from a cluster.", "Usage": "ibmcloud ks ingress instance unregister --cluster CLUSTER --name NAME [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name of the registered IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance default", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set a registered IBM Cloud Secrets Manager instance as the default. If an existing default instance exists, it is unset.", "Usage": "ibmcloud ks ingress instance default set --cluster CLUSTER --name NAME [-q] [--secret-group GROUP]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name of the registered IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "secret-group", "Description": "Secret Group ID of the IBM Cloud Secret Manager instance where the secrets are persisted.", "HasValue": true, "Hidden": false }, { "Name": "crn", "Description": "CRN of the IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance default", "Name": "unset", "Alias": "", "Aliases": null, "Description": "Unset a registered IBM Cloud Secrets Manager instance from default.", "Usage": "ibmcloud ks ingress instance default unset --cluster CLUSTER --name NAME [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name of the registered IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "crn", "Description": "CRN of the IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance default", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress instance default help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all instances of the IBM Cloud Secrets Manager.", "Usage": "ibmcloud ks ingress instance ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-deleted]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "show-deleted", "Description": "Show IBM Cloud Secret Manager instances that were unregistered from the cluster.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an IBM Cloud Secrets Manager instance.", "Usage": "ibmcloud ks ingress instance get --cluster CLUSTER --name NAME [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name of the registered IBM Cloud Secret Manager instance.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress instance", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress instance help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create an Ingress domain for a cluster.", "Usage": "ibmcloud ks ingress domain create --cluster CLUSTER [--crn CRN] [--domain DOMAIN] [--domain-provider PROVIDER] [--domain-zone ZONE] [--hostname HOSTNAME] [--ip IP] [--is-default] [--output OUTPUT] [-q] [--secret-namespace NAMESPACE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "domain-provider", "Description": "The external DNS provider type. The default is 'akamai'.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "The IP addresses to register for the domain.", "HasValue": true, "Hidden": false }, { "Name": "is-default", "Description": "Include this option to set the relevant domain as the default domain for cluster.", "HasValue": false, "Hidden": false }, { "Name": "crn", "Description": "The CRN for the IBM CIS instance.", "HasValue": true, "Hidden": false }, { "Name": "domain-zone", "Description": "The ZoneID for CIS.", "HasValue": true, "Hidden": false }, { "Name": "hostname", "Description": "For VPC clusters. The hostname to register for the domain.", "HasValue": true, "Hidden": false }, { "Name": "secret-namespace", "Description": "The namespace that the TLS secret is created in.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update an Ingress domain for a cluster. The records passed in will fully replace the current records associated with the domain. Passing in no records will unregister the current records from a domain.", "Usage": "ibmcloud ks ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "The IP addresses to register for the domain.", "HasValue": true, "Hidden": false }, { "Name": "hostname", "Description": "For VPC clusters. The hostname to register for the domain.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Ingress domains for a cluster.", "Usage": "ibmcloud ks ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an Ingress domain.", "Usage": "ibmcloud ks ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove an Ingress domain from a cluster.", "Usage": "ibmcloud ks ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the domain provider credential details.", "Usage": "ibmcloud ks ingress domain credential get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential set", "Name": "akamai", "Alias": "", "Aliases": null, "Description": "Set credentials for Akamai.", "Usage": "ibmcloud ks ingress domain credential set akamai --cluster CLUSTER [--access-token TOKEN] [--client-secret SECRET] [--client-token TOKEN] [--domain-zone ZONE] [-f] [--host HOST] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The host for the Akamai API Client Credentials.", "HasValue": true, "Hidden": false }, { "Name": "client-token", "Description": "The 'client_token' for the Akamai API Client Credentials.", "HasValue": true, "Hidden": false }, { "Name": "client-secret", "Description": "The 'client_secret' for the Akamai API Client Credentials.", "HasValue": true, "Hidden": false }, { "Name": "access-token", "Description": "The 'access_token' for the Akamai API Client Credentials.", "HasValue": true, "Hidden": false }, { "Name": "domain-zone", "Description": "The zone to operate in.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential set", "Name": "cloudflare", "Alias": "", "Aliases": null, "Description": "Set credentials for Cloudflare.", "Usage": "ibmcloud ks ingress domain credential set cloudflare --cluster CLUSTER [--domain-zone ZONE] [-f] [-q] [--token TOKEN]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "token", "Description": "The API token.", "HasValue": true, "Hidden": false }, { "Name": "domain-zone", "Description": "The zone to operate in.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential set", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress domain credential set help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove an external domain provider credential from the cluster.", "Usage": "ibmcloud ks ingress domain credential rm --cluster CLUSTER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain credential", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress domain credential help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain default", "Name": "replace", "Alias": "", "Aliases": null, "Description": "Change a cluster's default Ingress domain.", "Usage": "ibmcloud ks ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain default", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress domain default help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain secret", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a secret for an Ingress domain and prevent future renewal of the certificate.", "Usage": "ibmcloud ks ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain secret", "Name": "regenerate", "Alias": "", "Aliases": null, "Description": "Regenerate the certificate for an Ingress domain.", "Usage": "ibmcloud ks ingress domain secret regenerate --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "domain", "Description": "The Ingress domain. To see existing domains, run 'ibmcloud ks ingress domain ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain secret", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress domain secret help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress domain", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress domain help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks ingress", "Name": "status", "Alias": "", "Aliases": null, "Description": "Get the status of the Ingress resources for a cluster.", "Usage": "ibmcloud ks ingress status --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks ingress", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks ingress help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms", "Name": "instances", "Alias": "", "Aliases": null, "Description": "List available Key Management Service instances.", "Usage": "ibmcloud ks kms instances [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms instance", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List available Key Management Service instances.", "Usage": "ibmcloud ks kms instance ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms instance", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks kms instance help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms", "Name": "crks", "Alias": "", "Aliases": null, "Description": "List available root keys for a Key Management Service instance.", "Usage": "ibmcloud ks kms crks --instance-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "instance-id", "Description": "KMS instance ID. To see available KMS instances, run 'ibmcloud ks kms instance ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms crk", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List available root keys for a Key Management Service instance.", "Usage": "ibmcloud ks kms crk ls --instance-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "instance-id", "Description": "KMS instance ID. To see available KMS instances, run 'ibmcloud ks kms instance ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms crk", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks kms crk help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable a key management service (KMS) in your cluster to encrypt your secrets.", "Usage": "ibmcloud ks kms enable --cluster CLUSTER --crk CRK --instance-id ID [--kms-account-id ID] [--public-endpoint] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "instance-id", "Description": "KMS instance ID. To see available KMS instances, run 'ibmcloud ks kms instance ls'.", "HasValue": true, "Hidden": false }, { "Name": "crk", "Description": "A root key ID in your KMS instance. To list available root keys, run 'ibmcloud ks kms crk ls --instance-id \u003ckms_instance\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "public-endpoint", "Description": "Specify this option to use the KMS public service endpoint. Otherwise the KMS private service endpoint is used.", "HasValue": true, "Hidden": false }, { "Name": "kms-account-id", "Description": "The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks kms", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks kms help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "versions", "Alias": "", "Aliases": null, "Description": "List all the container platform versions that are available for IBM Cloud Kubernetes Service clusters.", "Usage": "ibmcloud ks versions [--output OUTPUT] [-q] [--show-version VERSION]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "show-version", "Description": "Show only the versions for the specified container platform.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "locations", "Alias": "", "Aliases": null, "Description": "List supported IBM Cloud Kubernetes Service locations.", "Usage": "ibmcloud ks locations", "Flags": [ { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "show-flavors", "Description": "Show the available worker node flavors in the zone for VPC.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "nlb-dnss", "Alias": "", "Aliases": null, "Description": "List the registered NLB host names and IP addresses in a cluster.", "Usage": "ibmcloud ks nlb-dnss --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the registered NLB host names and IP addresses in a cluster.", "Usage": "ibmcloud ks nlb-dns ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a registered NLB host name in a cluster.", "Usage": "ibmcloud ks nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns create", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Create a DNS host name to register one or more NLB IPs in a classic cluster.", "Usage": "ibmcloud ks nlb-dns create classic --cluster CLUSTER --ip IP [--ip IP ...] [--output OUTPUT] [-q] [--secret-namespace NAMESPACE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "One or more NLB IP addresses. To see load balancer IPs, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "dns-type, type", "Description": "The DNS provider type for subdomain registration.", "HasValue": true, "Hidden": false }, { "Name": "secret-namespace", "Description": "The namespace that the SSL secret is created in. If this flag is not specified, the secret is created in 'default.'", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns create", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Create a DNS host name to register a load balancer host name in a VPC cluster.", "Usage": "ibmcloud ks nlb-dns create vpc-classic --cluster CLUSTER --lb-host HOST [--output OUTPUT] [-q] [--secret-namespace NAMESPACE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "lb-host", "Description": "The VPC load balancer host name. To see load balancer host names, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "secret-namespace", "Description": "The namespace that the SSL secret is created in. If this flag is not specified, the secret is created in 'default.'", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The VPC load balancer type.", "HasValue": true, "Hidden": false }, { "Name": "dns-type", "Description": "The DNS provider type for subdomain registration.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns create", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Create a DNS record to register a load balancer host name or load balancer IP addresses in a VPC cluster.", "Usage": "ibmcloud ks nlb-dns create vpc-gen2 --cluster CLUSTER [--output OUTPUT] [-q] [--secret-namespace NAMESPACE] (--ip IP | --lb-host HOST)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "lb-host", "Description": "The VPC load balancer host name. To see load balancer host names, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "secret-namespace", "Description": "The namespace that the SSL secret is created in. If this flag is not specified, the secret is created in 'default.'", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The VPC load balancer type.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "One or more NLB IP addresses. To see load balancer IPs, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "dns-type", "Description": "The DNS provider type for subdomain registration.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns create", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks nlb-dns create help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add an NLB IP to an existing host name that you created with 'ibmcloud ks nlb-dns create'.", "Usage": "ibmcloud ks nlb-dns add --cluster CLUSTER --ip IP [--ip IP ...] --nlb-host HOST [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "One or more NLB IP addresses. To see load balancer IPs, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns rm", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Remove an NLB IP address from an NLB host name. If you remove all IPs from a host name, the host name still exists but no IPs are associated with it.", "Usage": "ibmcloud ks nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host HOST [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "One NLB IP address. To see NLB IPs associated with the host name, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns rm", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Remove a load balancer host name from an NLB host name in a VPC cluster. The NLB host name still exists but no load balancers are associated with it.", "Usage": "ibmcloud ks nlb-dns rm vpc-classic --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns rm", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Remove a load balancer host name or IP address from a DNS record in a VPC cluster.", "Usage": "ibmcloud ks nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--ip IP] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "One NLB IP address. To see NLB IPs associated with the host name, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns rm", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks nlb-dns rm help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "replace", "Alias": "", "Aliases": null, "Description": "Update an existing DNS host name by replacing the load balancer hostname associated with it in a VPC cluster.", "Usage": "ibmcloud ks nlb-dns replace --cluster CLUSTER --lb-host HOST --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "lb-host", "Description": "The VPC load balancer host name. To see load balancer host names, run 'kubectl get svc -n \u003cnamespace\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "monitors", "Alias": "", "Aliases": null, "Description": "List the health check monitor settings for each NLB host name in a cluster.", "Usage": "ibmcloud ks nlb-dns monitors --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the health check monitor settings for each NLB host name in a cluster.", "Usage": "ibmcloud ks nlb-dns monitor ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "configure", "Alias": "", "Aliases": null, "Description": "Configure a health check monitor for an existing NLB host name in a cluster. To enable the monitor, include the '--enable' flag. To update an existing monitor, include only the flags for the settings that you want to change.", "Usage": "ibmcloud ks nlb-dns monitor configure --cluster CLUSTER --nlb-host HOST [--allows-insecure] [--description DESCRIPTION] [--enable] [--expected-body BODY] [--expected-codes CODES] [--follows-redirects] [--header HEADER ...] [--interval INTERVAL] [--method METHOD] [--output OUTPUT] [--path PATH] [--port PORT] [-q] [--retries RETRIES] [--timeout TIMEOUT] [--type TYPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "type", "Description": "The protocol to use for the health check.", "HasValue": true, "Hidden": false }, { "Name": "enable", "Description": "Enable the health check monitor for the host name.", "HasValue": false, "Hidden": false }, { "Name": "description", "Description": "Description of the health monitor.", "HasValue": true, "Hidden": false }, { "Name": "method", "Description": "The method to use for the health check. Default for HTTP and HTTPS: 'GET'. Default for TCP: 'connection_established'", "HasValue": true, "Hidden": false }, { "Name": "path", "Description": "The endpoint path to health check against. This flag is valid only for type 'HTTP' or 'HTTPS'. Default: '/' ", "HasValue": true, "Hidden": false }, { "Name": "timeout", "Description": "The timeout, in seconds, before the IP is considered unhealthy. Must be in the range [1, 15]. Default: '5'", "HasValue": true, "Hidden": false }, { "Name": "retries", "Description": "When a timeout occurs, the number of retries to attempt before the IP is considered unhealthy. Retries are attempted immediately. Must be in the range [0, 5]. Default: '2'", "HasValue": true, "Hidden": false }, { "Name": "interval", "Description": "The interval, in seconds, between each health check. Short intervals might improve failover time but increase load on the IPs. The value must be greater than ('retries_value' + 1) * 'timeout_value', and must be in the range [10, 3600]. Default: '60'", "HasValue": true, "Hidden": false }, { "Name": "port", "Description": "The port number to connect to for the health check. When type is TCP, this flag is required. When type is HTTP or HTTPS, use this flag only for ports other than 80 for HTTP or 443 for HTTPS. HTTP default: '80'. HTTPS default: '443'.", "HasValue": true, "Hidden": false }, { "Name": "expected-body", "Description": "A case-insensitive sub-string that the health check looks for in the response body. If this string is not found, the IP is considered unhealthy. This flag is valid only for type 'HTTP' or 'HTTPS'.", "HasValue": true, "Hidden": false }, { "Name": "expected-codes", "Description": "HTTP codes that the health check looks for in the response. If the HTTP code is not found, the IP is considered unhealthy. This flag is valid only for type 'HTTP' or 'HTTPS'. Default: '2xx'", "HasValue": true, "Hidden": false }, { "Name": "header", "Description": "HTTP request headers to send in the health check, such as a Host header. The User-Agent header cannot be overridden. This flag is valid only for type 'HTTP' or 'HTTPS'. To add more than one header to the requests, specify this flag multiple times. This flag accepts values in the following format: '--header Header-Name=value'. When updating a monitor, the existing headers are replaced by the ones you specify. To delete all existing headers specify the flag with an empty value '--header \"\"'.", "HasValue": true, "Hidden": false }, { "Name": "follows-redirects", "Description": "Set to 'true' to follow any redirects that are returned by the IP. This flag is valid only for type 'HTTP' or 'HTTPS'.", "HasValue": false, "Hidden": false }, { "Name": "allows-insecure", "Description": "Set to 'true' to not validate the certificate. This flag is valid only for type 'HTTP' or 'HTTPS'.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the settings for an existing health check monitor.", "Usage": "ibmcloud ks nlb-dns monitor get --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable an existing health check monitor for a NLB host name in a cluster..", "Usage": "ibmcloud ks nlb-dns monitor disable --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable a health check monitor for an NLB host name in a cluster. Note: You must first configure the monitor with 'ibmcloud ks nlb-dns monitor configure'.", "Usage": "ibmcloud ks nlb-dns monitor enable --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "The host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "status", "Alias": "", "Aliases": null, "Description": "List the health check status for the IPs behind NLB host names in a cluster.", "Usage": "ibmcloud ks nlb-dns monitor status --cluster CLUSTER [--nlb-host HOST] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-host", "Description": "Include this flag to view the status for only one host name. To see existing host names, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns monitor", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks nlb-dns monitor help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns secret", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a secret from an NLB subdomain and prevent future renewal of the certificate.", "Usage": "ibmcloud ks nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN [-f] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns secret", "Name": "regenerate", "Alias": "", "Aliases": null, "Description": "Regenerate the certificate and secret for an NLB subdomain.", "Usage": "ibmcloud ks nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "nlb-subdomain", "Description": "The subdomain. To see existing subdomains, run 'ibmcloud ks nlb-dns ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns secret", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks nlb-dns secret help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks nlb-dns", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks nlb-dns help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks storage", "Name": "attachments", "Alias": "", "Aliases": null, "Description": "List all storage volume attachments of a worker in a cluster.", "Usage": "ibmcloud ks storage attachments --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage attachment", "Name": "create", "Alias": "", "Aliases": null, "Description": "Attach a storage volume to a worker node.", "Usage": "ibmcloud ks storage attachment create --cluster CLUSTER --volume VOLUME --worker WORKER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "volume", "Description": "Specify the volume ID. To list available volumes, run 'ibmcloud ks storage volume ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage attachment", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a volume attachment from a worker node.", "Usage": "ibmcloud ks storage attachment rm --attachment ATTACHMENT --cluster CLUSTER --worker WORKER [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "attachment", "Description": "Specify the volume attachment ID. To list available attachments, run 'ibmcloud ks storage attachment ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage attachment", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a volume attachment in a cluster.", "Usage": "ibmcloud ks storage attachment get --attachment ATTACHMENT --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "attachment", "Description": "Specify the volume attachment ID. To list available attachments, run 'ibmcloud ks storage attachment ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage attachment", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all storage volume attachments of a worker in a cluster.", "Usage": "ibmcloud ks storage attachment ls --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage attachment", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks storage attachment help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks storage", "Name": "volumes", "Alias": "", "Aliases": null, "Description": "List the details of volumes.", "Usage": "ibmcloud ks storage volumes [--cluster CLUSTER] [--output OUTPUT] [--provider PROVIDER] [-q] [--zone ZONE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "A zone to filter for. To list available zones, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage volume", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a volume.", "Usage": "ibmcloud ks storage volume get --volume VOLUME [--output OUTPUT] [-q]", "Flags": [ { "Name": "volume", "Description": "Specify the volume ID. To list available volumes, run 'ibmcloud ks storage volume ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage volume", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the details of volumes.", "Usage": "ibmcloud ks storage volume ls [--cluster CLUSTER] [--output OUTPUT] [--provider PROVIDER] [-q] [--zone ZONE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Filter the list for a specific infrastructure provider.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "A zone to filter for. To list available zones, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "ks storage volume", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks storage volume help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks storage", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks storage help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "va", "Alias": "", "Aliases": null, "Description": "View a detailed vulnerability assessment report for a container that runs in a cluster.", "Usage": "ibmcloud ks va --container CONTAINER [--extended] [--output OUTPUT] [-q] (--configuration-issues | --vulnerabilities)", "Flags": [ { "Name": "container", "Description": "Specify the ID of a container in an Kubernetes Service cluster. To find the ID of your container, run 'ibmcloud ks va \u003ccluster name or ID\u003e' and export the environment variable in the output. Then, run 'kubectl get pods' to list your pods, run 'kubectl describe pod \u003cpod name\u003e', and find the 'Container ID' field for the container. Finally, remove the 'docker://' prefix from the ID before you use the container ID in this command.", "HasValue": true, "Hidden": false }, { "Name": "extended", "Description": "Extend the command output to show more fix information for vulnerable packages.", "HasValue": false, "Hidden": false }, { "Name": "vulnerabilities", "Description": "Restrict the command output to show package vulnerabilities only.", "HasValue": true, "Hidden": false }, { "Name": "configuration-issues", "Description": "Restrict the command output to show configuration issues only.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "deprecated" }, { "Namespace": "ks", "Name": "vlans", "Alias": "", "Aliases": null, "Description": "List available public and private VLANs for a zone.", "Usage": "ibmcloud ks vlans --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vlan", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List available public and private VLANs for a zone.", "Usage": "ibmcloud ks vlan ls --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vlan spanning", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the VLAN spanning status for your IBM Cloud classic infrastructure account.", "Usage": "ibmcloud ks vlan spanning get [--output OUTPUT] [-q] [--region REGION]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "Specify the region to target. If a region is not already targeted, this argument must be specified. To check if a region is targeted, run 'ibmcloud target'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks vlan spanning", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks vlan spanning help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks vlan", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks vlan help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "workers", "Alias": "", "Aliases": null, "Description": "List all worker nodes in a cluster.", "Usage": "ibmcloud ks workers --cluster CLUSTER [--output OUTPUT] [-q] [--show-delete-reason] [--show-deleted] [--show-pools] [--worker-pool POOL]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Show only worker nodes that belong to the worker pool you specify.", "HasValue": true, "Hidden": false }, { "Name": "show-pools", "Description": "See the worker pool that each worker belongs to.", "HasValue": false, "Hidden": false }, { "Name": "show-deleted", "Description": "Show worker nodes that were deleted from the cluster.", "HasValue": false, "Hidden": false }, { "Name": "show-delete-reason", "Description": "Show the reason for worker node deletion.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add a worker node to a cluster. The IBM Cloud account will be charged. Several flags can be omitted if all of the workers in the cluster are uniform. This command is deprecated. Create a worker pool by running 'ibmcloud ks worker-pool create' or add workers to an existing worker pool by running 'ibmcloud ks worker-pool resize'.", "Usage": "ibmcloud ks worker add --cluster CLUSTER --flavor FLAVOR [--disable-disk-encrypt] [--hardware HARDWARE] [--private-vlan VLAN] [--public-vlan VLAN] [-q] [--workers COUNT]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "workers", "Description": "The number of cluster worker nodes. Defaults to 1.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "public-vlan", "Description": "Specify the ID of the public VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "hardware", "Description": "The level of hardware isolation for your worker node. Use 'dedicated' to have available physical resources dedicated to you only, or 'shared' to allow physical resources to be shared with other IBM customers. For IBM Cloud Public accounts, the default value is shared. For IBM Cloud Dedicated accounts, dedicated is the only available option.", "HasValue": true, "Hidden": false }, { "Name": "disable-disk-encrypt", "Description": "Disable encryption on a worker node.", "HasValue": false, "Hidden": false }, { "Name": "file", "Description": "Provide a file that contains input parameters in YAML format.", "HasValue": true, "Hidden": false }, { "Name": "machine-type", "Description": "The flavor of the worker node. To see available flavors, run 'ibmcloud ks machine-types --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks machine-types' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all worker nodes in a cluster.", "Usage": "ibmcloud ks worker ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-delete-reason] [--show-deleted] [--show-pools] [--worker-pool POOL]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Show only worker nodes that belong to the worker pool you specify.", "HasValue": true, "Hidden": false }, { "Name": "show-pools", "Description": "See the worker pool that each worker belongs to.", "HasValue": false, "Hidden": false }, { "Name": "show-deleted", "Description": "Show worker nodes that were deleted from the cluster.", "HasValue": false, "Hidden": false }, { "Name": "show-delete-reason", "Description": "Show the reason for worker node deletion.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a worker node.", "Usage": "ibmcloud ks worker get --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "reboot", "Alias": "", "Aliases": null, "Description": "Restart a worker node.", "Usage": "ibmcloud ks worker reboot --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [--hard] [-q] [--skip-master-health]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "hard", "Description": "Force a hard restart of a worker node by cutting off power to the worker node. Use this option if the worker node is unresponsive or the worker node has a Docker hang.", "HasValue": false, "Hidden": false }, { "Name": "skip-master-health", "Description": "Skips checking of master health before initiating action.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker, w", "Description": "Specify one or more worker IDs.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "reload", "Alias": "", "Aliases": null, "Description": "Delete the data, reimage, and reinstall Kubernetes with the latest patch version on a worker node in a classic cluster. This action cannot be undone.", "Usage": "ibmcloud ks worker reload --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [-q] [--skip-master-health]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "skip-master-health", "Description": "Skips checking of master health before initiating action.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker, w", "Description": "Specify one or more worker IDs.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a worker node from a cluster.", "Usage": "ibmcloud ks worker rm --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker, w", "Description": "Specify one or more worker IDs.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update one or more worker nodes in a classic cluster to a new Kubernetes version. During the update, the worker node is updated with the latest image and data is permanently deleted if not stored on persistent storage.", "Usage": "ibmcloud ks worker update --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "force-update", "Description": "Attempt the update even if the change is greater than two minor versions from the worker node's current version.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker, w", "Description": "Specify one or more worker IDs.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "replace", "Alias": "", "Aliases": null, "Description": "Delete a worker node and replace it with a new worker node in the same worker pool.", "Usage": "ibmcloud ks worker replace --cluster CLUSTER --worker WORKER [-f] [-q] [--update]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker, w", "Description": "Specify the worker ID. To list available workers, run 'ibmcloud ks workers'.", "HasValue": true, "Hidden": false }, { "Name": "update", "Description": "Update the worker node to the same major and minor version of the master and the latest patch.", "HasValue": false, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "worker-pools", "Alias": "", "Aliases": null, "Description": "List all worker pools in a cluster.", "Usage": "ibmcloud ks worker-pools --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool create", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Add a worker pool to a classic cluster. No worker nodes are created until zones are added to the worker pool.", "Usage": "ibmcloud ks worker-pool create classic --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--hardware HARDWARE] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q]", "Flags": [ { "Name": "name", "Description": "Enter a name for the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "size-per-zone", "Description": "Specify the desired number of workers per zone in this worker pool.", "HasValue": true, "Hidden": false }, { "Name": "hardware", "Description": "The level of hardware isolation for your worker node. Use 'dedicated' to have available physical resources dedicated to you only, or 'shared' to allow physical resources to be shared with other IBM customers. For IBM Cloud Public accounts, the default value is shared. For IBM Cloud Dedicated accounts, dedicated is the only available option.", "HasValue": true, "Hidden": false }, { "Name": "disable-disk-encrypt", "Description": "Disable encryption on a worker node.", "HasValue": false, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "label, l", "Description": "Sets labels on all the workers in the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "machine-type", "Description": "The flavor of the worker node. To see available flavors, run 'ibmcloud ks machine-types --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks machine-types' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool create", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Add a worker pool to a VPC Gen 1 cluster. No worker nodes are created until zones are added to the worker pool.", "Usage": "ibmcloud ks worker-pool create vpc-classic --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--entitlement ENTITLEMENT] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q] [--vpc-id ID]", "Flags": [ { "Name": "name", "Description": "Enter a name for the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "size-per-zone", "Description": "Specify the desired number of workers per zone in this worker pool.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "The ID of the VPC in which to create the worker nodes, which must match the VPC that the cluster is in. To list the cluster's VPC ID, run 'ibmcloud ks cluster get -c \u003ccluster_name_or_ID\u003e'. If this flag is not provided, then the worker pool defaults to the VPC ID of existing worker pools in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "hardware", "Description": "The level of hardware isolation for your worker node. 'public' allows physical resources to be shared with other IBM customers.", "HasValue": true, "Hidden": false }, { "Name": "disable-disk-encrypt", "Description": "Disable encryption on a worker node.", "HasValue": false, "Hidden": false }, { "Name": "dedicated-host-pool", "Description": "The ID of the dedicated host pool to run your workers.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "label, l", "Description": "Sets labels on all the workers in the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool create", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Add a worker pool to a VPC Gen 2 cluster. No worker nodes are created until zones are added to the worker pool.", "Usage": "ibmcloud ks worker-pool create vpc-gen2 --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--crk CRK] [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance INSTANCE] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q] [--secondary-storage STORAGE] [--security-group GROUP ...] [--vpc-id ID]", "Flags": [ { "Name": "name", "Description": "Enter a name for the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of a worker node. To see available flavors, run 'ibmcloud ks flavor ls --zone \u003czone name\u003e' (for public IBM Cloud accounts) or 'ibmcloud ks flavor ls' (for IBM Cloud Dedicated accounts).", "HasValue": true, "Hidden": false }, { "Name": "secondary-storage", "Description": "The secondary storage option for the flavor. To view the secondary storage options that are available for a flavor, run 'ibmcloud ks flavor get --provider vpc-gen2 --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "size-per-zone", "Description": "Specify the desired number of workers per zone in this worker pool.", "HasValue": true, "Hidden": false }, { "Name": "vpc-id", "Description": "The ID of the VPC in which to create the worker nodes, which must match the VPC that the cluster is in. To list the cluster's VPC ID, run 'ibmcloud ks cluster get -c \u003ccluster_name_or_ID\u003e'. If this flag is not provided, then the worker pool defaults to the VPC ID of existing worker pools in the cluster.", "HasValue": true, "Hidden": false }, { "Name": "security-group", "Description": "Optional. Specify up to five security group IDs to apply to all workers in the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "hardware", "Description": "The level of hardware isolation for your worker node. 'public' allows physical resources to be shared with other IBM customers.", "HasValue": true, "Hidden": false }, { "Name": "disable-disk-encrypt", "Description": "Disable encryption on a worker node.", "HasValue": false, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "kms-instance", "Description": "The ID of the KMS instance to use for local disk encryption. To list available KMS instances, run 'ibmcloud ks kms instance ls'.", "HasValue": true, "Hidden": false }, { "Name": "crk", "Description": "The ID of the root key in your KMS instance to use for local disk encryption. To list available root keys, run 'ibmcloud ks kms crk ls --instance-id \u003ckms_instance\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "dedicated-host-pool", "Description": "The ID of the dedicated host pool to run your workers.", "HasValue": true, "Hidden": false }, { "Name": "kms-account-id", "Description": "The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.", "HasValue": true, "Hidden": false }, { "Name": "label, l", "Description": "Sets labels on all the workers in the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool create", "Name": "satellite", "Alias": "", "Aliases": null, "Description": "Add a worker pool to an IBM Cloud Satellite cluster. No worker nodes are created until zones are added to the worker pool.", "Usage": "ibmcloud ks worker-pool create satellite --cluster CLUSTER --host-label LABEL [--host-label LABEL ...] --name NAME --size-per-zone SIZE --zone ZONE [--entitlement ENTITLEMENT] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q]", "Flags": [ { "Name": "name", "Description": "Enter a name for the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "size-per-zone", "Description": "Specify the desired number of workers per zone in this worker pool.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "entitlement", "Description": "Set this flag to 'ocp_entitled' only if you use this cluster with a license such as a Cloud Pak that has an OpenShift entitlement.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "label, l", "Description": "Sets labels on all the workers in the worker pool.", "HasValue": true, "Hidden": false }, { "Name": "host-label, hl", "Description": "Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run 'ibmcloud sat host get --host \u003chost_name_or_ID\u003e --location \u003clocation_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool create", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker-pool create help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a worker pool from a cluster.", "Usage": "ibmcloud ks worker-pool rm --cluster CLUSTER --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all worker pools in a cluster.", "Usage": "ibmcloud ks worker-pool ls --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "get", "Alias": "", "Aliases": null, "Description": "List the details of a worker pool.", "Usage": "ibmcloud ks worker-pool get --cluster CLUSTER --worker-pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "rebalance", "Alias": "", "Aliases": null, "Description": "Rebalance a worker pool in a cluster. Rebalancing adds and removes worker nodes to match the worker pool's size per zone. Satellite worker pools might remove manually assigned nodes if they do not match the worker pool's host labels.", "Usage": "ibmcloud ks worker-pool rebalance --cluster CLUSTER --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "resize", "Alias": "", "Aliases": null, "Description": "Resize the worker pool to the number of workers per zone that you specify.", "Usage": "ibmcloud ks worker-pool resize --cluster CLUSTER --size-per-zone SIZE --worker-pool POOL [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "size-per-zone", "Description": "Specify the desired number of workers per zone in this worker pool.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "zones", "Alias": "", "Aliases": null, "Description": "View the zones attached to a worker pool.", "Usage": "ibmcloud ks worker-pool zones --cluster CLUSTER --worker-pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool taint", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set Kubernetes taints for all worker nodes in a worker pool. Taints prevent pods without matching tolerations from running on the worker nodes.", "Usage": "ibmcloud ks worker-pool taint set --cluster CLUSTER --taint TAINT [--taint TAINT ...] --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "taint", "Description": "Sets taints on all the workers in the worker pool. Specify the Kubernetes taint in the format 'key=value:effect'. The 'key=value' is a pair such as 'env=prod' that you use to manage the worker node taint and matching pod tolerations. The 'effect' is a Kubernetes taint effect such as 'NoSchedule' that describes how the taint works.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool taint", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove all Kubernetes taints from all worker nodes in a worker pool.", "Usage": "ibmcloud ks worker-pool taint rm --cluster CLUSTER --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool taint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker-pool taint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool label", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set custom Kubernetes labels for all worker nodes in a worker pool.", "Usage": "ibmcloud ks worker-pool label set --cluster CLUSTER --label LABEL [--label LABEL ...] --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "label, l", "Description": "Set custom Kubernetes labels in the format 'key=value' for all the worker nodes in the worker pool. For multiple labels, repeat this flag. To keep any existing custom labels on the worker pool, include those labels with this flag.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool label", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove all custom Kubernetes labels from all worker nodes in a worker pool.", "Usage": "ibmcloud ks worker-pool label rm --cluster CLUSTER --worker-pool POOL [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool label", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker-pool label help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool operating-system", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set the operating system. After you set the operating system, you must update your workers by running either 'ibmcloud ks worker update' or 'ibmcloud ks worker replace'.", "Usage": "ibmcloud ks worker-pool operating-system set --cluster CLUSTER --operating-system SYSTEM --worker-pool POOL [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "Specify the name of the operating system.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool operating-system", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker-pool operating-system help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks worker-pool", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks worker-pool help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "zones", "Alias": "", "Aliases": null, "Description": "List all availability zones in a region.", "Usage": "ibmcloud ks zones --provider PROVIDER [-l LOCATION ...] [--output OUTPUT] [-q] [--region-only] [--show-flavors]", "Flags": [ { "Name": "region-only", "Description": "Show only regional data centers.", "HasValue": false, "Hidden": false }, { "Name": "show-flavors", "Description": "Show the available worker node flavors in the zone for VPC.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "l, location", "Description": "A location to filter for. To list available locations, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all availability zones in a region.", "Usage": "ibmcloud ks zone ls --provider PROVIDER [-l LOCATION ...] [--output OUTPUT] [-q] [--region-only] [--show-flavors]", "Flags": [ { "Name": "region-only", "Description": "Show only regional data centers.", "HasValue": false, "Hidden": false }, { "Name": "show-flavors", "Description": "Show the available worker node flavors in the zone for VPC.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "l, location", "Description": "A location to filter for. To list available locations, run 'ibmcloud ks locations'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone add", "Name": "classic", "Alias": "", "Aliases": null, "Description": "Add a zone to one or more worker pools in a classic cluster.", "Usage": "ibmcloud ks zone add classic --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [--output OUTPUT] [--private-vlan VLAN] [-q] (--private-only | --public-vlan VLAN)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'. When you specify a private VLAN, you must also specify either the '--public-vlan' flag or the '--private-only' flag.", "HasValue": true, "Hidden": false }, { "Name": "public-vlan", "Description": "Specify the ID of the public VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "private-only", "Description": "Use this flag to prevent a public VLAN from being created. Required only when you specify the '--private-vlan' flag without specifying the '--public-vlan' flag.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "worker-pools", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone add", "Name": "vpc-classic", "Alias": "", "Aliases": null, "Description": "Add a zone to one or more worker pools in a VPC Gen 1 cluster.", "Usage": "ibmcloud ks zone add vpc-classic --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "The VPC subnet to assign the cluster. To list available subnets, run 'ibmcloud ks subnets --provider vpc-classic --vpc-id \u003cvpc-id\u003e --zone \u003cvpc-zone\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone add", "Name": "vpc-gen2", "Alias": "", "Aliases": null, "Description": "Add a zone to one or more worker pools in a VPC Gen 2 cluster.", "Usage": "ibmcloud ks zone add vpc-gen2 --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet-id", "Description": "The VPC subnet to assign the cluster. To list available subnets, run 'ibmcloud ks subnets --provider vpc-gen2 --vpc-id \u003cvpc-id\u003e --zone \u003cvpc-zone\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool", "Description": "Specify a worker pool.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone add", "Name": "satellite", "Alias": "", "Aliases": null, "Description": "Add a zone to one or more worker pools in a Satellite cluster.", "Usage": "ibmcloud ks zone add satellite --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "worker-pools", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone add", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks zone add help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a zone from one or more worker pools in a cluster.", "Usage": "ibmcloud ks zone rm --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker-pools", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone", "Name": "network-set", "Alias": "", "Aliases": null, "Description": "Set the network metadata in a specific zone for the given worker pools in a classic cluster.", "Usage": "ibmcloud ks zone network-set --cluster CLUSTER --private-vlan VLAN --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [-f] [-q] (--private-only | --public-vlan VLAN)", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "Specify the zone for the worker pool in a multizone cluster. To list available zones, run 'ibmcloud ks zone ls'.", "HasValue": true, "Hidden": false }, { "Name": "private-vlan", "Description": "Specify the ID of the private VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "public-vlan", "Description": "Specify the ID of the public VLAN. To see available VLANs, run 'ibmcloud ks vlan ls --zone \u003czone name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "private-only", "Description": "Unset the public VLAN so that the workers in this zone are connected to a private VLAN only.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "worker-pools", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "The name of the worker pool to modify. To specify multiple worker pools, use multiple flags, such as '-p pool1 -p pool2'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks zone", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks zone help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "security-groups", "Alias": "", "Aliases": null, "Description": "List all security groups associated with a cluster.", "Usage": "ibmcloud ks security-groups --cluster CLUSTER [--attached-to ATTACHED] [--managed-by MANAGER] [--output OUTPUT] [-q] [--scope SCOPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "attached-to", "Description": "Filter the security groups by the components they are attached to.", "HasValue": true, "Hidden": false }, { "Name": "scope", "Description": "Specify 'cluster' to return security groups scoped to the cluster. Specify 'vpc' to return security groups scoped to the entire VPC.", "HasValue": true, "Hidden": false }, { "Name": "managed-by", "Description": "Specify 'user' to return the security groups created by user. Specify 'ibm' to return only the security groups managed by IBM.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks security-group", "Name": "reset", "Alias": "", "Aliases": null, "Description": "Deletes all existing security group rules, and reapplies default rules.", "Usage": "ibmcloud ks security-group reset --cluster CLUSTER --security-group GROUP [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "security-group, sg", "Description": "Specify security group ID.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks security-group", "Name": "sync", "Alias": "", "Aliases": null, "Description": "Reapplies default security group rules that do not exist. Does not delete any preexisting rules.", "Usage": "ibmcloud ks security-group sync --cluster CLUSTER --security-group GROUP [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "security-group, sg", "Description": "Specify security group ID.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks security-group", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all security groups associated with a cluster.", "Usage": "ibmcloud ks security-group ls --cluster CLUSTER [--attached-to ATTACHED] [--managed-by MANAGER] [--output OUTPUT] [-q] [--scope SCOPE]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "attached-to", "Description": "Filter the security groups by the components they are attached to.", "HasValue": true, "Hidden": false }, { "Name": "scope", "Description": "Specify 'cluster' to return security groups scoped to the cluster. Specify 'vpc' to return security groups scoped to the entire VPC.", "HasValue": true, "Hidden": false }, { "Name": "managed-by", "Description": "Specify 'user' to return the security groups created by user. Specify 'ibm' to return only the security groups managed by IBM.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks security-group", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks security-group help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks dedicated", "Name": "hosts", "Alias": "", "Aliases": null, "Description": "List all dedicated host instances.", "Usage": "ibmcloud ks dedicated hosts --pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a dedicated host.", "Usage": "ibmcloud ks dedicated host create --flavor FLAVOR --pool POOL --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "zone", "Description": "The zone to create the dedicated host in.", "HasValue": true, "Hidden": false }, { "Name": "flavor", "Description": "The flavor of the dedicated host.", "HasValue": true, "Hidden": false }, { "Name": "pool", "Description": "The ID of the dedicated host pool to add the dedicated host to. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all dedicated host instances.", "Usage": "ibmcloud ks dedicated host ls --pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a dedicated host.", "Usage": "ibmcloud ks dedicated host get --host HOST --pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The ID of the dedicated host. To list available dedicated hosts, run 'ibmcloud ks dedicated host ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a dedicated host. This action cannot be undone.", "Usage": "ibmcloud ks dedicated host rm --host HOST --pool POOL [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The ID of the dedicated host. To list available dedicated hosts, run 'ibmcloud ks dedicated host ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host placement", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable dedicated host placement.", "Usage": "ibmcloud ks dedicated host placement enable --host HOST --pool POOL [-q]", "Flags": [ { "Name": "host", "Description": "The ID of the dedicated host. To list available dedicated hosts, run 'ibmcloud ks dedicated host ls'. ", "HasValue": true, "Hidden": false }, { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host placement", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable dedicated host placement.", "Usage": "ibmcloud ks dedicated host placement disable --host HOST --pool POOL [-q]", "Flags": [ { "Name": "host", "Description": "The ID of the dedicated host. To list available dedicated hosts, run 'ibmcloud ks dedicated host ls'. ", "HasValue": true, "Hidden": false }, { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated host placement", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks dedicated host placement help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks dedicated host", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks dedicated host help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks dedicated", "Name": "pools", "Alias": "", "Aliases": null, "Description": "List all dedicated host pool instances.", "Usage": "ibmcloud ks dedicated pools [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated pool", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a dedicated host pool.", "Usage": "ibmcloud ks dedicated pool create --flavor-class CLASS --metro METRO --name NAME [--output OUTPUT] [-q]", "Flags": [ { "Name": "name", "Description": "The name of the dedicated host pool.", "HasValue": true, "Hidden": false }, { "Name": "metro", "Description": "The metro to create the dedicated host pool in, such as 'dal' or 'wdc'.", "HasValue": true, "Hidden": false }, { "Name": "flavor-class", "Description": "The flavor class of the dedicated host pool. To see allowed options, run 'ibmcloud ks dedicated flavors --zone \u003czone\u003e --provider \u003cprovider\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated pool", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all dedicated host pool instances.", "Usage": "ibmcloud ks dedicated pool ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated pool", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a dedicated host pool.", "Usage": "ibmcloud ks dedicated pool get --pool POOL [--output OUTPUT] [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated pool", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a dedicated host pool. This action cannot be undone.", "Usage": "ibmcloud ks dedicated pool rm --pool POOL [-q]", "Flags": [ { "Name": "pool", "Description": "The ID of the dedicated host pool. To list available dedicated host pools, run 'ibmcloud ks dedicated pool ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated pool", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks dedicated pool help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks dedicated", "Name": "flavors", "Alias": "", "Aliases": null, "Description": "View dedicated host flavors.", "Usage": "ibmcloud ks dedicated flavors --provider PROVIDER --zone ZONE [--output OUTPUT] [-q]", "Flags": [ { "Name": "zone", "Description": "The zone to search for dedicated host flavors.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "The provider to use to search for dedicated host flavors.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "ks dedicated", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks dedicated help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "experimental", "Alias": "", "Aliases": null, "Description": "[Expires on 2024-09-01] Experiment with new commands. IMPORTANT: Commands here will retire after the [date] in their description.", "Usage": "ibmcloud ks experimental [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "ks", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud ks help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat connector", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a Satellite connector.", "Usage": "ibmcloud sat connector create --name NAME --region REGION [-q]", "Flags": [ { "Name": "name", "Description": "The name for the Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "The IBM Cloud region to manage your Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat connector", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a Satellite Connector.", "Usage": "ibmcloud sat connector get --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat connector", "Name": "ls", "Alias": "", "Aliases": null, "Description": "View the Satellite Connectors in your IBM Cloud account.", "Usage": "ibmcloud sat connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]", "Flags": [ { "Name": "after", "Description": "Show Satellite Connectors after the given cursor.", "HasValue": true, "Hidden": false }, { "Name": "first", "Description": "View the next Satellite Connectors, up to the first number of Connectors.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat connector", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a Satellite connector.", "Usage": "ibmcloud sat connector rm --connector-id ID [-f] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat connector", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat connector help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "locations", "Alias": "", "Aliases": null, "Description": "List all Satellite locations in your IBM Cloud account.", "Usage": "ibmcloud sat locations [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a Satellite location. A Satellite location is a representation of an environment in your infrastructure provider. After you create a location, attach hosts from separate zones of your backing infrastructure environment with the 'ibmcloud sat host attach' command.", "Usage": "ibmcloud sat location create --managed-from REGION --name NAME [--capability CAPABILITY ...] [--coreos-enabled] [--cos-bucket BUCKET] [--description DESCRIPTION] [--ha-zone ZONE ...] [--physical-address ADDRESS] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--provider PROVIDER] [--provider-credential CREDENTIAL] [--provider-region REGION] [-q] [--service-subnet SUBNET]", "Flags": [ { "Name": "pod-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for pods. This option is used only if you enable Red Hat CoreOS with the '--coreos-enabled' option. The subnet must be '/23' or larger. See 'https://ibm.biz/sat-location-create'. Default value: '172.16.0.0/16", "HasValue": true, "Hidden": false }, { "Name": "service-subnet", "Description": "Specify a custom subnet CIDR to provide private IP addresses for services. This option is used only if you enable Red Hat CoreOS with the '--coreos-enabled' option. The subnet must be '/24' or larger. See 'https://ibm.biz/sat-location-create'. Default value: '172.20.0.0/16'", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Specify a name for the Satellite location. Location names must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be fewer than 36 characters. Do not reuse names, even if the other location is deleted.", "HasValue": true, "Hidden": false }, { "Name": "managed-from", "Description": "Select the IBM Cloud region to manage your Satellite location from. Choose a region close to your on-prem data center for better performance. See 'https://ibm.biz/sat-region'.", "HasValue": true, "Hidden": false }, { "Name": "ha-zone", "Description": "Specify the zone for your location. For high availability, specify 3 zones for your location as '--ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME'. The names of the zones must match exactly the names of the corresponding zones in your infrastructure provider where you plan to create hosts.", "HasValue": true, "Hidden": false }, { "Name": "cos-bucket", "Description": "Specify the name of the IBM Cloud Object Storage bucket to store your Satellite location control plane data. Otherwise, a new bucket is created for you.", "HasValue": true, "Hidden": false }, { "Name": "description", "Description": "Enter a description for the Satellite location.", "HasValue": true, "Hidden": false }, { "Name": "logging-account-id", "Description": "The IBM Cloud account ID with the instance of IBM Log Analysis with LogDNA that you want to forward your Satellite logs to. This option is available only in select environments.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Indicate the infrastructure provider to use for the Satellite location. If you include this option, you must also include the '--provider-credential' option.", "HasValue": true, "Hidden": false }, { "Name": "provider-region", "Description": "Specify the region in the infrastructure provider where you plan to create the hosts for the Satellite location. If you include this option, you must also include the '--provider' option.", "HasValue": true, "Hidden": false }, { "Name": "provider-credential", "Description": "Specify the path to a JSON file on your local machine that has the credentials of the infrastructure provider for the Satellite location. The credential format is provider-specific. See 'http://ibm.biz/sat-infra-creds'.", "HasValue": true, "Hidden": false }, { "Name": "coreos-enabled", "Description": "Enable Red Hat CoreOS features for the Satellite location. This action cannot be undone. See 'https://ibm.biz/infra-os'.", "HasValue": false, "Hidden": false }, { "Name": "physical-address", "Description": "The physical address of the Satellite location.", "HasValue": true, "Hidden": false }, { "Name": "capability", "Description": "A capability of the Satellite location.", "HasValue": true, "Hidden": false }, { "Name": "logging-key", "Description": "The logging instance key.", "HasValue": true, "Hidden": false }, { "Name": "activity-tracker-key", "Description": "The Activity Tracker instance key.", "HasValue": true, "Hidden": false }, { "Name": "pod-network-interface-selection", "Description": "The method for selecting the node network interface for the internal pod network. This option can be used only if you also enable Red Hat CoreOS with the '--coreos-enabled' option. To provide a direct URL or IP address, specify `can-reach=\u003curl\u003e` or `can-reach=\u003cip_address\u003e`. To choose a network interface, specify 'interface=\u003cnetwork_interface\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update the name or description of a Satellite location.", "Usage": "ibmcloud sat location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]", "Flags": [ { "Name": "location-id", "Description": "The ID of the Satellite location. To find the location ID, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Specify a new name for the Satellite location. Location names must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be fewer than 36 characters. Do not reuse names, including names of deleted locations.", "HasValue": true, "Hidden": false }, { "Name": "description", "Description": "Enter a new description for the Satellite location. The length of the description is limited to 400 bytes.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a Satellite location.", "Usage": "ibmcloud sat location get --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite locations in your IBM Cloud account.", "Usage": "ibmcloud sat location ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a location. Before you run this command, back up your configurations and remove any hosts and clusters that run in the location. The underlying host infrastructure is not automatically deleted when you delete a location. This action cannot be undone.", "Usage": "ibmcloud sat location rm --location LOCATION [-f] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location dns", "Name": "register", "Alias": "", "Aliases": null, "Description": "Set a subdomain for the hosts assigned to the control plane in a Satellite location.", "Usage": "ibmcloud sat location dns register --ip IP [--ip IP ...] --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "ip", "Description": "Specify the IP address for each control plane host, in the format '--ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3'. For multizone clusters, use one IP address from each zone. To find the IP address, run 'ibmcloud sat host ls --location \u003clocation_ID_or_name\u003e' and look for 'Worker IP' for hosts labeled 'infrastructure'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location dns", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the registered subdomains in a Satellite location.", "Usage": "ibmcloud sat location dns ls --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location dns", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a registered subdomain in a Satellite location.", "Usage": "ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "subdomain", "Description": "Specify the subdomain name. To list existing subdomains, run 'ibmcloud sat location dns ls --location \u003cID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat location dns", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat location dns help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat location", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat location help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "endpoints", "Alias": "", "Aliases": null, "Description": "List all endpoints in a Satellite location.", "Usage": "ibmcloud sat endpoints [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an endpoint.", "Usage": "ibmcloud sat endpoint get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all endpoints in a Satellite location.", "Usage": "ibmcloud sat endpoint ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create an endpoint.", "Usage": "ibmcloud sat endpoint create --dest-hostname HOSTNAME --dest-port PORT --dest-type TYPE --name NAME --source-protocol PROTOCOL [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--output OUTPUT] [-q] [--sni SNI] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Provide a name for the endpoint.", "HasValue": true, "Hidden": false }, { "Name": "dest-hostname", "Description": "Indicate the fully qualified domain name (FQDN) or the externally accessible IP address of the destination that you want to connect to. For 'cloud' endpoints, this value must resolve to a public IP address or to a private IP address that is accessible within IBM Cloud such as a private cloud service endpoint. For 'location' endpoints, this value must resolve from and be reachable from the control plane hosts for Satellite locations or where the agent runs for Satellite Connector.", "HasValue": true, "Hidden": false }, { "Name": "dest-port", "Description": "Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.", "HasValue": true, "Hidden": false }, { "Name": "dest-protocol", "Description": "Specify the destination's protocol. If you do not specify this option, the destination protocol is inherited from the source protocol.", "HasValue": true, "Hidden": false }, { "Name": "sni", "Description": "Specify the server name indicator, if you specify a 'tls' or 'https' source protocol and want a separate hostname to be added to the TLS handshake.", "HasValue": true, "Hidden": false }, { "Name": "idle-timeout-seconds", "Description": "Specify the timeout interval in seconds for active connections to the destination. Make sure your timeout is compatible with the destination service and protocol 'keep-alive' settings.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update an endpoint. Only the options that you specify are updated.", "Usage": "ibmcloud sat endpoint update --endpoint ENDPOINT [--dest-hostname HOSTNAME] [--dest-port PORT] [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--name NAME] [-q] [--sni SNI] [--source-protocol PROTOCOL] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Provide a new name for the endpoint.", "HasValue": true, "Hidden": false }, { "Name": "dest-type", "Description": "", "HasValue": true, "Hidden": false }, { "Name": "source-protocol", "Description": "Provide the protocol that the source uses to connect the destination resource. See 'http://ibm.biz/endpoint-protocols'.", "HasValue": true, "Hidden": false }, { "Name": "dest-hostname", "Description": "Indicate the fully qualified domain name (FQDN) or the externally accessible IP address of the destination that you want to connect to. For 'cloud' endpoints, this value must resolve to a public IP address or to a private IP address that is accessible within IBM Cloud such as a private cloud service endpoint. For 'location' endpoints, this value must resolve from and be reachable from the control plane hosts for Satellite locations or where the agent runs for Satellite Connector.", "HasValue": true, "Hidden": false }, { "Name": "dest-port", "Description": "Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.", "HasValue": true, "Hidden": false }, { "Name": "dest-protocol", "Description": "Specify the destination's protocol. If you do not specify this option, the destination protocol is inherited from the source protocol.", "HasValue": true, "Hidden": false }, { "Name": "sni", "Description": "Specify the server name indicator, if you specify a 'tls' or 'https' source protocol and want a separate hostname to be added to the TLS handshake.", "HasValue": true, "Hidden": false }, { "Name": "idle-timeout-seconds", "Description": "Specify the timeout interval in seconds for active connections to the destination. Make sure your timeout is compatible with the destination service and protocol 'keep-alive' settings.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete an endpoint.", "Usage": "ibmcloud sat endpoint rm --endpoint ENDPOINT [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable an endpoint.", "Usage": "ibmcloud sat endpoint enable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable an endpoint.", "Usage": "ibmcloud sat endpoint disable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint authn", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set authentication settings for an endpoint. There are two TLS connections in the request flow. The 'source' options refer to the TLS handshake between the source and the Connector service. The 'destination' options refer to the TLS handshake between the Connector service and your destination or target server. You can provide certificates for one or both of these connections. Unspecified settings are set to their default values.", "Usage": "ibmcloud sat endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "dest-tls-mode", "Description": "The destination TLS mode.", "HasValue": true, "Hidden": false }, { "Name": "dest-cert-file", "Description": "The client certificate used to authenticate with the destination server. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-key-file", "Description": "The client private key used to encrypt the client certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the destination server's certificate. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-tls-mode", "Description": "The source TLS mode.", "HasValue": true, "Hidden": false }, { "Name": "source-cert-file", "Description": "The server certificate to present to the source client. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-key-file", "Description": "The server private key used to encrypt the server certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint authn", "Name": "rotate", "Alias": "", "Aliases": null, "Description": "Replace existing authentication certificates with new ones. There are two TLS connections in the request flow. The 'source' options refer to the TLS handshake between the source and the Connector service. The 'destination' options refer to the TLS handshake between the Connector service and your destination or target server. You can provide certificates for one or both of these connections. Only the certificates that you specify are replaced.", "Usage": "ibmcloud sat endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "dest-cert-file", "Description": "The client certificate used to authenticate with the destination server. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-key-file", "Description": "The client private key used to encrypt the client certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the destination server's certificate. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-cert-file", "Description": "The server certificate to present to the source client. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-key-file", "Description": "The server private key used to encrypt the server certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint authn", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the authentication settings for an endpoint.", "Usage": "ibmcloud sat endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint authn", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat endpoint authn help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "acls", "Alias": "", "Aliases": null, "Description": "List all ACLs for a Satellite connector or location.", "Usage": "ibmcloud sat acls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of an ACL.", "Usage": "ibmcloud sat acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all ACLs for a Satellite connector or location.", "Usage": "ibmcloud sat acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create an ACL.", "Usage": "ibmcloud sat acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name for the ACL.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to enable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update the name of an ACL.", "Usage": "ibmcloud sat acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The new name for the ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete an ACL.", "Usage": "ibmcloud sat acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl subnet", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add one or more subnets to an ACL.", "Usage": "ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl subnet", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove one or more subnets from an ACL.", "Usage": "ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl subnet", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat acl subnet help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "endpoints", "Alias": "", "Aliases": null, "Description": "List all enabled endpoints for an ACL.", "Usage": "ibmcloud sat acl endpoints --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl endpoint", "Name": "add", "Alias": "", "Aliases": null, "Description": "Add one or more enabled endpoints to an ACL.", "Usage": "ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to enable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl endpoint", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove one or more enabled endpoints from an ACL.", "Usage": "ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to disable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl endpoint", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all enabled endpoints for an ACL.", "Usage": "ibmcloud sat acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat acl endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat acl", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat acl help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "agents", "Alias": "", "Aliases": null, "Description": "List all Agents for a Satellite Connector.", "Usage": "ibmcloud sat agents --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat agent", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Agents for a Satellite Connector.", "Usage": "ibmcloud sat agent ls --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat agent", "Name": "attach", "Alias": "", "Aliases": null, "Description": "Get a Satellite Connector Agent for a specific platform. Download the Agent '.zip' for Windows or get a link to the documentation for Docker environments.", "Usage": "ibmcloud sat agent attach --platform PLATFORM [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat agent", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat agent help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "hosts", "Alias": "", "Aliases": null, "Description": "List all hosts that are attached to a Satellite location, including hosts that are assigned to clusters or the control plane.", "Usage": "ibmcloud sat hosts --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "attach", "Alias": "", "Aliases": null, "Description": "Create and download a script that you can run on your hosts to attach them to your location. For RHCOS enabled locations, the script is an ignition file.", "Usage": "ibmcloud sat host attach --location LOCATION [--host-label LABEL ...] [--host-link-agent-endpoint ENDPOINT] [--operating-system SYSTEM] [-q] [--reset-key]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "host-label, hl", "Description": "Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run 'ibmcloud sat host get --host \u003chost_name_or_ID\u003e --location \u003clocation_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "reset-key", "Description": "Reset the key that the control plane uses to attach and assign hosts in the location. See https://ibm.biz/reset-key.", "HasValue": true, "Hidden": false }, { "Name": "operating-system", "Description": "The operating system of the hosts you want to attach to your location. To attach RHCOS hosts, your location must be RHCOS enabled.", "HasValue": true, "Hidden": false }, { "Name": "host-link-agent-endpoint", "Description": "The endpoint that the link agent uses to connect to the link tunnel server.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update host information, such as zones and labels.", "Usage": "ibmcloud sat host update --host HOST --location LOCATION [--host-label LABEL ...] [-q] [--zone ZONE]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "host-label, hl", "Description": "Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run 'ibmcloud sat host get --host \u003chost_name_or_ID\u003e --location \u003clocation_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The name or ID of the zone to associate the host. You cannot change the zone of hosts that are assigned to a resource, such as a cluster. You must unassign them first. To list available zones, run 'ibmcloud sat location get --location \u003cID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The name or ID of the host to assign. To automatically assign hosts based on labels, do not include this option.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a host from a Satellite location.", "Usage": "ibmcloud sat host rm --host HOST --location LOCATION [-f] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The name or ID of the host to remove.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "assign", "Alias": "", "Aliases": null, "Description": "Assign a host to a Satellite location control plane or cluster.", "Usage": "ibmcloud sat host assign --location LOCATION [--cluster CLUSTER] [--host HOST] [--host-label LABEL ...] [-q] [--worker-pool POOL] [--zone ZONE]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "cluster", "Description": "The name or ID of the cluster to assign the host to. To list available clusters, run 'ibmcloud sat cluster ls'. If no cluster is provided, the host is automatically assigned to the Satellite control plane.", "HasValue": true, "Hidden": false }, { "Name": "worker-pool, p", "Description": "The name or ID of the worker pool within the cluster to assign the host. If no worker pool is specified, the host is assigned to the default worker pool.", "HasValue": true, "Hidden": false }, { "Name": "zone", "Description": "The name or ID of the zone to assign the host. To find available zones, run 'ibmcloud sat location get --location \u003clocation_name_or_ID\u003e' and look for the 'Host Zones' field.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The name or ID of the host to assign. To automatically assign hosts based on labels, do not include this option. To retrieve the host ID, run 'ibmcloud sat host ls --location \u003clocation_ID_or_name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "host-label, hl", "Description": "Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run 'ibmcloud sat host get --host \u003chost_name_or_ID\u003e --location \u003clocation_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a Satellite host.", "Usage": "ibmcloud sat host get --host HOST --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "host", "Description": "The Satellite host ID. To find the host ID, run 'ibmcloud sat host ls \u003clocation_ID_or_name\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all hosts that are attached to a Satellite location, including hosts that are assigned to clusters or the control plane.", "Usage": "ibmcloud sat host ls --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat host", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat host help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "clusters", "Alias": "", "Aliases": null, "Description": "List all registered clusters in your IBM Cloud account.", "Usage": "ibmcloud sat clusters [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]", "Flags": [ { "Name": "filter", "Description": "Filter registered clusters by cluster ID.", "HasValue": true, "Hidden": false }, { "Name": "limit", "Description": "Limit the number of clusters that are returned.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat cluster", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all registered clusters in your IBM Cloud account.", "Usage": "ibmcloud sat cluster ls [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]", "Flags": [ { "Name": "filter", "Description": "Filter registered clusters by cluster ID.", "HasValue": true, "Hidden": false }, { "Name": "limit", "Description": "Limit the number of clusters that are returned.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat cluster", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a registered cluster.", "Usage": "ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or the ID. To list registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat cluster", "Name": "unregister", "Alias": "", "Aliases": null, "Description": "Remove a cluster registration. The cluster is no longer subscribed to a Satellite configuration, but the cluster and its existing resources still run.", "Usage": "ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or the ID. To list registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat cluster", "Name": "register", "Alias": "", "Aliases": null, "Description": "Get a 'kubectl' command to register your cluster in a Satellite configuration. Log in to your cluster and run this command to install a Satellite Config agent. Clusters that you run in your Satellite location automatically install this agent.", "Usage": "ibmcloud sat cluster register --name NAME [-q] [--silent]", "Flags": [ { "Name": "silent", "Description": "Silent. Return only the registration command in the output.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Specify the name of the cluster that you want to register", "HasValue": true, "Hidden": false }, { "Name": "data-location", "Description": "Indicate the location to store the Satellite cluster data, which includes details about deployed resources such as Secrets and ConfigMaps.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat cluster", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat cluster help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "messages", "Alias": "", "Aliases": null, "Description": "View the current user messages.", "Usage": "ibmcloud sat messages [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "groups", "Alias": "", "Aliases": null, "Description": "List all Satellite cluster groups in your IBM Cloud account.", "Usage": "ibmcloud sat groups [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite cluster groups in your IBM Cloud account.", "Usage": "ibmcloud sat group ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get detailed information for a Satellite cluster group.", "Usage": "ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]", "Flags": [ { "Name": "group, g", "Description": "Specify the name or ID of a Satellite cluster group. To list registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a cluster group. Then, you can subscribe the cluster group to a Satellite configuration.", "Usage": "ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]", "Flags": [ { "Name": "name", "Description": "Provide a name of the Satellite cluster group.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID to add to the cluster group. To list registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite cluster group, which unsubscribes clusters and deletes the Kubernetes resources that were managed by the group's subscriptions.", "Usage": "ibmcloud sat group rm --group GROUP [-f] [-q]", "Flags": [ { "Name": "group, g", "Description": "Specify the name or ID of a Satellite cluster group. To list available cluster groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "attach", "Alias": "", "Aliases": null, "Description": "Add a cluster to your cluster group. The cluster can run in your Satellite location or in IBM Cloud. To add a cluster that runs in IBM Cloud, you must first register the cluster with Satellite Config.", "Usage": "ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]", "Flags": [ { "Name": "group, g", "Description": "Specify the name or ID of a Satellite cluster group. To list available cluster groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID. To list registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "detach", "Alias": "", "Aliases": null, "Description": "Removes one or more clusters from your Satellite cluster group and deletes the Kubernetes resources that were managed by the group's subscriptions.", "Usage": "ibmcloud sat group detach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-f] [-q]", "Flags": [ { "Name": "group, g", "Description": "Specify the name or ID of a Satellite cluster group. To list available cluster groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the cluster name or ID. To list the clusters in your cluster group, run 'ibmcloud sat group get --group \u003ccluster_group_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat group", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat group help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "keys", "Alias": "", "Aliases": null, "Description": "List all Satellite Config keys in your IBM Cloud account.", "Usage": "ibmcloud sat keys [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat key", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite Config keys in your IBM Cloud account.", "Usage": "ibmcloud sat key ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat key", "Name": "rotate", "Alias": "", "Aliases": null, "Description": "Generate a new key for use by managed clusters to connect to Satellite Config.", "Usage": "ibmcloud sat key rotate --name NAME [-f] [-q]", "Flags": [ { "Name": "name", "Description": "The name of the new Satellite Config key.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat key", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite Config key. Any cluster that still uses this key cannot connect to Satellite Config.", "Usage": "ibmcloud sat key rm --key KEY [-f] [-q]", "Flags": [ { "Name": "key", "Description": "The name or ID of a Satellite Config key.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat key", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat key help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "configs", "Alias": "", "Aliases": null, "Description": "List all Satellite configurations in your IBM Cloud account.", "Usage": "ibmcloud sat configs [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite configurations in your IBM Cloud account.", "Usage": "ibmcloud sat config ls [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get details of a Satellite configuration, such as the versions or subscriptions that are associated with the configuration.", "Usage": "ibmcloud sat config get --config CONFIG [--output OUTPUT] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite configuration. All associated subscriptions must be removed first. All versions are deleted. Back up any resource definitions that you want to keep.", "Usage": "ibmcloud sat config rm --config CONFIG [-f] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "rename", "Alias": "", "Aliases": null, "Description": "Rename a Satellite configuration.", "Usage": "ibmcloud sat config rename --config CONFIG --name NAME [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Provide a new name for the Satellite configuration.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a configuration to specify what Kubernetes resources you want to deploy to your clusters in your Satellite workloads.", "Usage": "ibmcloud sat config create --name NAME [-q] (--data-location LOCATION | --provider PROVIDER)", "Flags": [ { "Name": "name", "Description": "Provide a name for the Satellite configuration.", "HasValue": true, "Hidden": false }, { "Name": "data-location", "Description": "Specify the IBM region to store the Satellite configuration data. Strategy: Direct Upload.", "HasValue": true, "Hidden": false }, { "Name": "provider", "Description": "Indicate the remote GitOps provider for the Satellite configuration. This provider stores the Kubernetes resource definitions. Strategy: GitOps. Allowed values: github, gitlab", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config version", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get details for a Satellite configuration version.", "Usage": "ibmcloud sat config version get --config CONFIG --version VERSION [--output OUTPUT] [-q] [--save-config]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of the Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the name or ID of the Satellite configuration version. To list versions in your configuration, run 'ibmcloud sat config get --config \u003cconfiguration_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "save-config", "Description": "Download and save the configuration version to a temporary file.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config version", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite configuration version.", "Usage": "ibmcloud sat config version rm --config CONFIG --version VERSION [-f] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of the Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Indicate the name or ID of the Satellite configuration version. To list versions, run 'ibmcloud sat config get --config \u003cconfiguration_name_or_ID\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config version", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a configuration version to update existing Kubernetes resources for your Satellite workloads.", "Usage": "ibmcloud sat config version create --config CONFIG --file-format FORMAT --name NAME --read-config CONFIG [--description DESCRIPTION] [-q]", "Flags": [ { "Name": "name", "Description": "Provide a name for the Satellite configuration version.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the name or ID of the Satellite configuration. To list available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "description", "Description": "Add a description for the Satellite configuration version.", "HasValue": true, "Hidden": false }, { "Name": "read-config", "Description": "Specify the file path for the configuration version file.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat config version", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat config version help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat config", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat config help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "resources", "Alias": "", "Aliases": null, "Description": "Search Kubernetes resources that are managed by Satellite.", "Usage": "ibmcloud sat resources [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)", "Flags": [ { "Name": "search", "Description": "Indicate the string to filter search results of Kubernetes resources, such as a pod or namespace name.", "HasValue": true, "Hidden": false }, { "Name": "limit", "Description": "Specify the maximum number of resource entries for the search to return.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the name or ID of the registered cluster that the Kubernetes resource runs in. To find registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "subscription", "Description": "Specify the Satellite subscription ID or name. To find subscriptions, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat resource", "Name": "ls", "Alias": "", "Aliases": null, "Description": "Search Kubernetes resources that are managed by Satellite.", "Usage": "ibmcloud sat resource ls [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)", "Flags": [ { "Name": "search", "Description": "Indicate the string to filter search results of Kubernetes resources, such as a pod or namespace name.", "HasValue": true, "Hidden": false }, { "Name": "limit", "Description": "Specify the maximum number of resource entries for the search to return.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the name or ID of the registered cluster that the Kubernetes resource runs in. To find registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "subscription", "Description": "Specify the Satellite subscription ID or name. To find subscriptions, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat resource", "Name": "get", "Alias": "", "Aliases": null, "Description": "View the details of a Kubernetes resource that is managed by a Satellite configuration.", "Usage": "ibmcloud sat resource get --resource RESOURCE [--history HISTORY] [--output OUTPUT] [-q] [--save-data]", "Flags": [ { "Name": "resource", "Description": "Specify the Kubernetes resource ID. To find Kubernetes resources, run 'ibmcloud sat resource ls'.", "HasValue": true, "Hidden": false }, { "Name": "history", "Description": "The history ID for the resource.", "HasValue": true, "Hidden": false }, { "Name": "save-data", "Description": "Download and save a Kubernetes resource definition to a temporary file.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat resource history", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get history for a Kubernetes resource.", "Usage": "ibmcloud sat resource history get --resource RESOURCE [--limit LIMIT] [--output OUTPUT] [-q]", "Flags": [ { "Name": "resource", "Description": "The Kubernetes resource ID.", "HasValue": true, "Hidden": false }, { "Name": "limit", "Description": "Specify the maximum number of history entries to return.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat resource history", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat resource history help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat resource", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat resource help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "services", "Alias": "", "Aliases": null, "Description": "List all Satellite service clusters in your location to review details, such as requested host resources.", "Usage": "ibmcloud sat services --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat service", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite service clusters in your location to review details, such as requested host resources.", "Usage": "ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat service", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat service help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage", "Name": "templates", "Alias": "", "Aliases": null, "Description": "List the available Satellite storage templates.", "Usage": "ibmcloud sat storage templates [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage template", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a Satellite storage template", "Usage": "ibmcloud sat storage template get --name NAME --version VERSION [--output OUTPUT] [-q]", "Flags": [ { "Name": "name", "Description": "Specify the storage template name. To list available storage templates, run 'ibmcloud sat storage template ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Specify the storage template version. To list available storage templates, run 'ibmcloud sat storage template ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage template", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the available Satellite storage templates.", "Usage": "ibmcloud sat storage template ls [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage template", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage template help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage", "Name": "configs", "Alias": "", "Aliases": null, "Description": "List the Satellite storage configurations in your IBM Cloud account.", "Usage": "ibmcloud sat storage configs [--location LOCATION] [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "Specify the ID or name of the location that contains the configurations you want to list. To find available locations, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a Satellite storage configuration to install storage drivers in your clusters.", "Usage": "ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--param PARAM ...] [-q] [--template-version VERSION]", "Flags": [ { "Name": "name", "Description": "Specify the name of the storage configuration.", "HasValue": true, "Hidden": false }, { "Name": "template-name", "Description": "Specify the Satellite storage configuration template name. To list available storage configuration templates, run 'ibmcloud sat storage template ls'.", "HasValue": true, "Hidden": false }, { "Name": "template-version", "Description": "Specify the Satellite storage configuration template version. If you do not include this option, the default version is used. To list available storage configuration templates, run 'ibmcloud sat storage template ls'.", "HasValue": true, "Hidden": false }, { "Name": "param, p", "Description": "Specify a 'key=value' pair for configuration parameters. To see the configuration parameters in a storage template, run 'ibmcloud sat storage template get'.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "Enter the ID or name of the location for the storage configuration. To find available locations, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "source-org", "Description": "To test the storage templates, set this option to the GitHub organization where you forked the 'ibm-satellite-storage' repo.", "HasValue": true, "Hidden": false }, { "Name": "source-branch", "Description": "To test the storage templates, set this option to the branch name in your 'ibm-satellite-storage' repo.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the Satellite storage configurations in your IBM Cloud account.", "Usage": "ibmcloud sat storage config ls [--location LOCATION] [--output OUTPUT] [-q]", "Flags": [ { "Name": "location", "Description": "Specify the ID or name of the location that contains the configurations you want to list. To find available locations, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a Satellite storage configuration.", "Usage": "ibmcloud sat storage config get --config CONFIG [--output OUTPUT] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list available configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite storage configuration.", "Usage": "ibmcloud sat storage config rm --config CONFIG [-f] [--include-assignments] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list available configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "include-assignments", "Description": "Include this option to remove the storage configuration as well as any associated assignments.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "patch", "Alias": "", "Aliases": [ "upgrade" ], "Description": "Apply the latest patch updates to a Satellite storage configuration. Patch updates contain vulnerability remediations and bug fixes within the same major version.", "Usage": "ibmcloud sat storage config patch --config CONFIG [-f] [--include-assignments] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list available configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "include-assignments", "Description": "Include this option to patch the assignments of the storage configuration to the latest configuration version.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config param", "Name": "set", "Alias": "", "Aliases": null, "Description": "Set the configuration and secret parameters of a Satellite storage configuration.", "Usage": "ibmcloud sat storage config param set --config CONFIG --param PARAM [--param PARAM ...] [--apply] [-f] [-q]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of the storage configuration. To list Satellite storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "param, p", "Description": "Specify a 'key=value' pair for configuration parameters. To see the configuration parameters in a storage template, run 'ibmcloud sat storage template get'.", "HasValue": true, "Hidden": false }, { "Name": "apply", "Description": "Apply the latest Satellite storage configuration version to all assignments of a configuration. To list a configuration's assignments, run 'ibmcloud sat storage assignment ls --config CONFIG'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config param", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage config param help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config class", "Name": "add", "Alias": "", "Aliases": null, "Description": "Create a custom Satellite storage class.", "Usage": "ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM [--param PARAM ...] [-q]", "Flags": [ { "Name": "name", "Description": "Provide a name for the custom storage class.", "HasValue": true, "Hidden": false }, { "Name": "config-name", "Description": "Specify the name of the storage configuration for the custom storage class. To list Satellite storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "param, p", "Description": "Specify a 'key=value' pair for storage class parameters. To see the storage class parameters in a storage template, run 'ibmcloud sat storage template get'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config class", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the storage classes in a Satellite storage configuration", "Usage": "ibmcloud sat storage config class ls --config CONFIG [--output OUTPUT] [-q] [--show-params]", "Flags": [ { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "show-params", "Description": "Include this option to list all storage class parameter details.", "HasValue": false, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config class", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a Satellite storage class.", "Usage": "ibmcloud sat storage config class get --class CLASS --config CONFIG [--output OUTPUT] [-q]", "Flags": [ { "Name": "class", "Description": "Specify the name of a Satellite storage class.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config class", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage config class help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage config", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage config help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage", "Name": "assignments", "Alias": "", "Aliases": null, "Description": "List the Satellite storage assignments in your IBM Cloud account.\n\nTo list all assignments for a service cluster as Service Admin: ibmcloud sat storage assignment ls --service-cluster-id CLUSTER.\n\nTo list all assignments for a service cluster as Location Admin: ibmcloud sat storage assignment ls --location LOCATION --service-cluster-id CLUSTER.\n\nTo list all assignments for a configuration: ibmcloud sat storage assignment ls --config CONFIG.", "Usage": "ibmcloud sat storage assignments [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)", "Flags": [ { "Name": "service-cluster-id", "Description": "Specify the ID of the service cluster for the assignments. To find the service cluster ID, run 'ibmcloud sat service ls --location \u003clocation\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the ID of the Satellite cluster for the assignments. To get the cluster ID, run 'ibmcloud oc cluster ls --provider satellite'.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list available storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "Specify the name of a Satellite location. To list available locations, run 'ibmcloud sat location ls'. This option cannot be used by service administrator.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List the Satellite storage assignments in your IBM Cloud account.\n\nTo list all assignments for a service cluster as Service Admin: ibmcloud sat storage assignment ls --service-cluster-id CLUSTER.\n\nTo list all assignments for a service cluster as Location Admin: ibmcloud sat storage assignment ls --location LOCATION --service-cluster-id CLUSTER.\n\nTo list all assignments for a configuration: ibmcloud sat storage assignment ls --config CONFIG.", "Usage": "ibmcloud sat storage assignment ls [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)", "Flags": [ { "Name": "service-cluster-id", "Description": "Specify the ID of the service cluster for the assignments. To find the service cluster ID, run 'ibmcloud sat service ls --location \u003clocation\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the ID of the Satellite cluster for the assignments. To get the cluster ID, run 'ibmcloud oc cluster ls --provider satellite'.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the name or ID of a Satellite storage configuration. To list available storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "Specify the name of a Satellite location. To list available locations, run 'ibmcloud sat location ls'. This option cannot be used by service administrator.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the details of a Satellite storage assignment.", "Usage": "ibmcloud sat storage assignment get --assignment ASSIGNMENT [--output OUTPUT] [-q]", "Flags": [ { "Name": "assignment", "Description": "Specify the ID of a Satellite storage assignment.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create an assignment to deploy your storage configurations to clusters in your Satellite location.", "Usage": "ibmcloud sat storage assignment create --config CONFIG [--name NAME] [-q] (--cluster CLUSTER | --group GROUP | --service-cluster-id CLUSTER)", "Flags": [ { "Name": "name", "Description": "Provide a name for Satellite storage assignment.", "HasValue": true, "Hidden": false }, { "Name": "group, g", "Description": "Specify the cluster groups for the assignment. To find cluster groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "service-cluster-id", "Description": "Specify the ID of the service cluster for the assignment. To find the service cluster ID, run 'ibmcloud sat service ls --location \u003clocation\u003e'.", "HasValue": true, "Hidden": false }, { "Name": "cluster, c", "Description": "Specify the ID of the Satellite cluster for the assignment. To find the cluster ID, run 'ibmcloud oc cluster ls --provider satellite'.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the Satellite storage configuration for the assignment. to find configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite storage assignment. The Kubernetes resources are deleted from all the clusters in your Satellite location, but the configuration remains.", "Usage": "ibmcloud sat storage assignment rm --assignment ASSIGNMENT [-f] [-q]", "Flags": [ { "Name": "assignment", "Description": "Specify the ID of a Satellite storage assignment. To find assignments, run 'ibmcloud sat storage assignment ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update a Satellite storage assignment.", "Usage": "ibmcloud sat storage assignment update --assignment ASSIGNMENT [-f] [--group GROUP ...] [--name NAME] [-q]", "Flags": [ { "Name": "assignment", "Description": "Specify the ID of a Satellite storage assignment.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Provide a new name for the Satellite storage assignment.", "HasValue": true, "Hidden": false }, { "Name": "group, g", "Description": "Specify the new cluster groups for the assignment. To list available groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "patch", "Alias": "", "Aliases": [ "upgrade" ], "Description": "Apply storage configuration changes to the associated assignments.", "Usage": "ibmcloud sat storage assignment patch --assignment ASSIGNMENT [-f] [-q]", "Flags": [ { "Name": "assignment", "Description": "Specify the ID of a Satellite storage assignment. To list available assignments, run 'ibmcloud sat storage assignment ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment autopatch", "Name": "disable", "Alias": "", "Aliases": null, "Description": "Disable automatic patches for a Satellite storage assignment.", "Usage": "ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)", "Flags": [ { "Name": "config", "Description": "The name or ID of a Satellite storage configuration. To list available storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "assignment", "Description": "The ID of a Satellite storage assignment. To list available storage assignments of the configuration, run 'ibmcloud sat storage assignment ls --config CONFIG'.", "HasValue": true, "Hidden": false }, { "Name": "all", "Description": "Disable automatic patches for all Satellite storage assignments of a storage configuration.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "sat storage assignment autopatch", "Name": "enable", "Alias": "", "Aliases": null, "Description": "Enable automatic patches for a Satellite storage assignment.", "Usage": "ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)", "Flags": [ { "Name": "config", "Description": "The name or ID of a Satellite storage configuration. To list available storage configurations, run 'ibmcloud sat storage config ls'.", "HasValue": true, "Hidden": false }, { "Name": "assignment", "Description": "The ID of a Satellite storage assignment. To list available storage assignments of the configuration, run 'ibmcloud sat storage assignment ls --config CONFIG'.", "HasValue": true, "Hidden": false }, { "Name": "all", "Description": "Enable automatic patches for all Satellite storage assignments of a storage configuration.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "beta" }, { "Namespace": "sat storage assignment autopatch", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage assignment autopatch help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage assignment", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage assignment help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat storage", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat storage help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "subscriptions", "Alias": "", "Aliases": null, "Description": "List all Satellite subscriptions in your IBM Cloud account.", "Usage": "ibmcloud sat subscriptions [--cluster CLUSTER] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the Satellite cluster name or ID. To find registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List all Satellite subscriptions in your IBM Cloud account.", "Usage": "ibmcloud sat subscription ls [--cluster CLUSTER] [--output OUTPUT] [-q]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the Satellite cluster name or ID. To find registered clusters, run 'ibmcloud sat cluster ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get detailed information for a Satellite subscription.", "Usage": "ibmcloud sat subscription get --subscription SUBSCRIPTION [--output OUTPUT] [-q]", "Flags": [ { "Name": "subscription", "Description": "Enter the name or ID of a Satellite subscription. To find subscriptions, run 'ibmcloud sat subscription ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a Satellite subscription for clusters. After you create the subscription, the associated Satellite configuration version is automatically deployed to the subscribed clusters.", "Usage": "ibmcloud sat subscription create --config CONFIG --group GROUP [--group GROUP ...] --name NAME [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)", "Flags": [ { "Name": "name", "Description": "Enter a name for the subscription.", "HasValue": true, "Hidden": false }, { "Name": "group, g", "Description": "Specify the name or ID of the cluster groups to subscribe to your configuration. To find available cluster groups, run 'ibmcloud sat group ls'.", "HasValue": true, "Hidden": false }, { "Name": "config", "Description": "Specify the name of the configuration to use for the subscription. To find available configurations, run 'ibmcloud sat config ls'.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Indicate the name or ID of the existing configuration version to use for the subscription. To find versions, run 'ibmcloud sat config get --config \u003cconfiguration_name_or_ID\u003e'. Strategy: Direct Upload.", "HasValue": true, "Hidden": false }, { "Name": "repository", "Description": "Specify the URL of the remote repository to use for the subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "gitref-type", "Description": "Indicate the type of GitRef to use for the Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release", "HasValue": true, "Hidden": false }, { "Name": "gitref", "Description": "Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "path", "Description": "Provide the path to the repository files or release assets in the remote repository to use for the Satellite subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "auth-required", "Description": "Provide the authentication secret required to connect to the remote repository. See 'https://ibm.biz/sat-config-private-repo' for details. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Remove a Satellite subscription. The Kubernetes resources are no longer deployed to your clusters.", "Usage": "ibmcloud sat subscription rm --subscription SUBSCRIPTION [-f] [-q]", "Flags": [ { "Name": "subscription", "Description": "Provide the name or ID of a Satellite subscription. To list subscriptions, run 'ibmcloud sat subscription ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "update", "Alias": "", "Aliases": null, "Description": "Update a Satellite subscription.", "Usage": "ibmcloud sat subscription update --subscription SUBSCRIPTION [-f] [--group GROUP] [--name NAME] [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)", "Flags": [ { "Name": "subscription", "Description": "Specify the name or ID of a Satellite subscription. To list subscriptions, run 'ibmcloud sat subscription ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Provide a new name of the Satellite subscription.", "HasValue": true, "Hidden": false }, { "Name": "group, g", "Description": "Specify the new cluster groups to subscribe to your configuration.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "Indicate the existing configuration version to use for the Satellite subscription. Strategy: Direct Upload.", "HasValue": true, "Hidden": false }, { "Name": "repository", "Description": "Provide the URL of the remote repository to use for the Satellite subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "gitref-type", "Description": "Indicate the type of GitRef to use for this Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release", "HasValue": true, "Hidden": false }, { "Name": "gitref", "Description": "Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "path", "Description": "Indicate the path to the repository files or release assets in the remote repository to use for the Satellite subscription. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "auth-required", "Description": "Provide the authentication secret required to connect to the remote repository. Strategy: GitOps.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription identity", "Name": "set", "Alias": "", "Aliases": null, "Description": "Update the Satellite subscription to use your identity to manage resources.", "Usage": "ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]", "Flags": [ { "Name": "subscription", "Description": "Specify the name or ID of a Satellite subscription. To list subscriptions, run 'ibmcloud sat subscription ls'.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription identity", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat subscription identity help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat subscription", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat subscription help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat mesh", "Name": "create", "Alias": "", "Aliases": null, "Description": "Create a new Satellite Mesh instance in an existing Satellite cluster.", "Usage": "ibmcloud sat mesh create --cluster CLUSTER --name NAME [--output OUTPUT] [-q] [--version VERSION]", "Flags": [ { "Name": "cluster, c", "Description": "Specify the cluster name or ID.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name of the Satellite Mesh instance.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "The new Satellite Mesh version.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "rm", "Alias": "", "Aliases": null, "Description": "Delete a Satellite Mesh instance.", "Usage": "ibmcloud sat mesh rm --mesh MESH [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "mesh", "Description": "The name or ID of the Satellite Mesh instance.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "get", "Alias": "", "Aliases": null, "Description": "Get the status of a Satellite Mesh instance.", "Usage": "ibmcloud sat mesh get --mesh MESH [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "mesh", "Description": "The name or ID of the Satellite Mesh instance.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "ls", "Alias": "", "Aliases": null, "Description": "List Satellite Mesh instances.", "Usage": "ibmcloud sat mesh ls --location LOCATION [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "location", "Description": "The name or ID of the Satellite location.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "versions", "Alias": "", "Aliases": null, "Description": "List available Satellite Mesh versions.", "Usage": "ibmcloud sat mesh versions [--output OUTPUT] [-q]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "upgrade", "Alias": "", "Aliases": null, "Description": "Upgrade a Satellite Mesh instance.", "Usage": "ibmcloud sat mesh upgrade --mesh MESH [--output OUTPUT] [-q] [--version VERSION]", "Flags": [ { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "mesh", "Description": "The name or ID of the Satellite Mesh instance.", "HasValue": true, "Hidden": false }, { "Name": "version", "Description": "The new Satellite Mesh version.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "experimental" }, { "Namespace": "sat mesh", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat mesh help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental", "Name": "acls", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl ls' instead] List all ACLs for a Satellite connector or location.", "Usage": "ibmcloud sat experimental acls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "get", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl get' instead] View the details of an ACL.", "Usage": "ibmcloud sat experimental acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "ls", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl ls' instead] List all ACLs for a Satellite connector or location.", "Usage": "ibmcloud sat experimental acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "create", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl create' instead] Create an ACL.", "Usage": "ibmcloud sat experimental acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The name for the ACL.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to enable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "update", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl update' instead] Update the name of an ACL.", "Usage": "ibmcloud sat experimental acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "The new name for the ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "rm", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl rm' instead] Delete an ACL.", "Usage": "ibmcloud sat experimental acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl subnet", "Name": "add", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl subnet add' instead] Add one or more subnets to an ACL.", "Usage": "ibmcloud sat experimental acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl subnet", "Name": "rm", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl subnet rm' instead] Remove one or more subnets from an ACL.", "Usage": "ibmcloud sat experimental acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "subnet", "Description": "An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl subnet", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental acl subnet help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "endpoints", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl endpoint ls' instead] List all enabled endpoints for an ACL.", "Usage": "ibmcloud sat experimental acl endpoints --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl endpoint", "Name": "add", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl endpoint add' instead] Add one or more enabled endpoints to an ACL.", "Usage": "ibmcloud sat experimental acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to enable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl endpoint", "Name": "rm", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl endpoint rm' instead] Remove one or more enabled endpoints from an ACL.", "Usage": "ibmcloud sat experimental acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "A name or ID of an endpoint to disable for this ACL.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl endpoint", "Name": "ls", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat acl endpoint ls' instead] List all enabled endpoints for an ACL.", "Usage": "ibmcloud sat experimental acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "acl-id", "Description": "Specify the ID of the ACL. To list all ACLs, run 'ibmcloud sat acl ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental acl endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental acl", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental acl help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental", "Name": "agents", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-09-01! Use 'ibmcloud sat agent ls' instead] List all Agents for a Satellite Connector.", "Usage": "ibmcloud sat experimental agents --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental agent", "Name": "ls", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-09-01! Use 'ibmcloud sat agent ls' instead] List all Agents for a Satellite Connector.", "Usage": "ibmcloud sat experimental agent ls --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental agent", "Name": "attach", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-09-01! Use 'ibmcloud sat agent attach' instead] Get a Satellite Connector Agent for a specific platform. Download the Agent '.zip' for Windows or get a link to the documentation for Docker environments.", "Usage": "ibmcloud sat experimental agent attach --platform PLATFORM [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental agent", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental agent help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental endpoint authn", "Name": "set", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat endpoint authn set' instead] Set authentication settings for an endpoint. There are two TLS connections in the request flow. The 'source' options refer to the TLS handshake between the source and the Connector service. The 'destination' options refer to the TLS handshake between the Connector service and your destination or target server. You can provide certificates for one or both of these connections. Unspecified settings are set to their default values.", "Usage": "ibmcloud sat experimental endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "dest-tls-mode", "Description": "The destination TLS mode.", "HasValue": true, "Hidden": false }, { "Name": "dest-cert-file", "Description": "The client certificate used to authenticate with the destination server. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-key-file", "Description": "The client private key used to encrypt the client certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the destination server's certificate. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-tls-mode", "Description": "The source TLS mode.", "HasValue": true, "Hidden": false }, { "Name": "source-cert-file", "Description": "The server certificate to present to the source client. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-key-file", "Description": "The server private key used to encrypt the server certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental endpoint authn", "Name": "rotate", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat endpoint authn rotate' instead] Replace existing authentication certificates with new ones. There are two TLS connections in the request flow. The 'source' options refer to the TLS handshake between the source and the Connector service. The 'destination' options refer to the TLS handshake between the Connector service and your destination or target server. You can provide certificates for one or both of these connections. Only the certificates that you specify are replaced.", "Usage": "ibmcloud sat experimental endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "dest-cert-file", "Description": "The client certificate used to authenticate with the destination server. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-key-file", "Description": "The client private key used to encrypt the client certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "dest-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the destination server's certificate. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-cert-file", "Description": "The server certificate to present to the source client. For example 'myCert.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-key-file", "Description": "The server private key used to encrypt the server certificate. For example 'myKey.pem'.", "HasValue": true, "Hidden": false }, { "Name": "source-ca-cert-file", "Description": "Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example 'myCA.pem'.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental endpoint authn", "Name": "get", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-10-01! Use 'ibmcloud sat endpoint authn get' instead] Get the authentication settings for an endpoint.", "Usage": "ibmcloud sat experimental endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)", "Flags": [ { "Name": "location", "Description": "The name or ID of the Satellite location. To find the location ID or name, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "connector-id", "Description": "The ID of the Satellite connector. To find the connector ID, run 'ibmcloud sat connector ls'.", "HasValue": true, "Hidden": false }, { "Name": "endpoint", "Description": "Specify the name or ID of the endpoint. To list all endpoints, run 'ibmcloud sat endpoint ls'.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental endpoint authn", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental endpoint authn help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental endpoint", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental endpoint help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental", "Name": "connectors", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector ls' instead] View the Satellite Connectors in your IBM Cloud account.", "Usage": "ibmcloud sat experimental connectors [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]", "Flags": [ { "Name": "after", "Description": "Show Satellite Connectors after the given cursor.", "HasValue": true, "Hidden": false }, { "Name": "first", "Description": "View the next Satellite Connectors, up to the first number of Connectors.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "create", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector create' instead] Create a Satellite connector.", "Usage": "ibmcloud sat experimental connector create --name NAME --region REGION [-q]", "Flags": [ { "Name": "name", "Description": "The name for the Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "region", "Description": "The IBM Cloud region to manage your Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "get", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector get' instead] View the details of a Satellite Connector.", "Usage": "ibmcloud sat experimental connector get --connector-id ID [--output OUTPUT] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "ls", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector ls' instead] View the Satellite Connectors in your IBM Cloud account.", "Usage": "ibmcloud sat experimental connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]", "Flags": [ { "Name": "after", "Description": "Show Satellite Connectors after the given cursor.", "HasValue": true, "Hidden": false }, { "Name": "first", "Description": "View the next Satellite Connectors, up to the first number of Connectors.", "HasValue": true, "Hidden": false }, { "Name": "output", "Description": "Prints the command output in the provided format.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "rm", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector rm' instead] Delete a Satellite connector.", "Usage": "ibmcloud sat experimental connector rm --connector-id ID [-f] [-q]", "Flags": [ { "Name": "connector-id", "Description": "The ID of a Satellite connector.", "HasValue": true, "Hidden": false }, { "Name": "f", "Description": "Force the command to run without user prompts.", "HasValue": false, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "agent", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-18! Use 'ibmcloud sat connector agent' instead] Get a Satellite Connector agent for a specific platform.", "Usage": "ibmcloud sat experimental connector agent --platform PLATFORM [-q]", "Flags": [ { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental connector", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental connector help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental location", "Name": "update", "Alias": "", "Aliases": null, "Description": "[Deactivated on 2024-11-25! Use 'ibmcloud sat location update' instead] Update the name or description of a Satellite location.", "Usage": "ibmcloud sat experimental location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]", "Flags": [ { "Name": "location-id", "Description": "The ID of the Satellite location. To find the location ID, run 'ibmcloud sat location ls'.", "HasValue": true, "Hidden": false }, { "Name": "name", "Description": "Specify a new name for the Satellite location. Location names must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be fewer than 36 characters. Do not reuse names, including names of deleted locations.", "HasValue": true, "Hidden": false }, { "Name": "description", "Description": "Enter a new description for the Satellite location. The length of the description is limited to 400 bytes.", "HasValue": true, "Hidden": false }, { "Name": "q", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false }, { "Name": "s", "Description": "Do not show the message of the day or update reminders.", "HasValue": false, "Hidden": false } ], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental location", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental location help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat experimental", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat experimental help", "Flags": [], "Hidden": false, "Stage": "" }, { "Namespace": "sat", "Name": "help", "Alias": "", "Aliases": [ "h" ], "Description": "Show help", "Usage": "ibmcloud sat help", "Flags": [], "Hidden": false, "Stage": "" } ], "SDKVersion": { "Major": 1, "Minor": 0, "Build": 3 }, "DelegateBashCompletion": true, "PrivateEndpointSupported": false, "IsAccessFromVPC": false, "IsCobraPlugin": false } } }