Skip to content

Latest commit

 

History

History
212 lines (135 loc) · 4.08 KB

cli.md

File metadata and controls

212 lines (135 loc) · 4.08 KB
Raw

Spring Cloud Services CF CLI Plugin Docs

The following commands can be executed using the Spring Cloud Services Cloud Foundry CLI Plugin.

Spring Cloud Services CLI Docs

cf config-server-add-credhub-secret

NAME:
   config-server-add-credhub-secret - Add secret in JSON format to the given path

USAGE:
      cf config-server-add-credhub-secret CONFIG_SERVER_INSTANCE_NAME CREDHUB_PATH JSON_SECRET

ALIAS:
   cs-add

cf config-server-remove-credhub-secret

NAME:
   config-server-remove-credhub-secret - Remove secrets from the given path

USAGE:
      cf config-server-remove-credhub-secret CONFIG_SERVER_INSTANCE_NAME CREDHUB_PATH

ALIAS:
   cs-remove

cf config-server-sync-mirrors

NAME:
   config-server-sync-mirrors - Synchronize Git mirrors associated with given Spring Cloud Services configuration server

USAGE:
      cf config-server-sync-mirrors CONFIG_SERVER_INSTANCE_NAME

ALIAS:
   cssm

cf spring-cloud-service-configuration

NAME:
   spring-cloud-service-configuration - Display configuration parameters for a Spring Cloud Services service instance

USAGE:
      cf scs-config SERVICE_INSTANCE_NAME

ALIAS:
   scs-config

cf spring-cloud-service-stop

NAME:
   spring-cloud-service-stop - Stop a Spring Cloud Services service instance

USAGE:
      cf scs-stop SERVICE_INSTANCE_NAME

ALIAS:
   scs-stop

cf spring-cloud-service-start

NAME:
   spring-cloud-service-start - Start a Spring Cloud Services service instance

USAGE:
      cf scs-start SERVICE_INSTANCE_NAME

ALIAS:
   scs-start

cf spring-cloud-service-restart

NAME:
   spring-cloud-service-restart - Restart a Spring Cloud Services service instance

USAGE:
      cf scs-restart SERVICE_INSTANCE_NAME

ALIAS:
   scs-restart

cf spring-cloud-service-restage

NAME:
   spring-cloud-service-restage - Restage a Spring Cloud Services service instance

USAGE:
      cf scs-restage SERVICE_INSTANCE_NAME

ALIAS:
   scs-restage

cf spring-cloud-service-view

NAME:
   spring-cloud-service-view - Display health and status for a Spring Cloud Services service instance

USAGE:
      cf scs-view SERVICE_INSTANCE_NAME

ALIAS:
   scs-view

cf service-registry-info

NAME:
   service-registry-info - Display Spring Cloud Services service registry instance information

USAGE:
      cf service-registry-info SERVICE_REGISTRY_INSTANCE_NAME

ALIAS:
   sri

cf service-registry-list

NAME:
   service-registry-list - Display all applications registered with a Spring Cloud Services service registry

USAGE:
      cf service-registry-list SERVICE_REGISTRY_INSTANCE_NAME

ALIAS:
   srl

cf service-registry-enable

NAME:
   service-registry-enable - Enable an application registered with a Spring Cloud Services service registry so that it is available for traffic

USAGE:
      cf service-registry-enable SERVICE_REGISTRY_INSTANCE_NAME CF_APPLICATION_NAME

ALIAS:
   sren

OPTIONS:
   --i/--cf-instance-index      Operate on a specific instance in the Eureka registry. The instance index number can be found by using the service-registry-list command.

cf service-registry-deregister

NAME:
   service-registry-deregister - Deregister an application registered with a Spring Cloud Services service registry

USAGE:
      cf service-registry-deregister SERVICE_REGISTRY_INSTANCE_NAME CF_APPLICATION_NAME

ALIAS:
   srdr

OPTIONS:
   --i/--cf-instance-index      Operate on a specific instance in the Eureka registry. The instance index number can be found by using the service-registry-list command.

cf service-registry-disable

NAME:
   service-registry-disable - Disable an application registered with a Spring Cloud Services service registry so that it is unavailable for traffic

USAGE:
      cf service-registry-disable SERVICE_REGISTRY_INSTANCE_NAME CF_APPLICATION_NAME

ALIAS:
   srda

OPTIONS:
   --i/--cf-instance-index      Operate on a specific instance in the Eureka registry. The instance index number can be found by using the service-registry-list command.