Cloud Foundry CLI Reference Guide


名称

cf - 用于与 Cloud Foundry 进行交互的命令行工具

用法

cf [global options] command [arguments...] [command options]

版本

7.3.0+645c3ce6a.2021-08-16

开始使用

显示帮助
打印版本
使用户登录
使用户注销
更改用户密码
设置或查看目标组织或空间
设置或查看目标 API URL
以非交互方式认证

应用程序

列出目标空间中的所有应用程序
显示应用程序的运行状况和状态
Create an Application in the target space
推送新应用程序,或将更改同步到现有应用程序
更改或查看应用程序的实例计数、磁盘空间限制和内存限制
删除应用程序
重命名应用程序
Cancel the most recent deployment for an app. Resets the current droplet to the previous deployment's droplet.
启动应用程序
停止应用程序
Stop all instances of the app, then start them again.
Stage a package into a droplet
Stage the app's latest package into a droplet and restart the app with this new droplet and updated configuration (environment variables, service bindings, buildpack, stack, etc.).
终止,然后实例化应用程序实例
在应用程序上运行一次性任务
列出应用程序的任务
终止应用程序正在运行的任务
列出应用程序的包
Uploads a Package
列出应用程序的 Droplet
设置用于运行应用程序的 Droplet
Download an application droplet
显示最近的应用程序事件
跟踪或显示应用程序最近的日志
显示应用程序的所有环境变量
为应用程序设置环境变量
从应用程序中除去环境变量
列出所有堆栈(堆栈是一种可以运行应用程序的预构建文件系统,包括操作系统)
显示堆栈的信息(堆栈是一种可以运行应用程序的预构建文件系统,包括操作系统)
Copies the source code of an application to another existing application and restages that application
为已成功推送的应用程序创建应用程序清单
显示对应用程序执行的运行状况检查的类型
更改对应用程序进程执行的运行状况检查的类型
启用应用程序的 SSH
禁用应用程序的 SSH
报告是否在应用程序容器实例上启用了 SSH
通过 SSH 连接到应用程序容器实例

服务

列出市场中的可用产品
列出目标空间中的所有服务实例
显示服务实例信息
创建服务实例
更新服务实例
删除服务实例
重命名服务实例
为服务实例创建密钥
列出服务实例的密钥
显示服务密钥信息
删除服务密钥
将服务实例绑定到应用程序
取消服务实例与应用程序的绑定
将服务实例绑定到 HTTP 路径
取消服务实例与 HTTP 路径的绑定
使用户提供的服务实例可供 CF 应用程序使用
更新用户提供的服务实例
与其他空间共享服务实例
从空间中取消共享已共享的服务实例

组织

列出所有组织
显示组织信息
创建组织
删除组织
重命名组织

空间

列出组织中的所有空间
显示空间信息
创建空间
删除空间
重命名空间
Apply manifest properties to a space
允许对空间进行 SSH 访问
不允许对空间进行 SSH 访问
报告是否允许在空间中使用 SSH

列出目标组织中的域
Create a private domain for a specific org
Delete a private domain
创建可以由所有组织使用的域(仅限管理员)
删除共享域
列出路由器组

路径

列出当前空间或当前组织中的所有路径
Create a route for later use
Perform a check to determine whether a route currently exists or not
Map a route to an app
Remove a route from an app
删除路径
Delete all orphaned routes in the currently targeted space (i.e. those that are not mapped to an app or service instance)

网络策略

列出直接网络通信策略
创建策略以允许应用程序与应用程序之间的直接网络通信
除去应用程序的网络通信策略

BUILDPACK

列出所有 buildpack
创建 buildpack
更新 buildpack
删除 buildpack

用户管理员

新建用户
删除用户
显示组织用户(按角色)
为用户分配组织角色
除去用户的组织角色
显示空间用户(按角色)
为用户分配空间角色
除去用户的空间角色

组织管理员

List available organization quotas
Show organization quota
Assign a quota to an organization
Define a new quota for an organization
Delete an organization quota
Update an existing organization quota
Share a private domain with a specific org
Unshare a private domain with a specific org

空间管理员

List available space quotas
显示空间配额信息
Define a new quota for a space
更新现有空间配额
Delete a space quota
Assign a quota to a space
取消为空间分配的配额

服务管理员

列出服务代理程序
创建服务代理程序
更新服务代理程序
删除服务代理程序
重命名服务代理程序
Recursively remove a service offering and child objects from Cloud Foundry database without making requests to a service broker
以递归方式从 Cloud Foundry 数据库中除去某个服务实例和子对象,而不对服务代理程序发起请求
列出服务访问权设置
Enable access to a service offering or service plan for one or all orgs
Disable access to a service offering or service plan for one or all orgs

安全组

显示单个安全组
列出所有安全组
创建安全组
更新安全组
删除安全组
将安全组绑定到特定空间或一个组织的所有现有空间
取消安全组与空间的绑定
Bind a security group to the list of security groups to be used for staging applications globally
List security groups globally configured for staging applications
Unbind a security group from the set of security groups for staging applications globally
将安全组绑定到要用于运行应用程序的安全组的列表
List security groups globally configured for running applications
Unbind a security group from the set of security groups for running applications globally

环境变量组

检索运行环境变量组的内容
检索编译打包环境变量组的内容
将参数作为 JSON 传递,以创建编译打包环境变量组
将参数作为 JSON 传递,以创建运行环境变量组

隔离段

列出所有隔离段
创建隔离段
删除隔离段
授予组织对隔离段的权利
撤销组织对隔离段的权利
设置用于组织空间中应用程序的缺省隔离段
重置用于组织空间中应用程序的缺省隔离段
为空间分配隔离段
将空间的隔离段重置为组织缺省值

功能标志

检索功能标志及状态的列表
检索单个功能标志及状态
允许使用功能
阻止使用功能

METADATA

List all labels (key-value pairs) for an API resource
Set a label (key-value pairs) for an API resource
Unset a label (key-value pairs) for an API resource

高级

对目标 API 端点执行请求
将缺省值写入配置
Display the OAuth token for the current session and refresh the token if necessary
为 SSH 客户机获取一次性密码

添加/除去插件存储库

添加新的插件存储库
除去插件存储库
列出所有已添加的插件存储库
列出指定存储库中或所有已添加存储库中的所有可用插件

添加/除去插件

列出已安装插件的命令
安装 CLI 插件
卸载 CLI 插件

已安装插件命令

环境变量

CF_COLOR=false
不设置输出的颜色
CF_DIAL_TIMEOUT=6
建立连接(包括名称解析)的最长等待时间(秒)
CF_HOME=path/to/dir/
覆盖缺省配置目录的路径
CF_PLUGIN_HOME=path/to/dir/
覆盖缺省插件配置目录的路径
CF_TRACE=true
将 API 请求诊断打印到 stdout
CF_TRACE=path/to/trace.log
将 API 请求诊断附加到日志文件
all_proxy=proxy.example.com:8080
指定要对所有请求启用代理的代理服务器
https_proxy=proxy.example.com:8080
对 HTTP 请求启用代理

全局选项

--help, -h
显示帮助
-v
将 API 请求诊断打印到 stdout

EXPERIMENTAL COMMANDS

List revisions of an app
Show details for a specific app revision
Rollback to the specified revision of an app