Cloud Foundry CLI Reference Guide


名稱

cf - 要與 Cloud Foundry 互動的指令行工具

用法

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

版本

6.53.0+8e2b70a4a.2020-10-01

開始使用

顯示說明
列印版本
將使用者登入
將使用者登出
變更使用者密碼
設定或檢視目標組織或空間
設定或檢視目標 API URL
以非互動方式鑑別

APP

列出目標空間中的所有應用程式
顯示應用程式的性能和狀態
將新的應用程式推送或將變更同步到現有的應用程式
變更或檢視應用程式的實例計數、磁碟空間限制和記憶體限制
刪除應用程式
重新命名應用程式
啟動應用程式
停止應用程式
請停止應用程式的所有實例,然後將其重新啟動。這會導致關閉時間。
使用最新推送的應用程式檔案和最新的環境(變數、服務連結、建置套件、堆疊等等)來重建應用程式的執行檔構件. 此動作將導致應用程式關閉。
終止,然後重新啟動應用程式實例
在應用程式上執行單次作業
列出應用程式的作業
終止應用程式的執行中作業
顯示最近的應用程式事件
印出目錄中的檔案清單,或 DEA 後端上執行的應用程式的特定檔案內容
調整或顯示應用程式的最近日誌
顯示應用程式的所有環境變數
設定應用程式的環境變數
從應用程式移除環境變數
列出所有堆疊(堆疊是可執行應用程式的預先建置檔案系統(包括作業系統))
顯示堆疊資訊(堆疊是可執行應用程式的預先建置檔案系統(包括作業系統))
將應用程式的原始碼複製到另一個現有應用程式(並重新啟動該應用程式)
建立已順利推送之應用程式的應用程式資訊清單
顯示在應用程式上執行的性能檢查類型
變更在應用程式上執行的性能檢查類型
啟用應用程式的 ssh
停用應用程式的 ssh
在應用程式容器實例上是否啟用 SSH 的報告
應用程式容器實例的 SSH

服務

列出 Marketplace 中的可用供應項目
列出目標空間中的所有服務實例
顯示服務實例資訊
建立服務實例
更新服務實例
刪除服務實例
重新命名服務實例
建立服務實例的金鑰
列出服務實例的金鑰
顯示服務金鑰資訊
刪除服務金鑰
將服務實例連結至應用程式
取消服務實例與應用程式的連結
將服務實例連結至 HTTP 路徑
取消服務實例與 HTTP 路徑的連結
讓使用者提供的服務實例可供 CF 應用程式使用
更新使用者提供的服務實例
與另一個空間共用服務實例
解除共用服務實例與空間的共用

組織

列出所有組織
顯示組織資訊
建立組織
刪除組織
重新命名組織

空間

列出組織中的所有空間
顯示空間資訊
建立空間
刪除空間
重新命名空間
容許空間的 SSH 存取權
禁止空間的 SSH 存取權
空間中是否容許 SSH 的報告

網域

列出目標組織中的網域
在組織中建立網域以供稍後使用
刪除網域
建立可供所有組織使用的網域(僅限管理)
刪除共用網域
列出路由器群組

路徑

列出現行空間或現行組織中的所有路徑
在空間中建立 URL 路徑,以供稍後使用
執行簡單的檢查,以判斷路徑目前是否存在
新增應用程式的 URL 路徑
從應用程式移除 URL 路徑
刪除路徑
Delete all orphaned routes in the currently targeted space (i.e. those that are not mapped to an app)

網路原則

列出直接網路資料流量原則
建立原則,讓應用程式之間能夠直接傳輸網路資料流量
移除應用程式的網路資料流量原則

建置套件

列出所有建置套件
建立建置套件
更新建置套件
重新命名建置套件
刪除建置套件

使用者管理者

建立新使用者
刪除使用者
依角色顯示組織使用者
將組織角色指派給使用者
從使用者移除組織角色
依角色顯示空間使用者
將空間角色指派給使用者
從使用者移除空間角色

組織管理者

列出可用的使用配額
顯示配額資訊
將配額指派給組織
定義新資源配額
刪除配額
更新現有的資源配額
與組織共用專用網域
解除專用網域與組織的共用

空間管理者

列出可用的空間資源配額
顯示空間配額資訊
定義新空間資源配額
更新現有的空間配額
刪除空間配額定義,並取消指派所有空間的空間配額
將空間配額定義指派給空間
取消指派空間的配額

服務管理者

列出服務鑑別記號
建立服務鑑別記號
更新服務鑑別記號
刪除服務鑑別記號
列出服務分配管理系統
建立服務分配管理系統
更新服務分配管理系統
刪除服務分配管理系統
重新命名服務分配管理系統
將服務實例從某個服務方案移轉至另一個服務方案
遞迴地從 Cloud Foundry 資料庫移除服務和子物件,而不對服務分配管理系統提出要求
遞迴地從 Cloud Foundry 資料庫移除服務實例和子物件,而不對服務分配管理系統提出要求
列出服務存取設定
啟用一個或所有組織之服務或服務方案的存取權
停用一個或所有組織之服務或服務方案的存取權

安全群組

顯示單一安全群組
列出所有安全群組
建立安全群組
更新安全群組
刪除安全群組
將安全群組連結至組織的特定空間或所有現有空間
取消安全群組與空間的連結
將安全群組連結至要用於編譯打包應用程式的安全群組清單
列出編譯打包集中用於應用程式的安全群組
取消安全群組與用於編譯打包應用程式之安全群組集的連結
將安全群組連結至要用於執行應用程式的安全群組清單
列出安全群組集中用於執行應用程式的安全群組
取消安全群組與用於執行應用程式之安全群組集的連結

環境變數群組

擷取執行環境變數群組的內容
擷取編譯打包環境變數群組的內容
傳遞參數作為 JSON,以建立編譯打包環境變數群組
傳遞參數作為 JSON,以建立執行環境變數群組

隔離區段

列出所有隔離區段
建立隔離區段
刪除隔離區段
讓組織具有隔離區段的權限
撤銷組織對隔離區段的授權
針對組織空間中的應用程式,設定所使用的預設隔離區段
針對組織空間中的應用程式,重設所使用的預設隔離區段
指派空間的隔離區段
將空間的隔離區段重設為組織預設值

特性旗標

擷取具有狀態的特性旗標清單
擷取具有狀態的個別特性旗標
容許使用特性
避免使用特性

進階

向目標 API 端點執行要求
將預設值寫入配置
擷取並顯示現行階段作業的 OAuth 記號
取得 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
指定 Proxy 伺服器以啟用所有要求的 Proxy 處理
https_proxy=proxy.example.com:8080
啟用 HTTP 要求的 Proxy 處理

廣域選項

--help, -h
顯示說明
-v
將 API 要求診斷列印至 stdout

APPS(實驗性)

列出目標空間中的所有應用程式
建立 V3 應用程式
將新的應用程式推送或將變更同步到現有的應用程式
變更或檢視應用程式的實例計數、磁碟空間限制和記憶體限制
刪除 V3 應用程式
啟動應用程式
停止應用程式
請停止應用程式的所有實例,然後將其重新啟動。這會導致關閉時間。
為應用程式建立新的 Droplet
終止,然後實例化應用程式實例
將資訊清單內容套用至應用程式
列出應用程式的 Droplet
設定用來執行應用程式的 Droplet
顯示應用程式的所有環境變數
設定應用程式的環境變數
從應用程式移除環境變數
顯示在應用程式上執行的性能檢查類型
變更在應用程式程序上執行的性能檢查類型
列出應用程式的套件
上傳 V3 套件
應用程式容器實例的 SSH