ffx

Fuchsia 的開發人員工具


Usage: ffx [-c <config...>] [-e <env>] [--machine <machine>] [--schema] [--stamp <stamp>] [-t <target>] [-T <timeout>] [-l <log-level>] [--isolate-dir <isolate-dir>] [-v] [subcommand...]

選項  
--說明 顯示使用資訊
-c、--config 覆寫設定值 (鍵=值、JSON 字串或 JSON 設定檔的路徑)
-e、--env 覆寫環境設定檔 (檔案路徑) 的路徑
--電腦 以指定格式產生機器的輸出內容;可用格式:「json」、「json-pretty」
--結構定義 產生 MachineWriter 輸出的 JSON 結構定義。產生結構定義時,必須提供 --machine 選項。
--戳記 在含有結束代碼的指定路徑上建立戳記檔案
-t、--target 將作業套用到一或多個目標
-T、--timeout 覆寫預設的 Proxy 逾時
-l、--log-level 設定 ffx 輸出的記錄層級 (預設為 = 資訊)。其他可能的值包括「資訊」、「錯誤」、「警告」和「追蹤記錄」。可透過 log.level 配置設定保留。
--isolate-dir 開啟隔離模式,該模式就能使用指定的目錄,將所有設定和通訊端檔案隔離到指定目錄。這會覆寫 FFX_ISOLATE_DIR 環境變數,這也可以將 ffx 放入這個模式。
-v、--verbose 會根據記錄層級,將 ffx 輸出記錄至 stdio
子指令  
元件 探索及管理元件
設定 查看及切換預設和使用者設定
Daemon 與/控制 ffx Daemon 互動
偵錯 開始偵錯工作階段。
Doctor 針對 ffx 工具和主機環境執行常見的檢查
net 查看及管理目標網路設定
平台 管理平台建構的必備條件
產品 探索及使用產品組合中繼資料和圖片資料。
存放區 檢查及管理套件存放區
sdk 修改或查詢已安裝的 SDK
工作階段 控制工作階段元件。
目標 與目標裝置或模擬器互動
版本 列印 ffx 工具和 Daemon 版本

元件

探索及管理元件


Usage:  ffx component [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
功能 列出參照特定能力的元件執行個體
collection 管理元件拓撲中的集合
複製 會將檔案複製到/複製與元件相關聯的目錄。

路徑可以是本機或遠端路徑的任意組合。| create | 建立動態元件執行個體,並新增至由 | debug | 使用 zxdb 對執行中的元件進行偵錯。| destroy | 刪除動態元件執行個體,將其從 | Doctor 指定的集合中移除 | 在執行階段對元件執行診斷檢查。| 爆炸 | 產生範圍限定為元件執行個體的殼層。 | 圖形 | 為元件拓撲中的元件輸出 Graphviz 點圖。未解析的元件子項不包含在此清單中。| 清單 | 列出元件拓撲中的元件。未解析的元件子項不包含在此清單中。| 重新載入 | 以遞迴方式停止、未解析及啟動元件執行個體,並更新程式碼和拓撲,同時保留資源 | resolve | 解析元件執行個體 | 路徑 | 在執行階段執行元件的功能轉送。 | run | 在元件拓撲中的現有集合中建立並啟動元件執行個體。| show | 顯示元件執行個體的詳細資訊 | 開始 | 啟動元件 | 停止 | 停止元件執行個體 | 儲存空間 | 管理元件儲存空間

能力

列出參照特定能力的元件執行個體


Usage:  ffx component capability capability

選項  
--說明 顯示使用資訊

範例

To show all components that reference a capability:

    $ ffx component capability fuchsia.net.routes

精選內容

管理元件拓撲中的集合


Usage:  ffx component collection [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
清單 列出元件拓撲中的所有集合
節目 在元件拓撲中顯示集合的詳細資訊

list

列出元件拓撲中的所有集合


Usage:  ffx component collection list

選項  
--說明 顯示使用資訊

節目

在元件拓撲中顯示集合的詳細資訊


Usage:  ffx component collection show query

選項  
--說明 顯示使用資訊

複製

會將檔案複製到/複製與元件相關聯的目錄。 路徑可以是本機或遠端路徑的任意組合。


Usage:  ffx component copy [-v] [paths...]

選項  
--說明 顯示使用資訊
-v、--verbose 詳細輸出:為每個複製的檔案輸出一行。

範例

To copy from a component to a local path: 
ffx component copy /some/moniker::/path/file.txt /local/file.txt 

To copy from a local path to a component: 
ffx component copy /local/file.txt /some/moniker::/dir/file.txt

To copy between two components: 
ffx component copy /some/moniker::/dir/file.txt /some/moniker::/dir/file.txt

To copy multiple files: 
ffx component copy /some/moniker::/dir/* /some/local/dir
ffx component copy /file/one.txt /file/two.txt ... /some/moniker::/dir/

To copy a file from a component's outgoing directory: 
ffx component copy /some/moniker::out::/path/file.txt /local/file.txt

To copy a file from a component's package directory: 
ffx component copy /some/moniker::pkg::/meta/foo /tmp

備忘錄

  • To learn more about the command see https://fuchsia.dev/fuchsia-src/development/sdk/ffx/copy-files-to-and-from-a-component

create

建立動態元件執行個體,並將其新增至 指定的集合


Usage:  ffx component create [--config <config...>] moniker url

選項  
--說明 顯示使用資訊
--config 為正在執行的元件提供設定覆寫設定欄位中必須包含 mutability: [ "parent" ]。以 KEY=VALUE 格式指定,其中 VALUE 是 JSON 字串,可解析為正確的設定值類型。

範例

To create a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component create /core/ffx-laboratory:foo fuchsia-pkg://fuchsia.com/hello-world-rust#meta/hello-world-rust.cm

備忘錄

  • To learn more about running components, see https://fuchsia.dev/go/components/run

偵錯

使用 zxdb 對執行中的元件進行偵錯。


Usage:  ffx component debug query

選項  
--說明 顯示使用資訊

範例

To debug the `brightness_manager` component instance, all of the
following commands are valid:

    $ ffx component debug /core/brightness_manager
    $ ffx component debug fuchsia-pkg://fuchsia.com/brightness_manager#meta/brightness_manager.cm
    $ ffx component debug meta/brightness_manager.cm
    $ ffx component debug brightness_manager

If the component is not yet running, consider `ffx component start --debug`
to start the component in the debugger.

備忘錄

  • This command supports partial matches over the moniker, URL and instance ID

destroy

刪除動態元件執行個體,將其從 指定的集合中移除


Usage:  ffx component destroy query

選項  
--說明 顯示使用資訊

範例

To destroy a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component destroy /core/ffx-laboratory:foo

備忘錄

  • To learn more about running components, see https://fuchsia.dev/go/components/run

醫生

在執行階段對元件執行診斷檢查。


Usage:  ffx component doctor [-p] query

選項  
--說明 顯示使用資訊
-p、--plain 是否要在沒有色彩及換行的情況下顯示輸出內容。

範例

To run diagnostics:

$ ffx component doctor /core/network/netstack

This will run checks on the capabilities configuration of the component, checking that all of the
`use` and `expose` capabilities can be routed successfully by the component manager.

探索

產生範圍限定為元件執行個體的殼層。


Usage:  ffx component explore [--tools <tools...>] [-c <command>] [-l <layout>] query

選項  
--說明 顯示使用資訊
--tools 要包含在殼層環境中的工具套件網址清單。PATH 變數會更新,以加入這些工具套件中的二進位檔。請針對每個要加入的套件重複 --tools url。路徑偏好設定是由指令列順序指定。
-c、--command 執行指令,而不要從 stdin 讀取。系統會將指令的結束程式碼轉送至主機。
-l、--layout 變更為 shell 建立的命名空間配置。巢狀結構:將所有執行個體目錄建立在子目錄 (預設) 命名空間之下:將執行個體命名空間設為根層級 (較適合工具使用)

範例

To explore the Archivist instance interactively:

> ffx component explore /bootstrap/archivist
$ ls
exposed
ns
out
runtime
svc
$ exit
Connection to terminal closed

To run a command directly from the command line:
> ffx component explore /bootstrap/archivist -c 'printenv'
PATH=/.dash/tools/debug-dash-launcher
PWD=/

備忘錄

  • When --layout=nested (the default), the environment contains the following
    directories of the explored instance:
  • /ns The namespace of the instance
  • /exposed The capabilities exposed by the instance
  • /out The outgoing directory of the instance, if it is running
  • /runtime The runtime directory of the instance, if it is running

The environment also contains the following directories, irrespective of the explored instance: * /.dash User-added and built-in dash tools * /svc Protocols required by the dash shell

When --layout=namespace, the contents of the /ns dir above are placed at / with two protocols (fuchsia.process.Launcher and fuchsia.process.Resolver) overlayed into /svc. In this mode, the exposed, out, and runtime directories will not be accessible.

With --tools, tools in the specified package will be loaded into /.dash/tools// The path is set so that they can be run by name. The path preference is in the command line order of the --tools arguments, with any built-in tools taking lowest priority.

--tools URLs may be package or binary URLs. If a package URL is given, tool executables are expected to be in a bin/ dir within the package. If a specific tool URL is given, append the tool path to the package URL. For example: --tools fuchsia-pkg://fuchsia.com/my_package#bin/my_tool. Note that naming collisions can occur if multiple packages share a package or binary name. An error, NonUniqueBinaryName, is returned if a binary name collision occurs.

圖表

為元件拓撲中的元件輸出 Graphviz 點圖。未解析的元件子項不包含在此清單中。


Usage:  ffx component graph [-o <only>] [-r <orientation>]

選項  
--說明 顯示使用資訊
-o、--only 依條件篩選執行個體清單:祖系、子系、相對
-r、--orientation 變更圖表節點的視覺方向。允許的值為「lefttoright」/"lr" 和「toptobottom」/"tb」。

範例

To graph components in the topology:

    $ ffx component graph

    To graph all running components in the topology:

    $ ffx component graph --only running

    To graph all stopped components in the topology:

    $ ffx component graph --only stopped

    To graph the ancestors of a component named `foo`:

    $ ffx component graph --only ancestor:foo

    To graph the descendants of a component named `foo`:

    $ ffx component graph --only descendant:foo

    To graph both the ancestors and descendants of a component named `foo`:

    $ ffx component graph --only relatives:foo

    To order the graph's nodes from left-to-right (instead of top-to-bottom):

    $ ffx component graph --orientation left_to_right

list

列出元件拓撲中的元件。未解析的元件子項不包含在此清單中。


Usage:  ffx component list [-o <only>] [-v]

選項  
--說明 顯示使用資訊
-o、--only 根據以下條件篩選執行個體清單:運作中、已停止、祖系:、子系:或親屬:
-v、--verbose 顯示每個執行個體的詳細資訊

範例

To list components in the topology:

    $ ffx component list

    To list all running components in the topology:

    $ ffx component list --only running

    To list all stopped components in the topology:

    $ ffx component list --only stopped

    To list the ancestors of a component named `foo`:

    $ ffx component list --only ancestor:foo

    To list the descendants of a component named `foo`:

    $ ffx component list --only descendant:foo

    To list both the ancestors and descendants of a component named `foo`:

    $ ffx component list --only relatives:foo

重新載入

以遞迴方式停止、未解析及啟動元件執行個體,更新程式碼和拓撲,同時保留資源


Usage:  ffx component reload query

選項  
--說明 顯示使用資訊

範例

To reload a component instance designated by the moniker `/core/ffx-laboratory:foo`:

    $ ffx component reload /core/ffx-laboratory:foo

備忘錄

  • To learn more about running components, see https://fuchsia.dev/go/components/run

resolve

解析元件執行個體


Usage:  ffx component resolve query

選項  
--說明 顯示使用資訊

範例

To resolve the component designated by the provided moniker `/core/brightness_manager`:

    $ ffx component resolve /core/brightness_manager

路線

在執行階段對元件執行能力轉送。


Usage:  ffx component route target [filter]

選項  
--說明 顯示使用資訊

範例

To route capabilities from `font_provider`:

$ ffx component route /core/font_provider

This will perform routing on all the capabilities used or exposed by `font_provider`, and display
information for each route including its status (success or failure) and the identity of the source
component providing the capability.

$ ffx component route fonts.cm

This does the same thing, except with a fuzzy match (on the URL).

$ ffx component route /core/font_provider fuchsia.pkg.FontResolver

This will perform routing on capabilities used or exposed by `font_provider` that match
`fuchsia.pkg.FontResolver`.

$ ffx component route /core/font_provider use:fuchsia.pkg.FontResolver,expose:fuchsia.fonts.Provider

This will perform routing from `font_provider` on used capability `fuchsia.pkg.FontResolver` and
exposed capability `fuchsia.fonts.Provider`.

$ ffx component route /core/font_provider fuchsia.pkg

Fuzzy matching by capability is also supported. This will perform routing from `font_provider` on
any used or exposed capability matching *fuchsia.pkg*.

run

在元件拓撲中的現有集合內建立並啟動元件執行個體。


Usage:  ffx component run [-r] [-f] [--connect-stdio] [--config <config...>] moniker url

選項  
--說明 顯示使用資訊
-r、--recreate 刪除並重新建立元件執行個體 (如果已有的話)
-f、--follow-logs 啟動後,開始透過啟動的元件輸出記錄
--connect-stdio 將 stdin、stdout 和 stderr 連線至元件 (要求元件必須位於具備 Single_run 耐用性的集合中)
--config 為正在執行的元件提供設定覆寫設定欄位中必須包含 mutability: [ "parent" ]。以 KEY=VALUE 格式指定,其中 VALUE 是 JSON 字串,可解析為正確的設定值類型。

範例

To create a component instance from the `hello-world-rust` component URL:

    $ ffx component run /core/ffx-laboratory:hello-world fuchsia-pkg://fuchsia.com/hello-world-rust#meta/hello-world-rust.cm

備忘錄

  • This command is a shorthand for the following:

    $ ffx component create $ ffx component start

To learn more about running components, see https://fuchsia.dev/go/components/run

節目

顯示元件執行個體的詳細資訊


Usage:  ffx component show query

選項  
--說明 顯示使用資訊

範例

To show information about the `brightness_manager` component instance, all of the
following commands are valid:

    $ ffx component show /core/brightness_manager
    $ ffx component show fuchsia-pkg://fuchsia.com/brightness_manager#meta/brightness_manager.cm
    $ ffx component show meta/brightness_manager.cm
    $ ffx component show brightness_manager

備忘錄

  • This command supports partial matches over the moniker, URL and instance ID

開始

啟動元件


Usage:  ffx component start [--debug] query

選項  
--說明 顯示使用資訊
--偵錯 在偵錯工具中啟動元件如要對執行中的元件進行偵錯,請考慮 ffx component debug

範例

To start the component instance designated by the moniker `/core/brightness_manager`:

    $ ffx component start /core/brightness_manager

The start the brightness manager in the debugger, use the --debug flag:

    $ ffx component start /core/brightness_manager --debug

備忘錄

  • To learn more about running components, see https://fuchsia.dev/go/components/run

停止

停止元件執行個體


Usage:  ffx component stop query

選項  
--說明 顯示使用資訊

範例

To stop the component instance designated by the moniker `/core/brightness_manager`:

    $ ffx component stop /core/brightness_manager

備忘錄

  • To learn more about running components, see https://fuchsia.dev/go/components/run

儲存空間

管理元件的儲存空間功能


Usage:  ffx component storage [--provider <provider>] [--capability <capability>] [subcommand...]

選項  
--說明 顯示使用資訊
--供應商 儲存體供應商元件的路徑名稱預設值為「/core」
--功能 所用儲存體的能力名稱。範例:「data」、「cache」和「tmp」預設為「data」
子指令  
複製 將檔案複製到元件儲存空間或從元件儲存空間複製。如果目標位置中已有檔案,系統會覆寫該檔案。
刪除 從元件儲存空間刪除檔案。
全部刪除 刪除特定元件的儲存空間內容。
清單 列出元件儲存空間的內容。
make-directory 在元件儲存空間中建立新目錄。如果目錄已存在,則這項作業不需要人工管理。

複製

將檔案複製到元件儲存空間或從元件儲存空間複製。如果目標位置中已有檔案,系統會覆寫該檔案。


Usage:  ffx component storage copy source_path destination_path

選項  
--說明 顯示使用資訊

範例

To copy `credentials.json` from the current working directory on the host to the `settings` directory of a component's storage:

    $ ffx component storage copy ./credentials.json 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings/credentials.json

To copy `credentials.json` from the current working directory on the host to the `settings` directory from a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data copy ./credentials.json f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::settings/credentials.json

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id

Delete 鍵

從元件儲存空間刪除檔案。


Usage:  ffx component storage delete path

選項  
--說明 顯示使用資訊

範例

To delete `credentials.json` from the root directory of a component's persistent storage:

    $ ffx component storage delete 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::credentials.json

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id

全部刪除

刪除特定元件的儲存空間內容。


Usage:  ffx component storage delete-all moniker

選項  
--說明 顯示使用資訊

範例

To delete the contents of the storage for a component with moniker `foo`:

    $ ffx component storage delete-all foo

Note: although unusual, the user may specify internal instance IDs in the moniker such as `foo:0/bar:2`.

list

列出元件儲存空間的內容。


Usage:  ffx component storage list path

選項  
--說明 顯示使用資訊

範例

To list the contents of the `settings` directory in a component's storage:

    $ ffx component storage list 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings

To list the contents of the root directory of a component's storage:

    $ ffx component storage list 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::/

To list the contents of a directory using a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data list f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::/

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id

Make-directory

在元件儲存空間中建立新目錄。如果目錄已存在,則這項作業不需要人工管理。


Usage:  ffx component storage make-directory path

選項  
--說明 顯示使用資訊

範例

To make a `settings` directory in a storage:

    $ ffx component storage make-directory 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520::settings

To make a `settings` directory in a storage from a different provider and capability:

    $ ffx component storage --provider /core/test_manager --capability data make-directory f1a52f7b4d7081060a3295fd36df7b68fb0518f80aae0eae8a3fc1d55231375f::settings

Note: 2042425d4b16ac396ebdb70e40845dc51516dd25754741a209d1972f126a7520 is the instance ID of
the component whose storage is being accessed.

To learn about component instance IDs, see https://fuchsia.dev/go/components/instance-id

config

查看及切換預設和使用者設定


Usage:  ffx config [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 將 config 值加到陣列的結尾處
數據分析 啟用或停用數據分析功能
check-ssh-keys 請檢查安全殼層金鑰設定,並視需要建立金鑰。
env 列出環境設定
get 顯示設定值
移除 移除指定層級的設定
設定 調整設定。

新增

將 config 值加到陣列的結尾處


Usage:  ffx config add [-l <level>] [-b <build-dir>] name value

選項  
--說明 顯示使用資訊
-l、--level 設定層級可能的值為「user」、「build」、「global」。預設值為「user」。
-b、--build-dir 選用的建構目錄,用於與所提供的建構設定建立關聯 (用於「build」設定)。如未提供,系統可能會嘗試自動探索使用中的建構目錄。

備忘錄

  • This will always add to the end of an array.  Adding to a subtree is not supported. If the current value is not an array, it will convert the value to an array.  If you want to insert a value in a different position, consider editing the configuration file directly.  Configuration file locations can be found by running ffx config env get command.

Analytics (分析)

啟用或停用數據分析功能


Usage:  ffx config analytics [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
停用 停用分析功能。
enable 啟用 Analytics (分析)
節目 顯示數據分析

停用

停用分析功能。


Usage:  ffx config analytics disable

選項  
--說明 顯示使用資訊

enable

啟用 Analytics (分析)


Usage:  ffx config analytics enable

選項  
--說明 顯示使用資訊

節目

顯示數據分析


Usage:  ffx config analytics show

選項  
--說明 顯示使用資訊

檢查 SSH 金鑰

請檢查安全殼層金鑰設定,並視需要建立金鑰。


Usage:  ffx config check-ssh-keys

選項  
--說明 顯示使用資訊

env

列出環境設定


Usage:  ffx config env [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 指定級別的清單環境
設定 調整環境設定

get

指定級別的清單環境


Usage:  ffx config env get [level]

選項  
--說明 顯示使用資訊

設定

調整環境設定


Usage:  ffx config env set [-l <level>] [-b <build-dir>] file

選項  
--說明 顯示使用資訊
-l、--level 設定層級可能的值為「user」、「build」、「global」。預設值為「user」。
-b、--build-dir 選用的建構目錄,用於與所提供的建構設定建立關聯 (用於「build」設定)。如未提供,系統可能會嘗試自動探索使用中的建構目錄。

get

顯示設定值


Usage:  ffx config get [-p <process>] [-s <select>] [-b <build-dir>] [name]

選項  
--說明 顯示使用資訊
-p、--process 如何處理結果可能的值包括「r/raw」、「s/sub/replace」或「f/file」。預設為「alternate」。目前只有在指定名稱時才支援。
-s、--select 如何收集結果可能的值為「first」和「all」。預設為「第一個」。如果值為「第一個」,系統會傳回根據優先順序找到的第一個值。如果值為「all」,所有設定層級的值都會匯總並傳回。目前只有在指定名稱時才支援。
-b、--build-dir 選用的建構目錄,用於與所提供的建構設定建立關聯 (用於「build」設定)。如未提供,系統可能會嘗試自動探索使用中的建構目錄。
錯誤  
2 找不到值

remove

移除指定層級的設定


Usage:  ffx config remove [-l <level>] [-b <build-dir>] name

選項  
--說明 顯示使用資訊
-l、--level 設定層級可能的值為「user」、「build」、「global」。預設值為「user」。
-b、--build-dir 選用的建構目錄,用於與所提供的建構設定建立關聯 (用於「build」設定)。如未提供,系統可能會嘗試自動探索使用中的建構目錄。

備忘錄

  • This will remove the entire value for the given name.  If the value is a subtree or array, the entire subtree or array will be removed.  If you want to remove a specific value from an array, consider editing the configuration file directly.  Configuration file locations can be found by running ffx config env get command.

設定

調整設定。


Usage:  ffx config set [-l <level>] [-b <build-dir>] name value

選項  
--說明 顯示使用資訊
-l、--level 設定層級可能的值為「user」、「build」、「global」。預設值為「user」。
-b、--build-dir 選用的建構目錄,用於與所提供的建構設定建立關聯 (用於「build」設定)。如未提供,系統可能會嘗試自動探索使用中的建構目錄。

Daemon

與/控制 ffx Daemon 互動


Usage:  ffx daemon [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
當機 當機 Daemon
echo 對 Daemon 執行 echo 測試
掛斷 懸掛 Daemon
記錄 轉儲 Daemon 記錄檔
通訊端 查詢關於 Daemon 通訊端的資訊
開始 以 Daemon 形式執行 (通常不需要),因為 Daemon 會依需求自動啟動。主要用於偵錯
停止 停止執行中的 Daemon

秒睡

當機 Daemon


Usage:  ffx daemon crash

選項  
--說明 顯示使用資訊

echo

對 Daemon 執行 echo 測試


Usage:  ffx daemon echo [text]

選項  
--說明 顯示使用資訊

稍候

懸掛 Daemon


Usage:  ffx daemon hang

選項  
--說明 顯示使用資訊

log

轉儲 Daemon 記錄檔


Usage:  ffx daemon log [-f] [-l <line-count>]

選項  
--說明 顯示使用資訊
-f、--follow 即時列印附加的記錄
-l、--line-count 顯示最近的記錄行。

通訊端

查詢關於 Daemon 通訊端的資訊


Usage:  ffx daemon socket

選項  
--說明 顯示使用資訊

開始

以 Daemon 形式執行 (通常不需要),因為 Daemon 會依需求自動啟動。主要用於偵錯


Usage:  ffx daemon start [--path <path>]

選項  
--說明 顯示使用資訊
--path 覆寫通訊端將繫結至的路徑

停止

停止執行中的 Daemon


Usage:  ffx daemon stop [-w] [--no-wait] [-t <timeout-ms>]

選項  
--說明 顯示使用資訊
-w、--wait 無限期等待 Daemon 停止再離開 (不應用於自動化系統)
--no-wait 不會等待 Daemon 停止 (預設行為 - 最終會遭到淘汰)
-t、--timeout-ms 選用的逾時時間 (以毫秒為單位),等待 Daemon 停止。如果 Daemon 未自行退出,將嘗試終止 Daemon。

偵錯

開始偵錯工作階段。


Usage:  ffx debug [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
連線 啟動偵錯工具並連線至目標
core 啟動偵錯工具並開啟迷你傾印
當機 鎖定目標叢集內
Fidl 監控目標的 FIDL 流量
Limbo 控管目標上的程序
符號索引 管理其他偵錯指令使用的符號來源
符號 以標記格式表示回溯追蹤記錄

連線

啟動偵錯工具並連線至目標


Usage:  ffx debug connect [--debugger <debugger>] [--agent-only] [-a <attach...>] [-e <execute...>] [--new-agent] [zxdb_args...]

選項  
--說明 顯示使用資訊
--debugger 在其他偵錯工具中啟動 zxdb。目前唯一有效的選項是「lldb」。
--agent-only 只能啟動偵錯代理程式,但無法啟動 zxdb。系統會列印 UNIX 通訊端的路徑,且該路徑可在 zxdb 殼層中透過「connect -u」進行連線。
-a、--attach 附加至指定程序系統會採用控制台中「attach」指令的方式來剖析引數。
-e、--execute 執行一個 zxdb 指令系統會依序執行多個指令。
--new-agent 一律為此 zxdb 叫用產生新的 DebugAgent 執行個體。

Core

啟動偵錯工具並開啟迷你傾印


Usage:  ffx debug core [--zxdb-args <zxdb-args...>] [minidump]

選項  
--說明 顯示使用資訊
--zxdb-args 傳遞至 zxdb 的額外引數。

秒睡

鎖定目標叢集內


Usage:  ffx debug crash

選項  
--說明 顯示使用資訊

未婚

監控目標的 FIDL 流量


Usage:  ffx debug fidl [--from <from>] [--to <to>] [--format <format>] [--with <with...>] [--with-process-info] [--stack <stack>] [--syscalls <syscalls...>] [--exclude-syscalls <exclude-syscalls...>] [--messages <messages...>] [--exclude-messages <exclude-messages...>] [--trigger <trigger...>] [--thread <thread...>] [--dump-messages] [--remote-pid <remote-pid...>] [-f <remote-name...>] [--extra-name <extra-name...>] [-c <remote-component...>] [--extra-component <extra-component...>] [--fidl-ir-path <fidl-ir-path...>] [extra_args...]

選項  
--說明 顯示使用資訊
--寄件者 會指定來源。來源可以是裝置:這是預設輸入內容。輸入內容來自一或多個程序的即時監控。您必須指定至少一個「--remote-pid」、「--remote-name」、「--remote-工作-id」、「--'remote-工作-name」、「run」。傾印:輸入內容來自一或多個程式的記錄輸出內容。記錄中轉儲系統呼叫的行會解碼,並以已解碼的版本取代。所有其他行則維持不變。:播放。用於重播先前使用 --to (protobuf 格式) 錄製的工作階段。Path 提供要讀取的檔案名稱。如果路徑為「-」,系統會使用標準輸入內容。這個選項最多只能使用一次。
--至 工作階段會儲存至指定的檔案 (二進位 protobuf 格式)。儲存工作階段後,您可以使用「--來自 」重播該工作階段。系統會儲存原始資料。換句話說,這些儲存的資料與顯示內容各自獨立。
--格式 工作階段傾印的顯示格式。目前可用的格式包括:漂亮:本講座已列印出來 (搭配顏色)。如果未使用 --with ,這是預設輸出。json:工作階段會以 json 格式列印。textproto:工作階段會以文字 protobuf 格式列印。無:在標準輸出內容不會顯示任何內容 (這個選項只有在與 --to--with 搭配使用時有意義)。如果沒有輸出,fidlcat 速度會比較快 (較能監控即時元件)。這是使用 --with 時的預設輸出內容。
--使用 會指定額外摘要輸出內容。摘要:工作階段結束時,標準輸出內容會顯示工作階段摘要。頂端:在工作階段結束時,產生會依照程序、通訊協定和方法將輸出內容分組的檢視畫面。群組會按事件數量排序,因此執行緒會更早列出關聯事件較多的群組。每個執行緒都會顯示所有活動的簡短版本。可以將等號後面加上路徑的串連,串連為將檔案輸出檔案 (而非標準輸出) 的選項 (例如:--with callout=/tmp/x)。這個選項可以多次使用。
--with-process-info 在每一行顯示程序名稱、程序 ID 和執行緒 ID (適用於 grep)。
--堆疊 定義要顯示 0 的堆疊框架數量:無 (預設值) 1:呼叫站 (1 至 4 層) 2:完整堆疊框架 (會增加部分負載)
--syscalls 可選取要解碼及顯示的系統呼叫的規則運算式。你可以多次指定此選項。預設只會顯示 zxchannel。* 只會顯示系統呼叫。如要顯示所有系統呼叫,請使用:--syscalls ".*"
--exclude-syscalls 會選取系統呼叫不要解碼及顯示的規則運算式。你可以多次指定此選項。如要顯示,系統呼叫必須驗證 --syscalls,且不能驗證 --disable-syscalls。如要顯示所有系統呼叫而非 zx_handle 系統呼叫,請使用:--syscalls「." --Exclude-syscalls "zxhandle」。
--訊息 可用來選取要顯示的訊息。如要顯示訊息,方法名稱必須符合規則運算式。你可以多次指定此選項。訊息篩選適用於方法的完整名稱。
--exclude-messages 可以選取要顯示的訊息的規則運算式。如果訊息方法名稱符合 regexp,就不會顯示郵件 (即使訊息符合 --messages 也一樣)。你可以多次指定此選項。訊息篩選適用於方法的完整名稱。
--trigger 只有在方法名稱符合篩選器條件的訊息時,系統才會開始顯示訊息和系統呼叫。你可以多次指定此選項。訊息篩選適用於方法的完整名稱。
--執行緒 僅顯示指定執行緒的事件。你可以多次指定此選項。根據預設,系統會顯示所有事件。
--dump-messages 即使我們可解碼訊息,也會一律以十六進位傾印。
--remote-pid 要追蹤的遠端程序程式
-f、--remote-name 程序的 方法。Fidlcat 會監控名稱包含 的所有現有與未來程序 ( 是程序名稱的子字串)。你可以多次指定此選項。與 --remote-job-id 或 --remote-job-name 搭配使用時,只有所選工作中的程序才會納入考量。
--extra-name 例如「--remote-name」,但對於這些程序,只有在「--remote-name」或「--remote-元件」的其中一個啟動後才才會啟動監控。此外,即使部分「--extra-name」程序仍在執行,Fidlcat 也會在最後一個「--remote-name」或「--remote-元件」的停止時停止。如果使用這個選項,你必須指定至少一個包含「--remote-name」或「--remote-元件」的篩選器。你可以多次指定此選項。
-c、--remote-component 需要監控的元件網址或元件路徑名稱。元件中執行的所有程序都會組成。你可以多次指定此選項。
--extra-component 例如「--remote-component」,但對於這些元件,只有在「--remote-name」或「--remote-component」的其中一個啟動後才才會開始監控。此外,即使部分「--extra-元件」仍在執行,Fidlcat 也會在最後一個「--remote-name」或「--remote-元件」停止時停止。如果使用這個選項,你必須指定至少一個包含「--remote-name」或「--remote-元件」的篩選器。你可以多次指定此選項。
--fidl-ir-path 將指定路徑新增為 FIDL IR 的存放區,格式為 .fidl.json。傳送檔案後,系統會新增指定檔案。傳送目錄後,系統會將所有 .fidl.json 檔案加入該目錄,以及從該處間接存取的任何目錄。argfile 包含一份以換行符號分隔的清單,當中列出與 argfile 的目錄相關的 .fidl.json 檔案;傳送 argfile (以「@」字元開頭) 會加入該 argfile 中列出的所有檔案。你可以多次指定此選項。

Limbo

控管目標上的程序


Usage:  ffx debug limbo [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
停用 停用程序 Linux。系統會釋出任何待處理的程序。
enable 啟用程序 Limbo現在系統會開始擷取當機程序。
清單 會列出目前在 Limbo 上等待的程序。必須啟用狀態。
發布 從 Limbo 中發布程序。必須啟用狀態。
狀態 查詢 Linux 程序的狀態

停用

停用程序 Linux。系統會釋出任何待處理的程序。


Usage:  ffx debug limbo disable

選項  
--說明 顯示使用資訊

enable

啟用程序 Limbo現在系統會開始擷取當機程序。


Usage:  ffx debug limbo enable

選項  
--說明 顯示使用資訊

list

會列出目前在 Limbo 上等待的程序。必須啟用狀態。


Usage:  ffx debug limbo list

選項  
--說明 顯示使用資訊

發布

從 Limbo 中發布程序。必須啟用狀態。


Usage:  ffx debug limbo release pid

選項  
--說明 顯示使用資訊

資格

查詢 Linux 程序的狀態


Usage:  ffx debug limbo status

選項  
--說明 顯示使用資訊

符號-索引

管理其他偵錯指令使用的符號來源


Usage:  ffx debug symbol-index [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 在符號索引中新增路徑或網址
清理 移除所有不存在的路徑
清單 以符號索引顯示內容
移除 移除符號索引的路徑

備忘錄

  • symbol-index is a global configuration used by debugging tools to locate
    symbol files.

新增

在符號索引中新增路徑或網址


Usage:  ffx debug symbol-index add [--build-dir <build-dir>] source

選項  
--說明 顯示使用資訊
--build-dir 可供 zxdb 用來找出原始碼的選用建構目錄

備忘錄

  • Add a path or a debuginfod server to the symbol index, e.g.,
    
    • A build-id directory, with an optional build directory.
    • An ids.txt file, with an optional build directory.
    • A file that ends with .symbol-index.json.
    • https://debuginfod.debian.net

Duplicated adding of the same path or url is a no-op, regardless of the optional build directory.

純潔

移除所有不存在的路徑


Usage:  ffx debug symbol-index clean

選項  
--說明 顯示使用資訊

備忘錄

  • Remove all non-existent paths from the symbol index, useful as a garbage
    collection.

list

以符號索引顯示內容


Usage:  ffx debug symbol-index list [-a]

選項  
--說明 顯示使用資訊
-a、--aggregated 顯示匯總符號索引

remove

移除符號索引的路徑


Usage:  ffx debug symbol-index remove source

選項  
--說明 顯示使用資訊

備忘錄

  • Remove a path or a debuginfod server from the symbol index, e.g.,
    
    • A build-id directory.
    • An ids.txt file.
    • A file that ends with .symbol-index.json.
    • https://debuginfod.debian.net

符號化

以標記格式表示回溯追蹤記錄


Usage:  ffx debug symbolize [--auth] [--no-prettify] [symbolizer_args...]

選項  
--說明 顯示使用資訊
--auth 啟動驗證程序。
--no-prettify 請勿預先處理返回追蹤記錄。

醫生

針對 ffx 工具和主機環境執行常見的檢查


Usage:  ffx doctor [--record] [--no-config] [--retry-count <retry-count>] [--retry-delay <retry-delay>] [--restart-daemon] [-v] [--output-dir <output-dir>] [--repair-keys]

選項  
--說明 顯示使用資訊
--record 產生含有記錄檔的輸出 ZIP 檔案
--no-config 不要加入 ffx 設定檔
--retry-count 嘗試重試連線失敗的次數
--retry-delay 嘗試連線時發生逾時延遲時間 (毫秒)
--restart-daemon 即使連線正在運作,仍強制重新啟動 Daemon
-v、--verbose 詳細,顯示所有步驟
--output-dir 覆寫醫生記錄的預設輸出目錄
--repair-keys 檢查安全殼層金鑰一致性,並視需要修復。這可能會導致裝置重刷。

範例

To run diagnostics:

    $ ffx doctor

To capture the output and additional logs:

    $ ffx doctor --record

By default, this outputs the zip in the current directory.

To override output dir:

    $ ffx doctor --record --output-dir /tmp/ffx

備忘錄

  • The doctor subcommand automatically attempts to repair common target
    interaction issues and provides useful diagnostic information to the user.

By default, running ffx doctor attempts to establish a connection with the daemon, and restarts the daemon if there is no connection. The default retry_count is '3' and the default 'retry_delay` is '2000' milliseconds.

net

查看及管理目標網路設定


Usage:  ffx net [--realm <realm>] [subcommand...]

選項  
--說明 顯示使用資訊
--領域 指定運作領域預設為核心網路領域。
子指令  
dhcp 介面 dhcp 用戶端的指令
dhcpd 控管 dhcp 伺服器的指令
dns 控管 DNS 解析器
篩選器 設定封包篩選的指令
篩選器 - 已淘汰 使用已淘汰 API 設定封包篩選的指令
if 網路介面的指令
記錄 記錄指令
遷移 用於控制從 netstack2 遷移至 netst33 的 Netstack 選項
鄰居 鄰近資料表的指令
路線 路徑資料表的指令

dhcp

介面 dhcp 用戶端的指令


Usage:  ffx net dhcp [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
開始 在介面中啟動 dhcp 用戶端
停止 在介面中停用 dhcp 用戶端

開始

在介面中啟動 dhcp 用戶端


Usage:  ffx net dhcp start nicid or name:ifname

選項  
--說明 顯示使用資訊

停止

在介面中停用 dhcp 用戶端


Usage:  ffx net dhcp stop nicid or name:ifname

選項  
--說明 顯示使用資訊

Dhcpd

控管 dhcp 伺服器的指令


Usage:  ffx net dhcpd [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
清楚租賃 主要命令是清除由 dhcpd 維護的租用。
get 擷取 DHCP 選項值或伺服器參數值的主要指令。
清單 列出所有 DHCP 選項值或伺服器參數值的主要指令。
重設 重設所有 DHCP 選項值或伺服器參數值的主要指令。
設定 設定 DHCP 選項值或伺服器參數值的主要指令。
開始 啟動 DHCP 伺服器的主要指令。
停止 停止 DHCP 伺服器的主要指令。

清除釋出

主要命令是清除由 dhcpd 維護的租用。


Usage:  ffx net dhcpd clear-leases

選項  
--說明 顯示使用資訊

get

擷取 DHCP 選項值或伺服器參數值的主要指令。


Usage:  ffx net dhcpd get [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
選項 表示 DHCP 選項引數的次要指令。
參數 表示伺服器參數引數的次要指令。
選項

表示 DHCP 選項引數的次要指令。


Usage:  ffx net dhcpd get option [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
all-subnets-local 此標記會指出已連線網路的所有子網路是否使用相同的 MTU,
arp-cache-timeout ARP 快取項目逾時。
Boot-file-size 用戶端的預設啟動映像檔大小。
bootfile-name 用戶端的開機磁碟名稱。
廣播地址 用戶端子網路的廣播位址。
cookie-server 用戶端可用的 RFC 865 Cookie 伺服器。
default-finger-server 用戶端可用的預設 Finger 伺服器。
default-ip-ttl 外送 IP 資料元的預設存留時間。
default-irc-server 用戶端可用的預設 IRC 伺服器。
default-www-server 用戶端可用的預設 WWW 伺服器。
網域名稱 用戶端的網域名稱。
網域名稱伺服器 用戶端可用的網域名稱系統伺服器。
乙太網路封裝 此標記可指定用戶端應使用乙太網路 v2 還是 IEEE 802.3 封裝。
Extension-path 由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。
主機名稱 客戶的名稱。
impress-server 提供給用戶端的 Imagen Impress 伺服器。
interface-mtu 用戶端介面的 MTU。
ip-forwarding 標記啟用/停用 IP 層封包轉送功能。
log-server 用戶端可用的 MIT-LCS UDP 記錄伺服器。
lpr-server 用戶端可用的 RFC 1179 線型印表機伺服器。
口罩供應商 此標記可註明用戶端是否應透過 ICMP 回應子網路遮罩探索要求。
max-datagram-reassembly-size 用戶端可重組的資料量上限。
max-message-size 參與者願意接受的 DHCP 訊息長度上限。
Merit-dump-file 核心傾印檔案的路徑名稱。
mobile-ip-home-agent 用戶端可以使用行動 IP 家用代理程式。
名稱伺服器 用戶端可使用 IEN 116 名稱伺服器。
net-bios-over-tcpip-distribution-server 用戶端可用的 NetBIOS 資料元分佈伺服器。
net-bios-over-tcpip-name-server 用戶端可用的 NetBIOS 名稱伺服器。
net-bios-over-tcpip-node-type 用戶端應使用的 NetBIOS 節點類型。
net-bios-over-tcpip-scope 用戶端的 NetBIOS 範圍參數。
網路資訊伺服器 用戶端可用的「網路資訊服務」伺服器。
network-information-service-domain 客戶的 Network Information Service 網域名稱。
network-information-service-plus-domain Network Information System+ 網域名稱。
network-information-service-plus-servers 用戶端可用的 Network Information System+ 伺服器。
network-time-protocol-servers 用戶端可用的網路時間通訊協定伺服器。
nntp-server 用戶端可用的 NNTP 伺服器。
non-local-source-routing 標記啟用/停用具有非本機來源路徑的 IP 封包轉送功能。
path-mtu-aging-timeout 建立路徑 MTU 值時使用的逾時。
path-mtu-plateau-table 路徑 MTU 探索的 MTU 大小表格。
效能-遮罩-探索 此標記可註明用戶端是否應透過 ICMP 執行子網路遮罩探索作業。
perform-router-discovery 此標記可註明用戶端是否應使用 Router Discovery 啟動路由器。
政策篩選器 非本機來源轉送的政策篩選器。
pop3-server 用戶端可用的 POP3 伺服器。
重新繫結時間值 用戶端轉換為重新繫結狀態的時間間隔。
續訂時間值 用戶端轉換至續約狀態的時間間隔。
資源位置伺服器 用戶端可用的 RFC 887 資源位置伺服器。
根路徑 由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。
路由器 用戶端子網路中的路由器。
router-solicitation-address 路由器資訊要求的目標位址。
smtp-server 用戶端可用的 SMTP 伺服器。
static-route 用戶端應置於其轉送快取中的靜態路徑。
stda-server 用戶端可使用的 StreetTalk 目錄協助伺服器。
street-talk-server 用戶端可用的 StreetTalk 伺服器。
子網路-遮罩 用戶端的子網路遮罩。
swap-server 用戶端替換伺服器位址。
tcp-default-ttl 傳出 TCP 區隔的預設存留時間。
tcp-keepalive-garbage 此標記可指定用戶端是否應傳送有八位元的垃圾的 TCP 保持運作訊息。
tcp-keepalive-interval 用戶端在傳送 TCP 保持運作訊息前應等待的間隔。
tftp-server-name 可供用戶端使用的 TFTP 伺服器。
時間偏移 用戶端與世界標準時間的偏移。
時間伺服器 用戶端可用的時間通訊協定伺服器。
預告片 此標記可指定客戶是否應在 ARP 中協商預告片的使用情況。
供應商專屬資訊 可在 DHCP 用戶端和 DHCP 伺服器之間交換供應商特定資訊的選項。
x-window-system-display-manager X Windows System Display Manager 系統提供給用戶端。
x-window-system-font-server 用戶端可用的 X Window System 字型伺服器。
所有子網路-本機

此標記會指出已連線網路的所有子網路是否使用相同的 MTU,


Usage:  ffx net dhcpd get option all-subnets-local [--local]

選項  
--說明 顯示使用資訊
--local 一個旗標,表示用戶端連結的 IP 網路所有子項目是否都具有相同的 MTU。
ARP-Cache 逾時

ARP 快取項目逾時。


Usage:  ffx net dhcpd get option arp-cache-timeout [--timeout <timeout>]

選項  
--說明 顯示使用資訊
--timeout ARP 快取項目的逾時時間 (以秒為單位)。
啟動檔案大小

用戶端的預設啟動映像檔大小。


Usage:  ffx net dhcpd get option boot-file-size [--size <size>]

選項  
--說明 顯示使用資訊
--尺寸 用戶端預設啟動映像檔的大小 (以 512 八位元表示)。
啟動檔案名稱

用戶端的開機磁碟名稱。


Usage:  ffx net dhcpd get option bootfile-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用戶端的啟動檔案名稱。當 file 欄位已超載以提供選項時,則應使用此選項。
廣播地址

用戶端子網路的廣播位址。


Usage:  ffx net dhcpd get option broadcast-address [--addr <addr>]

選項  
--說明 顯示使用資訊
--addr 用戶端子網路的廣播位址。法值依 RFC 1122 定義。

用戶端可用的 RFC 865 Cookie 伺服器。


Usage:  ffx net dhcpd get option cookie-server [--cookie-servers <cookie-servers...>]

選項  
--說明 顯示使用資訊
--cookie-servers 用戶端可用的 RFC 865 Cookie 伺服器清單,按照偏好順序排列。
預設手指伺服器

用戶端可用的預設 Finger 伺服器。


Usage:  ffx net dhcpd get option default-finger-server [--finger-servers <finger-servers...>]

選項  
--說明 顯示使用資訊
--finger-servers 用戶端可用的預設 Finger 伺服器位址清單,按偏好排序。
default-ip-ttl

外送 IP 資料元的預設存留時間。


Usage:  ffx net dhcpd get option default-ip-ttl [--ttl <ttl>]

選項  
--說明 顯示使用資訊
--ttl 要在傳出 IP 資料架構中使用的預設存留時間。這個值必須介於 1 至 255 之間。
default-irc-server

用戶端可用的預設 IRC 伺服器。


Usage:  ffx net dhcpd get option default-irc-server [--irc-servers <irc-servers...>]

選項  
--說明 顯示使用資訊
--irc-servers 用戶端可用的 Internet Relay Chat 伺服器位址清單,依照優先順序排列。
default-www-server

用戶端可用的預設 WWW 伺服器。


Usage:  ffx net dhcpd get option default-www-server [--www-servers <www-servers...>]

選項  
--說明 顯示使用資訊
--www-servers 用戶端可用的預設全球資訊網 (WWW) 伺服器位址清單,依照偏好順序列出。
網域名稱

用戶端的網域名稱。


Usage:  ffx net dhcpd get option domain-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用於解析 DNS 主機名稱的用戶端網域名稱。
網域名稱-伺服器

用戶端可用的網域名稱系統伺服器。


Usage:  ffx net dhcpd get option domain-name-server [--domain-name-servers <domain-name-servers...>]

選項  
--說明 顯示使用資訊
--domain-name-servers 用戶端可用的 DNS 伺服器清單 (依照偏好順序);
乙太網路封裝

此標記可指定用戶端應使用乙太網路 v2 還是 IEEE 802.3 封裝。


Usage:  ffx net dhcpd get option ethernet-encapsulation [--encapsulate]

選項  
--說明 顯示使用資訊
--封裝 一個旗標,指定 false 時用戶端應使用乙太網路 v2 封裝,若為 true,則使用 IEEE 802.3 封裝。
延伸路徑

由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。


Usage:  ffx net dhcpd get option extensions-path [--path <path>]

選項  
--說明 顯示使用資訊
--path TFTP 可擷取檔案的路徑名稱。這個檔案包含的資料可解讀為「BOOTP 供應商延伸模組」欄位。與 [BOOTP 供應商額外資訊] 欄位不同,這個檔案沒有限制的長度,因此系統會忽略代碼 18 的任何參照。
主機名稱

客戶的名稱。


Usage:  ffx net dhcpd get option host-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用戶端名稱,不一定符合本機網域名稱。
曝光伺服器

提供給用戶端的 Imagen Impress 伺服器。


Usage:  ffx net dhcpd get option impress-server [--impress-servers <impress-servers...>]

選項  
--說明 顯示使用資訊
--impress-servers 可供用戶端使用的 Imagen Impress 伺服器清單 (依照偏好順序)。
interface-mtu

用戶端介面的 MTU。


Usage:  ffx net dhcpd get option interface-mtu [--mtu <mtu>]

選項  
--說明 顯示使用資訊
--mtu 用戶端介面的 MTU。最小值為 68。
ip-forwarding

標記啟用/停用 IP 層封包轉送功能。


Usage:  ffx net dhcpd get option ip-forwarding [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 設為 true 時啟用 IP 層封包轉送的旗標。
log-server

用戶端可用的 MIT-LCS UDP 記錄伺服器。


Usage:  ffx net dhcpd get option log-server [--log-servers <log-servers...>]

選項  
--說明 顯示使用資訊
--log-servers 用戶端可用的 MIT-LCS UDP 記錄伺服器清單,按照偏好順序排序。
Lpr-server

用戶端可用的 RFC 1179 線型印表機伺服器。


Usage:  ffx net dhcpd get option lpr-server [--lpr-servers <lpr-servers...>]

選項  
--說明 顯示使用資訊
--lpr-servers 用戶端可用的 RFC 1179 線型印表機伺服器清單 (按偏好順序)。
口罩供應商

此標記可註明用戶端是否應透過 ICMP 回應子網路遮罩探索要求。


Usage:  ffx net dhcpd get option mask-supplier [--supplier]

選項  
--說明 顯示使用資訊
--供應商 旗標,表示用戶端是否應透過 ICMP 回應子網路遮罩探索要求。
max-datagram-reassembly-size

用戶端可重組的資料量上限。


Usage:  ffx net dhcpd get option max-datagram-reassembly-size [--size <size>]

選項  
--說明 顯示使用資訊
--尺寸 用戶端可重新組合的尺寸上限,以八位元表示。最小的法定值為 576。
max-message-size

參與者願意接受的 DHCP 訊息長度上限。


Usage:  ffx net dhcpd get option max-message-size [--length <length>]

選項  
--說明 顯示使用資訊
--length 參與者願意接受的 DHCP 訊息上限 (以八位元為單位)。最小值為 576。
商品傾印檔案

核心傾印檔案的路徑名稱。


Usage:  ffx net dhcpd get option merit-dump-file [--path <path>]

選項  
--說明 顯示使用資訊
--path 發生用戶端當機事件時,用戶端核心傾印的路徑名稱。
mobile-ip-home-agent

用戶端可以使用行動 IP 家用代理程式。


Usage:  ffx net dhcpd get option mobile-ip-home-agent [--home-agents <home-agents...>]

選項  
--說明 顯示使用資訊
--home-agents 用戶端可用的行動 IP 家用代理程式位址清單,按偏好排序。
名稱伺服器

用戶端可使用 IEN 116 名稱伺服器。


Usage:  ffx net dhcpd get option name-server [--name-servers <name-servers...>]

選項  
--說明 顯示使用資訊
--name-servers 列出用戶端可用的 IEN 116 名稱伺服器清單 (按照偏好順序排列)。
net-bios-over-tcpip-distribution-server

用戶端可用的 NetBIOS 資料元分佈伺服器。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-distribution-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 NetBIOS Datagram 發布伺服器清單,按照偏好順序列出。
net-bios-over-tcpip-name-server

用戶端可用的 NetBIOS 名稱伺服器。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-name-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 NetBIOS 名稱伺服器位址清單,依照偏好順序列出。
net-bios-over-tcpip-node-type

用戶端應使用的 NetBIOS 節點類型。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
b 節點 B 節點類型。
h 節點 H 節點類型。
m-node M 節點類型。
p-node P 節點類型。
# 個 b 節點

B 節點類型。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type b-node

選項  
--說明 顯示使用資訊
# 個節點

H 節點類型。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type h-node

選項  
--說明 顯示使用資訊
# m 節點

M 節點類型。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type m-node

選項  
--說明 顯示使用資訊
# 個 P 節點

P 節點類型。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-node-type p-node

選項  
--說明 顯示使用資訊
net-bios-over-tcpip-scope

用戶端的 NetBIOS 範圍參數。


Usage:  ffx net dhcpd get option net-bios-over-tcpip-scope [--scope <scope>]

選項  
--說明 顯示使用資訊
--scope NetBIOS,透過 TCP/IP 範圍參數取得,如 RFC 1001 中所定義,用戶端的 NetBIOS。
網路資訊伺服器

用戶端可用的「網路資訊服務」伺服器。


Usage:  ffx net dhcpd get option network-information-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 Network Information Service 伺服器位址清單,按偏好排序。
network-information-service-domain

客戶的 Network Information Service 網域名稱。


Usage:  ffx net dhcpd get option network-information-service-domain [--domain-name <domain-name>]

選項  
--說明 顯示使用資訊
--domain-name 客戶的 Network Information Service 網域名稱。
network-information-service-plus-domain

Network Information System+ 網域名稱。


Usage:  ffx net dhcpd get option network-information-service-plus-domain [--domain-name <domain-name>]

選項  
--說明 顯示使用資訊
--domain-name 用戶端的 Network Information System+ 網域名稱。
network-information-service-plus-servers

用戶端可用的 Network Information System+ 伺服器。


Usage:  ffx net dhcpd get option network-information-service-plus-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 Network Information System+ 伺服器位址清單 (按偏好順序列出)。
network-time-protocol-servers

用戶端可用的網路時間通訊協定伺服器。


Usage:  ffx net dhcpd get option network-time-protocol-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的網路時間通訊協定 (NTP) 伺服器位址清單,依照偏好順序列出。
nntp-server

用戶端可用的 NNTP 伺服器。


Usage:  ffx net dhcpd get option nntp-server [--nntp-servers <nntp-servers...>]

選項  
--說明 顯示使用資訊
--nntp-servers 用戶端可用的網路新聞傳輸通訊協定 (NNTP) 伺服器位址,按照偏好順序列出。
non-local-source-routing

標記啟用/停用具有非本機來源路徑的 IP 封包轉送功能。


Usage:  ffx net dhcpd get option non-local-source-routing [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 標記,讓具有非本機來源路徑的 IP 封包轉送。
path-mtu-aging-timeout

建立路徑 MTU 值時使用的逾時。


Usage:  ffx net dhcpd get option path-mtu-aging-timeout [--timeout <timeout>]

選項  
--說明 顯示使用資訊
--timeout 逾時 (以秒為單位),會在 RFC 1191 中的機制再次使用路徑 MTU 值時使用。
path-mtu-plateau-table

路徑 MTU 探索的 MTU 大小表格。


Usage:  ffx net dhcpd get option path-mtu-plateau-table [--mtu-sizes <mtu-sizes...>]

選項  
--說明 顯示使用資訊
--mtu-sizes MTU 大小清單,由小到大排序。最小值不得小於 68。
表演-遮罩-探索

此標記可註明用戶端是否應透過 ICMP 執行子網路遮罩探索作業。


Usage:  ffx net dhcpd get option perform-mask-discovery [--do-discovery]

選項  
--說明 顯示使用資訊
--do-discovery 旗標,表示用戶端是否應透過 ICMP 執行子網路遮罩探索作業。
perform-router-discovery

此標記可註明用戶端是否應使用 Router Discovery 啟動路由器。


Usage:  ffx net dhcpd get option perform-router-discovery [--do-discovery]

選項  
--說明 顯示使用資訊
--do-discovery 此標記表示用戶端是否應使用 Router Discovery 啟動路由器 (如 RFC 1256 中的定義)。
政策篩選器

非本機來源轉送的政策篩選器。


Usage:  ffx net dhcpd get option policy-filter [--addresses <addresses...>]

選項  
--說明 顯示使用資訊
--addresses IP 位址和子網路遮罩的組合清單如果傳入來源路徑的封包的下一個躍點與這些組合不符,系統就會捨棄該封包。
pop3 伺服器

用戶端可用的 POP3 伺服器。


Usage:  ffx net dhcpd get option pop3-server [--pop3-servers <pop3-servers...>]

選項  
--說明 顯示使用資訊
--pop3-servers 用戶端可用的郵局通訊協定 (POP3) 伺服器位址清單,依照偏好設定排序。
重新繫結時間值

用戶端轉換為重新繫結狀態的時間間隔。


Usage:  ffx net dhcpd get option rebinding-time-value [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 指定地址後,用戶端轉換至重新繫結狀態的時間間隔 (以秒為單位)。
續約時間值

用戶端轉換至續約狀態的時間間隔。


Usage:  ffx net dhcpd get option renewal-time-value [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 指定地址後,用戶端轉換至續約狀態的時間間隔 (以秒為單位)。
資源位置伺服器

用戶端可用的 RFC 887 資源位置伺服器。


Usage:  ffx net dhcpd get option resource-location-server [--resource-location-servers <resource-location-servers...>]

選項  
--說明 顯示使用資訊
--resource-location-servers 用戶端可用的 RFC 887 資源位置伺服器清單 (依偏好順序)。
根路徑

由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。


Usage:  ffx net dhcpd get option root-path [--path <path>]

選項  
--說明 顯示使用資訊
--path TFTP 可擷取檔案的路徑名稱。這個檔案包含的資料可解讀為「BOOTP 供應商延伸模組」欄位。與 [BOOTP 供應商額外資訊] 欄位不同,這個檔案沒有限制的長度,因此系統會忽略代碼 18 的任何參照。
路由器

用戶端子網路中的路由器。


Usage:  ffx net dhcpd get option router [--routers <routers...>]

選項  
--說明 顯示使用資訊
--routers 用戶端子網路中路由器的清單,並按照偏好順序列出。
路由器聯絡地址

路由器資訊要求的目標位址。


Usage:  ffx net dhcpd get option router-solicitation-address [--addr <addr>]

選項  
--說明 顯示使用資訊
--addr 用戶端應將路由器傳遞要求傳送至這個位址的位址。
smtp-server

用戶端可用的 SMTP 伺服器。


Usage:  ffx net dhcpd get option smtp-server [--smtp-servers <smtp-servers...>]

選項  
--說明 顯示使用資訊
--smtp-servers 用戶端可用的簡易郵件傳輸通訊協定 (SMTP) 伺服器位址清單,按照偏好順序列出。
靜態路徑

用戶端應置於其轉送快取中的靜態路徑。


Usage:  ffx net dhcpd get option static-route [--routes <routes...>]

選項  
--說明 顯示使用資訊
--routes 定義用戶端路由表的靜態路徑的目的地位址/下一個躍點位址組合清單。路徑應按照優先順序遞減列出。在靜態路徑中使用 0.0.0.0 做為目的地是違法行為。
stda-server

用戶端可使用的 StreetTalk 目錄協助伺服器。


Usage:  ffx net dhcpd get option stda-server [--stda-servers <stda-servers...>]

選項  
--說明 顯示使用資訊
--stda-servers 用戶端可用的 StreetTalk 目錄輔助伺服器位址清單,按優先順序排列。
街道-跟-伺服器

用戶端可用的 StreetTalk 伺服器。


Usage:  ffx net dhcpd get option street-talk-server [--streettalk-servers <streettalk-servers...>]

選項  
--說明 顯示使用資訊
--streettalk-servers 用戶端可用的 StreetTalk 伺服器位址清單,按偏好排序。
子網路-遮罩

用戶端的子網路遮罩。


Usage:  ffx net dhcpd get option subnet-mask [--mask <mask>]

選項  
--說明 顯示使用資訊
--mask 32 位元 IPv4 子網路遮罩
交換伺服器

用戶端替換伺服器位址。


Usage:  ffx net dhcpd get option swap-server [--address <address>]

選項  
--說明 顯示使用資訊
--address 用戶端交換伺服器的位址。
tcp-default-ttl

傳出 TCP 區隔的預設存留時間。


Usage:  ffx net dhcpd get option tcp-default-ttl [--ttl <ttl>]

選項  
--說明 顯示使用資訊
--ttl 用戶端應用於傳出 TCP 區隔的預設存留時間。最小值為 1。
tcp-keepalive-garbage

此標記可指定用戶端是否應傳送有八位元的垃圾的 TCP 保持運作訊息。


Usage:  ffx net dhcpd get option tcp-keepalive-garbage [--send-garbage]

選項  
--說明 顯示使用資訊
--send-garbage 此標記可指定用戶端是否應傳送具有八位元的垃圾的 TCP 保持運作訊息,以便與舊版實作項目相容。
tcp-keepalive-interval

用戶端在傳送 TCP 保持運作訊息前應等待的間隔。


Usage:  ffx net dhcpd get option tcp-keepalive-interval [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 間隔 (以秒為單位) 後,用戶端應在傳送 TCP 保持運作訊息之前等待。如果值為 0,表示用戶端不應傳送保持運作訊息,除非應用程式明確要求。
tftp-server-name

可供用戶端使用的 TFTP 伺服器。


Usage:  ffx net dhcpd get option tftp-server-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 可供用戶端使用的 TFTP 伺服器名稱當 sname 欄位已超載以提供選項時,則應使用此選項。
時間偏移

用戶端與世界標準時間的偏移。


Usage:  ffx net dhcpd get option time-offset [--offset <offset>]

選項  
--說明 顯示使用資訊
--offset 用戶端與世界標準時間的偏移量,以秒為單位。正位移為零子午線東,負位移為零子午線的西方。
時間伺服器

用戶端可用的時間通訊協定伺服器。


Usage:  ffx net dhcpd get option time-server [--time-servers <time-servers...>]

選項  
--說明 顯示使用資訊
--time-servers 列出用戶端可用的時間伺服器清單 (按照偏好順序排列)。
預告封裝

此標記可指定客戶是否應在 ARP 中協商預告片的使用情況。


Usage:  ffx net dhcpd get option trailer-encapsulation [--trailers]

選項  
--說明 顯示使用資訊
--trailers 標記,指定用戶端在使用 ARP 時是否協商使用預告片 (根據 RFC 893 規定)。
供應商專屬資訊

可在 DHCP 用戶端和 DHCP 伺服器之間交換供應商特定資訊的選項。


Usage:  ffx net dhcpd get option vendor-specific-information [--data <data...>]

選項  
--說明 顯示使用資訊
--資料 用來交換供應商資訊的不透明物件。
x-window-system-display-manager

X Windows System Display Manager 系統提供給用戶端。


Usage:  ffx net dhcpd get option x-window-system-display-manager [--display-servers <display-servers...>]

選項  
--說明 顯示使用資訊
--display-servers 用戶端可用的 X Window System Display Manager 系統位址清單,按偏好排序。
x-window-system-font-server

用戶端可用的 X Window System 字型伺服器。


Usage:  ffx net dhcpd get option x-window-system-font-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 X Window System 字型伺服器位址清單,按照偏好順序列出。
參數

表示伺服器參數引數的次要指令。


Usage:  ffx net dhcpd get parameter [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
位址集區 DHCP 伺服器管理的位址集區。
ARp 探測器 啟用伺服器行為,讓伺服器 ARP 先提供 IP 位址,再發出租用。
繫結裝置名稱 伺服器將監聽的網路裝置名稱。
ip-addrs 伺服器會繫結的 IPv4 位址。
lease-length 伺服器提供的租賃時間長度。
允許的 Mac 伺服器要核發的用戶端 MAC 位址。
靜態指派的 addr AddressPool 中的地址,只會提供給指定用戶端。指派的位址會依序與主機配對。舉例來說,主機 (A、B、C) 和地址 (1、2、3) 的配對為 (A, 1)、(B、2)、(C、3) 等。
位址集區

DHCP 伺服器管理的位址集區。


Usage:  ffx net dhcpd get parameter address-pool [--prefix-length <prefix-length>] [--range-start <range-start>] [--range-stop <range-stop>]

選項  
--說明 顯示使用資訊
--prefix-length 網路子網路遮罩的前置字串長度
--range-start DHCP 伺服器釋出給用戶端的起始位址範圍 (包含此位址範圍)
--range-stop 伺服器提供給用戶端的位址範圍 (含首尾地址)
ARP-探測

啟用伺服器行為,讓伺服器 ARP 先提供 IP 位址,再發出租用。


Usage:  ffx net dhcpd get parameter arp-probe [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 啟用伺服器行為,即伺服器 ARP 先提供 IP 位址,再發出租用。如果伺服器收到回應,伺服器會將該地址標示為「使用中」,然後使用不同的地址再試一次。此行為預設為停用。
繫結裝置名稱

伺服器將監聽的網路裝置名稱。


Usage:  ffx net dhcpd get parameter bound-device-names [names...]

選項  
--說明 顯示使用資訊
ip-addrs

伺服器會繫結的 IPv4 位址。


Usage:  ffx net dhcpd get parameter ip-addrs [--addrs <addrs...>]

選項  
--說明 顯示使用資訊
--addrs 伺服器繫結的 IPv4 位址清單。
lease-length

伺服器提供的租賃時間長度。


Usage:  ffx net dhcpd get parameter lease-length [--default <default>] [--max <max>]

選項  
--說明 顯示使用資訊
--預設 傳送給用戶端的預設租賃長度 (以秒為單位)。
--max 租用長度上限 (以秒為單位),讓伺服器向已要求特定租期的客戶發出此訊息。如果使用預設值 0,則最大釋出長度等同於預設的租賃長度。
允許 macs

伺服器要核發的用戶端 MAC 位址。


Usage:  ffx net dhcpd get parameter permitted-macs [--macs <macs...>]

選項  
--說明 顯示使用資訊
--macs 伺服器要租用的用戶端 MAC 位址。根據預設,伺服器沒有允許的 MAC 清單,在此情況下,系統會嘗試對每個要求的用戶端發出租約。如果 allow_macs 的長度不是零,伺服器只會回應清單中具有 MAC 的用戶端的租用要求。
靜態指派的 addr

AddressPool 中的地址,只會提供給指定用戶端。指派的位址會依序與主機配對。舉例來說,主機 (A、B、C) 和地址 (1、2、3) 的配對為 (A, 1)、(B、2)、(C、3) 等。


Usage:  ffx net dhcpd get parameter statically-assigned-addrs [--hosts <hosts...>] [--assigned-addrs <assigned-addrs...>]

選項  
--說明 顯示使用資訊
--主機 主機將租用 assigned_addrs 保留的位址。
--assigned-addrs 位址集區中的位址,避免提供給客戶的位址。一般而言,網路管理員會以靜態方式將這些位址指派給一律開啟的網路裝置,這類裝置一律應有相同的 IP 位址,例如網路印表機。

list

列出所有 DHCP 選項值或伺服器參數值的主要指令。


Usage:  ffx net dhcpd list [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
選項 對 DHCP 選項執行指令。
參數 對伺服器參數執行指令。
選項

對 DHCP 選項執行指令。


Usage:  ffx net dhcpd list option

選項  
--說明 顯示使用資訊
參數

對伺服器參數執行指令。


Usage:  ffx net dhcpd list parameter

選項  
--說明 顯示使用資訊

重設

重設所有 DHCP 選項值或伺服器參數值的主要指令。


Usage:  ffx net dhcpd reset [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
選項 對 DHCP 選項執行指令。
參數 對伺服器參數執行指令。
選項

對 DHCP 選項執行指令。


Usage:  ffx net dhcpd reset option

選項  
--說明 顯示使用資訊
參數

對伺服器參數執行指令。


Usage:  ffx net dhcpd reset parameter

選項  
--說明 顯示使用資訊

設定

設定 DHCP 選項值或伺服器參數值的主要指令。


Usage:  ffx net dhcpd set [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
選項 表示 DHCP 選項引數的次要指令。
參數 表示伺服器參數引數的次要指令。
選項

表示 DHCP 選項引數的次要指令。


Usage:  ffx net dhcpd set option [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
all-subnets-local 此標記會指出已連線網路的所有子網路是否使用相同的 MTU,
arp-cache-timeout ARP 快取項目逾時。
Boot-file-size 用戶端的預設啟動映像檔大小。
bootfile-name 用戶端的開機磁碟名稱。
廣播地址 用戶端子網路的廣播位址。
cookie-server 用戶端可用的 RFC 865 Cookie 伺服器。
default-finger-server 用戶端可用的預設 Finger 伺服器。
default-ip-ttl 外送 IP 資料元的預設存留時間。
default-irc-server 用戶端可用的預設 IRC 伺服器。
default-www-server 用戶端可用的預設 WWW 伺服器。
網域名稱 用戶端的網域名稱。
網域名稱伺服器 用戶端可用的網域名稱系統伺服器。
乙太網路封裝 此標記可指定用戶端應使用乙太網路 v2 還是 IEEE 802.3 封裝。
Extension-path 由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。
主機名稱 客戶的名稱。
impress-server 提供給用戶端的 Imagen Impress 伺服器。
interface-mtu 用戶端介面的 MTU。
ip-forwarding 標記啟用/停用 IP 層封包轉送功能。
log-server 用戶端可用的 MIT-LCS UDP 記錄伺服器。
lpr-server 用戶端可用的 RFC 1179 線型印表機伺服器。
口罩供應商 此標記可註明用戶端是否應透過 ICMP 回應子網路遮罩探索要求。
max-datagram-reassembly-size 用戶端可重組的資料量上限。
max-message-size 參與者願意接受的 DHCP 訊息長度上限。
Merit-dump-file 核心傾印檔案的路徑名稱。
mobile-ip-home-agent 用戶端可以使用行動 IP 家用代理程式。
名稱伺服器 用戶端可使用 IEN 116 名稱伺服器。
net-bios-over-tcpip-distribution-server 用戶端可用的 NetBIOS 資料元分佈伺服器。
net-bios-over-tcpip-name-server 用戶端可用的 NetBIOS 名稱伺服器。
net-bios-over-tcpip-node-type 用戶端應使用的 NetBIOS 節點類型。
net-bios-over-tcpip-scope 用戶端的 NetBIOS 範圍參數。
網路資訊伺服器 用戶端可用的「網路資訊服務」伺服器。
network-information-service-domain 客戶的 Network Information Service 網域名稱。
network-information-service-plus-domain Network Information System+ 網域名稱。
network-information-service-plus-servers 用戶端可用的 Network Information System+ 伺服器。
network-time-protocol-servers 用戶端可用的網路時間通訊協定伺服器。
nntp-server 用戶端可用的 NNTP 伺服器。
non-local-source-routing 標記啟用/停用具有非本機來源路徑的 IP 封包轉送功能。
path-mtu-aging-timeout 建立路徑 MTU 值時使用的逾時。
path-mtu-plateau-table 路徑 MTU 探索的 MTU 大小表格。
效能-遮罩-探索 此標記可註明用戶端是否應透過 ICMP 執行子網路遮罩探索作業。
perform-router-discovery 此標記可註明用戶端是否應使用 Router Discovery 啟動路由器。
政策篩選器 非本機來源轉送的政策篩選器。
pop3-server 用戶端可用的 POP3 伺服器。
重新繫結時間值 用戶端轉換為重新繫結狀態的時間間隔。
續訂時間值 用戶端轉換至續約狀態的時間間隔。
資源位置伺服器 用戶端可用的 RFC 887 資源位置伺服器。
根路徑 由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。
路由器 用戶端子網路中的路由器。
router-solicitation-address 路由器資訊要求的目標位址。
smtp-server 用戶端可用的 SMTP 伺服器。
static-route 用戶端應置於其轉送快取中的靜態路徑。
stda-server 用戶端可使用的 StreetTalk 目錄協助伺服器。
street-talk-server 用戶端可用的 StreetTalk 伺服器。
子網路-遮罩 用戶端的子網路遮罩。
swap-server 用戶端替換伺服器位址。
tcp-default-ttl 傳出 TCP 區隔的預設存留時間。
tcp-keepalive-garbage 此標記可指定用戶端是否應傳送有八位元的垃圾的 TCP 保持運作訊息。
tcp-keepalive-interval 用戶端在傳送 TCP 保持運作訊息前應等待的間隔。
tftp-server-name 可供用戶端使用的 TFTP 伺服器。
時間偏移 用戶端與世界標準時間的偏移。
時間伺服器 用戶端可用的時間通訊協定伺服器。
預告片 此標記可指定客戶是否應在 ARP 中協商預告片的使用情況。
供應商專屬資訊 可在 DHCP 用戶端和 DHCP 伺服器之間交換供應商特定資訊的選項。
x-window-system-display-manager X Windows System Display Manager 系統提供給用戶端。
x-window-system-font-server 用戶端可用的 X Window System 字型伺服器。
所有子網路-本機

此標記會指出已連線網路的所有子網路是否使用相同的 MTU,


Usage:  ffx net dhcpd set option all-subnets-local [--local]

選項  
--說明 顯示使用資訊
--local 一個旗標,表示用戶端連結的 IP 網路所有子項目是否都具有相同的 MTU。
ARP-Cache 逾時

ARP 快取項目逾時。


Usage:  ffx net dhcpd set option arp-cache-timeout [--timeout <timeout>]

選項  
--說明 顯示使用資訊
--timeout ARP 快取項目的逾時時間 (以秒為單位)。
啟動檔案大小

用戶端的預設啟動映像檔大小。


Usage:  ffx net dhcpd set option boot-file-size [--size <size>]

選項  
--說明 顯示使用資訊
--尺寸 用戶端預設啟動映像檔的大小 (以 512 八位元表示)。
啟動檔案名稱

用戶端的開機磁碟名稱。


Usage:  ffx net dhcpd set option bootfile-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用戶端的啟動檔案名稱。當 file 欄位已超載以提供選項時,則應使用此選項。
廣播地址

用戶端子網路的廣播位址。


Usage:  ffx net dhcpd set option broadcast-address [--addr <addr>]

選項  
--說明 顯示使用資訊
--addr 用戶端子網路的廣播位址。法值依 RFC 1122 定義。

用戶端可用的 RFC 865 Cookie 伺服器。


Usage:  ffx net dhcpd set option cookie-server [--cookie-servers <cookie-servers...>]

選項  
--說明 顯示使用資訊
--cookie-servers 用戶端可用的 RFC 865 Cookie 伺服器清單,按照偏好順序排列。
預設手指伺服器

用戶端可用的預設 Finger 伺服器。


Usage:  ffx net dhcpd set option default-finger-server [--finger-servers <finger-servers...>]

選項  
--說明 顯示使用資訊
--finger-servers 用戶端可用的預設 Finger 伺服器位址清單,按偏好排序。
default-ip-ttl

外送 IP 資料元的預設存留時間。


Usage:  ffx net dhcpd set option default-ip-ttl [--ttl <ttl>]

選項  
--說明 顯示使用資訊
--ttl 要在傳出 IP 資料架構中使用的預設存留時間。這個值必須介於 1 至 255 之間。
default-irc-server

用戶端可用的預設 IRC 伺服器。


Usage:  ffx net dhcpd set option default-irc-server [--irc-servers <irc-servers...>]

選項  
--說明 顯示使用資訊
--irc-servers 用戶端可用的 Internet Relay Chat 伺服器位址清單,依照優先順序排列。
default-www-server

用戶端可用的預設 WWW 伺服器。


Usage:  ffx net dhcpd set option default-www-server [--www-servers <www-servers...>]

選項  
--說明 顯示使用資訊
--www-servers 用戶端可用的預設全球資訊網 (WWW) 伺服器位址清單,依照偏好順序列出。
網域名稱

用戶端的網域名稱。


Usage:  ffx net dhcpd set option domain-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用於解析 DNS 主機名稱的用戶端網域名稱。
網域名稱-伺服器

用戶端可用的網域名稱系統伺服器。


Usage:  ffx net dhcpd set option domain-name-server [--domain-name-servers <domain-name-servers...>]

選項  
--說明 顯示使用資訊
--domain-name-servers 用戶端可用的 DNS 伺服器清單 (依照偏好順序);
乙太網路封裝

此標記可指定用戶端應使用乙太網路 v2 還是 IEEE 802.3 封裝。


Usage:  ffx net dhcpd set option ethernet-encapsulation [--encapsulate]

選項  
--說明 顯示使用資訊
--封裝 一個旗標,指定 false 時用戶端應使用乙太網路 v2 封裝,若為 true,則使用 IEEE 802.3 封裝。
延伸路徑

由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。


Usage:  ffx net dhcpd set option extensions-path [--path <path>]

選項  
--說明 顯示使用資訊
--path TFTP 可擷取檔案的路徑名稱。這個檔案包含的資料可解讀為「BOOTP 供應商延伸模組」欄位。與 [BOOTP 供應商額外資訊] 欄位不同,這個檔案沒有限制的長度,因此系統會忽略代碼 18 的任何參照。
主機名稱

客戶的名稱。


Usage:  ffx net dhcpd set option host-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 用戶端名稱,不一定符合本機網域名稱。
曝光伺服器

提供給用戶端的 Imagen Impress 伺服器。


Usage:  ffx net dhcpd set option impress-server [--impress-servers <impress-servers...>]

選項  
--說明 顯示使用資訊
--impress-servers 可供用戶端使用的 Imagen Impress 伺服器清單 (依照偏好順序)。
interface-mtu

用戶端介面的 MTU。


Usage:  ffx net dhcpd set option interface-mtu [--mtu <mtu>]

選項  
--說明 顯示使用資訊
--mtu 用戶端介面的 MTU。最小值為 68。
ip-forwarding

標記啟用/停用 IP 層封包轉送功能。


Usage:  ffx net dhcpd set option ip-forwarding [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 設為 true 時啟用 IP 層封包轉送的旗標。
log-server

用戶端可用的 MIT-LCS UDP 記錄伺服器。


Usage:  ffx net dhcpd set option log-server [--log-servers <log-servers...>]

選項  
--說明 顯示使用資訊
--log-servers 用戶端可用的 MIT-LCS UDP 記錄伺服器清單,按照偏好順序排序。
Lpr-server

用戶端可用的 RFC 1179 線型印表機伺服器。


Usage:  ffx net dhcpd set option lpr-server [--lpr-servers <lpr-servers...>]

選項  
--說明 顯示使用資訊
--lpr-servers 用戶端可用的 RFC 1179 線型印表機伺服器清單 (按偏好順序)。
口罩供應商

此標記可註明用戶端是否應透過 ICMP 回應子網路遮罩探索要求。


Usage:  ffx net dhcpd set option mask-supplier [--supplier]

選項  
--說明 顯示使用資訊
--供應商 旗標,表示用戶端是否應透過 ICMP 回應子網路遮罩探索要求。
max-datagram-reassembly-size

用戶端可重組的資料量上限。


Usage:  ffx net dhcpd set option max-datagram-reassembly-size [--size <size>]

選項  
--說明 顯示使用資訊
--尺寸 用戶端可重新組合的尺寸上限,以八位元表示。最小的法定值為 576。
max-message-size

參與者願意接受的 DHCP 訊息長度上限。


Usage:  ffx net dhcpd set option max-message-size [--length <length>]

選項  
--說明 顯示使用資訊
--length 參與者願意接受的 DHCP 訊息上限 (以八位元為單位)。最小值為 576。
商品傾印檔案

核心傾印檔案的路徑名稱。


Usage:  ffx net dhcpd set option merit-dump-file [--path <path>]

選項  
--說明 顯示使用資訊
--path 發生用戶端當機事件時,用戶端核心傾印的路徑名稱。
mobile-ip-home-agent

用戶端可以使用行動 IP 家用代理程式。


Usage:  ffx net dhcpd set option mobile-ip-home-agent [--home-agents <home-agents...>]

選項  
--說明 顯示使用資訊
--home-agents 用戶端可用的行動 IP 家用代理程式位址清單,按偏好排序。
名稱伺服器

用戶端可使用 IEN 116 名稱伺服器。


Usage:  ffx net dhcpd set option name-server [--name-servers <name-servers...>]

選項  
--說明 顯示使用資訊
--name-servers 列出用戶端可用的 IEN 116 名稱伺服器清單 (按照偏好順序排列)。
net-bios-over-tcpip-distribution-server

用戶端可用的 NetBIOS 資料元分佈伺服器。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-distribution-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 NetBIOS Datagram 發布伺服器清單,按照偏好順序列出。
net-bios-over-tcpip-name-server

用戶端可用的 NetBIOS 名稱伺服器。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-name-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 NetBIOS 名稱伺服器位址清單,依照偏好順序列出。
net-bios-over-tcpip-node-type

用戶端應使用的 NetBIOS 節點類型。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
b 節點 B 節點類型。
h 節點 H 節點類型。
m-node M 節點類型。
p-node P 節點類型。
# 個 b 節點

B 節點類型。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type b-node

選項  
--說明 顯示使用資訊
# 個節點

H 節點類型。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type h-node

選項  
--說明 顯示使用資訊
# m 節點

M 節點類型。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type m-node

選項  
--說明 顯示使用資訊
# 個 P 節點

P 節點類型。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-node-type p-node

選項  
--說明 顯示使用資訊
net-bios-over-tcpip-scope

用戶端的 NetBIOS 範圍參數。


Usage:  ffx net dhcpd set option net-bios-over-tcpip-scope [--scope <scope>]

選項  
--說明 顯示使用資訊
--scope NetBIOS,透過 TCP/IP 範圍參數取得,如 RFC 1001 中所定義,用戶端的 NetBIOS。
網路資訊伺服器

用戶端可用的「網路資訊服務」伺服器。


Usage:  ffx net dhcpd set option network-information-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 Network Information Service 伺服器位址清單,按偏好排序。
network-information-service-domain

客戶的 Network Information Service 網域名稱。


Usage:  ffx net dhcpd set option network-information-service-domain [--domain-name <domain-name>]

選項  
--說明 顯示使用資訊
--domain-name 客戶的 Network Information Service 網域名稱。
network-information-service-plus-domain

Network Information System+ 網域名稱。


Usage:  ffx net dhcpd set option network-information-service-plus-domain [--domain-name <domain-name>]

選項  
--說明 顯示使用資訊
--domain-name 用戶端的 Network Information System+ 網域名稱。
network-information-service-plus-servers

用戶端可用的 Network Information System+ 伺服器。


Usage:  ffx net dhcpd set option network-information-service-plus-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 Network Information System+ 伺服器位址清單 (按偏好順序列出)。
network-time-protocol-servers

用戶端可用的網路時間通訊協定伺服器。


Usage:  ffx net dhcpd set option network-time-protocol-servers [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的網路時間通訊協定 (NTP) 伺服器位址清單,依照偏好順序列出。
nntp-server

用戶端可用的 NNTP 伺服器。


Usage:  ffx net dhcpd set option nntp-server [--nntp-servers <nntp-servers...>]

選項  
--說明 顯示使用資訊
--nntp-servers 用戶端可用的網路新聞傳輸通訊協定 (NNTP) 伺服器位址,按照偏好順序列出。
non-local-source-routing

標記啟用/停用具有非本機來源路徑的 IP 封包轉送功能。


Usage:  ffx net dhcpd set option non-local-source-routing [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 標記,讓具有非本機來源路徑的 IP 封包轉送。
path-mtu-aging-timeout

建立路徑 MTU 值時使用的逾時。


Usage:  ffx net dhcpd set option path-mtu-aging-timeout [--timeout <timeout>]

選項  
--說明 顯示使用資訊
--timeout 逾時 (以秒為單位),會在 RFC 1191 中的機制再次使用路徑 MTU 值時使用。
path-mtu-plateau-table

路徑 MTU 探索的 MTU 大小表格。


Usage:  ffx net dhcpd set option path-mtu-plateau-table [--mtu-sizes <mtu-sizes...>]

選項  
--說明 顯示使用資訊
--mtu-sizes MTU 大小清單,由小到大排序。最小值不得小於 68。
表演-遮罩-探索

此標記可註明用戶端是否應透過 ICMP 執行子網路遮罩探索作業。


Usage:  ffx net dhcpd set option perform-mask-discovery [--do-discovery]

選項  
--說明 顯示使用資訊
--do-discovery 旗標,表示用戶端是否應透過 ICMP 執行子網路遮罩探索作業。
perform-router-discovery

此標記可註明用戶端是否應使用 Router Discovery 啟動路由器。


Usage:  ffx net dhcpd set option perform-router-discovery [--do-discovery]

選項  
--說明 顯示使用資訊
--do-discovery 此標記表示用戶端是否應使用 Router Discovery 啟動路由器 (如 RFC 1256 中的定義)。
政策篩選器

非本機來源轉送的政策篩選器。


Usage:  ffx net dhcpd set option policy-filter [--addresses <addresses...>]

選項  
--說明 顯示使用資訊
--addresses IP 位址和子網路遮罩的組合清單如果傳入來源路徑的封包的下一個躍點與這些組合不符,系統就會捨棄該封包。
pop3 伺服器

用戶端可用的 POP3 伺服器。


Usage:  ffx net dhcpd set option pop3-server [--pop3-servers <pop3-servers...>]

選項  
--說明 顯示使用資訊
--pop3-servers 用戶端可用的郵局通訊協定 (POP3) 伺服器位址清單,依照偏好設定排序。
重新繫結時間值

用戶端轉換為重新繫結狀態的時間間隔。


Usage:  ffx net dhcpd set option rebinding-time-value [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 指定地址後,用戶端轉換至重新繫結狀態的時間間隔 (以秒為單位)。
續約時間值

用戶端轉換至續約狀態的時間間隔。


Usage:  ffx net dhcpd set option renewal-time-value [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 指定地址後,用戶端轉換至續約狀態的時間間隔 (以秒為單位)。
資源位置伺服器

用戶端可用的 RFC 887 資源位置伺服器。


Usage:  ffx net dhcpd set option resource-location-server [--resource-location-servers <resource-location-servers...>]

選項  
--說明 顯示使用資訊
--resource-location-servers 用戶端可用的 RFC 887 資源位置伺服器清單 (依偏好順序)。
根路徑

由 TFTP 可擷取檔案的路徑名稱,該檔案包含供應商擴充功能資訊。


Usage:  ffx net dhcpd set option root-path [--path <path>]

選項  
--說明 顯示使用資訊
--path TFTP 可擷取檔案的路徑名稱。這個檔案包含的資料可解讀為「BOOTP 供應商延伸模組」欄位。與 [BOOTP 供應商額外資訊] 欄位不同,這個檔案沒有限制的長度,因此系統會忽略代碼 18 的任何參照。
路由器

用戶端子網路中的路由器。


Usage:  ffx net dhcpd set option router [--routers <routers...>]

選項  
--說明 顯示使用資訊
--routers 用戶端子網路中路由器的清單,並按照偏好順序列出。
路由器聯絡地址

路由器資訊要求的目標位址。


Usage:  ffx net dhcpd set option router-solicitation-address [--addr <addr>]

選項  
--說明 顯示使用資訊
--addr 用戶端應將路由器傳遞要求傳送至這個位址的位址。
smtp-server

用戶端可用的 SMTP 伺服器。


Usage:  ffx net dhcpd set option smtp-server [--smtp-servers <smtp-servers...>]

選項  
--說明 顯示使用資訊
--smtp-servers 用戶端可用的簡易郵件傳輸通訊協定 (SMTP) 伺服器位址清單,按照偏好順序列出。
靜態路徑

用戶端應置於其轉送快取中的靜態路徑。


Usage:  ffx net dhcpd set option static-route [--routes <routes...>]

選項  
--說明 顯示使用資訊
--routes 定義用戶端路由表的靜態路徑的目的地位址/下一個躍點位址組合清單。路徑應按照優先順序遞減列出。在靜態路徑中使用 0.0.0.0 做為目的地是違法行為。
stda-server

用戶端可使用的 StreetTalk 目錄協助伺服器。


Usage:  ffx net dhcpd set option stda-server [--stda-servers <stda-servers...>]

選項  
--說明 顯示使用資訊
--stda-servers 用戶端可用的 StreetTalk 目錄輔助伺服器位址清單,按優先順序排列。
街道-跟-伺服器

用戶端可用的 StreetTalk 伺服器。


Usage:  ffx net dhcpd set option street-talk-server [--streettalk-servers <streettalk-servers...>]

選項  
--說明 顯示使用資訊
--streettalk-servers 用戶端可用的 StreetTalk 伺服器位址清單,按偏好排序。
子網路-遮罩

用戶端的子網路遮罩。


Usage:  ffx net dhcpd set option subnet-mask [--mask <mask>]

選項  
--說明 顯示使用資訊
--mask 32 位元 IPv4 子網路遮罩
交換伺服器

用戶端替換伺服器位址。


Usage:  ffx net dhcpd set option swap-server [--address <address>]

選項  
--說明 顯示使用資訊
--address 用戶端交換伺服器的位址。
tcp-default-ttl

傳出 TCP 區隔的預設存留時間。


Usage:  ffx net dhcpd set option tcp-default-ttl [--ttl <ttl>]

選項  
--說明 顯示使用資訊
--ttl 用戶端應用於傳出 TCP 區隔的預設存留時間。最小值為 1。
tcp-keepalive-garbage

此標記可指定用戶端是否應傳送有八位元的垃圾的 TCP 保持運作訊息。


Usage:  ffx net dhcpd set option tcp-keepalive-garbage [--send-garbage]

選項  
--說明 顯示使用資訊
--send-garbage 此標記可指定用戶端是否應傳送具有八位元的垃圾的 TCP 保持運作訊息,以便與舊版實作項目相容。
tcp-keepalive-interval

用戶端在傳送 TCP 保持運作訊息前應等待的間隔。


Usage:  ffx net dhcpd set option tcp-keepalive-interval [--interval <interval>]

選項  
--說明 顯示使用資訊
--interval 間隔 (以秒為單位) 後,用戶端應在傳送 TCP 保持運作訊息之前等待。如果值為 0,表示用戶端不應傳送保持運作訊息,除非應用程式明確要求。
tftp-server-name

可供用戶端使用的 TFTP 伺服器。


Usage:  ffx net dhcpd set option tftp-server-name [--name <name>]

選項  
--說明 顯示使用資訊
--name 可供用戶端使用的 TFTP 伺服器名稱當 sname 欄位已超載以提供選項時,則應使用此選項。
時間偏移

用戶端與世界標準時間的偏移。


Usage:  ffx net dhcpd set option time-offset [--offset <offset>]

選項  
--說明 顯示使用資訊
--offset 用戶端與世界標準時間的偏移量,以秒為單位。正位移為零子午線東,負位移為零子午線的西方。
時間伺服器

用戶端可用的時間通訊協定伺服器。


Usage:  ffx net dhcpd set option time-server [--time-servers <time-servers...>]

選項  
--說明 顯示使用資訊
--time-servers 列出用戶端可用的時間伺服器清單 (按照偏好順序排列)。
預告封裝

此標記可指定客戶是否應在 ARP 中協商預告片的使用情況。


Usage:  ffx net dhcpd set option trailer-encapsulation [--trailers]

選項  
--說明 顯示使用資訊
--trailers 標記,指定用戶端在使用 ARP 時是否協商使用預告片 (根據 RFC 893 規定)。
供應商專屬資訊

可在 DHCP 用戶端和 DHCP 伺服器之間交換供應商特定資訊的選項。


Usage:  ffx net dhcpd set option vendor-specific-information [--data <data...>]

選項  
--說明 顯示使用資訊
--資料 用來交換供應商資訊的不透明物件。
x-window-system-display-manager

X Windows System Display Manager 系統提供給用戶端。


Usage:  ffx net dhcpd set option x-window-system-display-manager [--display-servers <display-servers...>]

選項  
--說明 顯示使用資訊
--display-servers 用戶端可用的 X Window System Display Manager 系統位址清單,按偏好排序。
x-window-system-font-server

用戶端可用的 X Window System 字型伺服器。


Usage:  ffx net dhcpd set option x-window-system-font-server [--servers <servers...>]

選項  
--說明 顯示使用資訊
--伺服器 用戶端可用的 X Window System 字型伺服器位址清單,按照偏好順序列出。
參數

表示伺服器參數引數的次要指令。


Usage:  ffx net dhcpd set parameter [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
位址集區 DHCP 伺服器管理的位址集區。
ARp 探測器 啟用伺服器行為,讓伺服器 ARP 先提供 IP 位址,再發出租用。
繫結裝置名稱 伺服器將監聽的網路裝置名稱。
ip-addrs 伺服器會繫結的 IPv4 位址。
lease-length 伺服器提供的租賃時間長度。
允許的 Mac 伺服器要核發的用戶端 MAC 位址。
靜態指派的 addr AddressPool 中的地址,只會提供給指定用戶端。指派的位址會依序與主機配對。舉例來說,主機 (A、B、C) 和地址 (1、2、3) 的配對為 (A, 1)、(B、2)、(C、3) 等。
位址集區

DHCP 伺服器管理的位址集區。


Usage:  ffx net dhcpd set parameter address-pool [--prefix-length <prefix-length>] [--range-start <range-start>] [--range-stop <range-stop>]

選項  
--說明 顯示使用資訊
--prefix-length 網路子網路遮罩的前置字串長度
--range-start DHCP 伺服器釋出給用戶端的起始位址範圍 (包含此位址範圍)
--range-stop 伺服器提供給用戶端的位址範圍 (含首尾地址)
ARP-探測

啟用伺服器行為,讓伺服器 ARP 先提供 IP 位址,再發出租用。


Usage:  ffx net dhcpd set parameter arp-probe [--enabled]

選項  
--說明 顯示使用資訊
--已啟用 啟用伺服器行為,即伺服器 ARP 先提供 IP 位址,再發出租用。如果伺服器收到回應,伺服器會將該地址標示為「使用中」,然後使用不同的地址再試一次。此行為預設為停用。
繫結裝置名稱

伺服器將監聽的網路裝置名稱。


Usage:  ffx net dhcpd set parameter bound-device-names [names...]

選項  
--說明 顯示使用資訊
ip-addrs

伺服器會繫結的 IPv4 位址。


Usage:  ffx net dhcpd set parameter ip-addrs [--addrs <addrs...>]

選項  
--說明 顯示使用資訊
--addrs 伺服器繫結的 IPv4 位址清單。
lease-length

伺服器提供的租賃時間長度。


Usage:  ffx net dhcpd set parameter lease-length [--default <default>] [--max <max>]

選項  
--說明 顯示使用資訊
--預設 傳送給用戶端的預設租賃長度 (以秒為單位)。
--max 租用長度上限 (以秒為單位),讓伺服器向已要求特定租期的客戶發出此訊息。如果使用預設值 0,則最大釋出長度等同於預設的租賃長度。
允許 macs

伺服器要核發的用戶端 MAC 位址。


Usage:  ffx net dhcpd set parameter permitted-macs [--macs <macs...>]

選項  
--說明 顯示使用資訊
--macs 伺服器要租用的用戶端 MAC 位址。根據預設,伺服器沒有允許的 MAC 清單,在此情況下,系統會嘗試對每個要求的用戶端發出租約。如果 allow_macs 的長度不是零,伺服器只會回應清單中具有 MAC 的用戶端的租用要求。
靜態指派的 addr

AddressPool 中的地址,只會提供給指定用戶端。指派的位址會依序與主機配對。舉例來說,主機 (A、B、C) 和地址 (1、2、3) 的配對為 (A, 1)、(B、2)、(C、3) 等。


Usage:  ffx net dhcpd set parameter statically-assigned-addrs [--hosts <hosts...>] [--assigned-addrs <assigned-addrs...>]

選項  
--說明 顯示使用資訊
--主機 主機將租用 assigned_addrs 保留的位址。
--assigned-addrs 位址集區中的位址,避免提供給客戶的位址。一般而言,網路管理員會以靜態方式將這些位址指派給一律開啟的網路裝置,這類裝置一律應有相同的 IP 位址,例如網路印表機。

開始

啟動 DHCP 伺服器的主要指令。


Usage:  ffx net dhcpd start

選項  
--說明 顯示使用資訊

停止

停止 DHCP 伺服器的主要指令。


Usage:  ffx net dhcpd stop

選項  
--說明 顯示使用資訊

dns

控管 DNS 解析器


Usage:  ffx net dns [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
查詢 對指定的主機名稱執行 DNS 解析

查詢

對指定的主機名稱執行 DNS 解析


Usage:  ffx net dns lookup [--ipv4 <ipv4>] [--ipv6 <ipv6>] [--sort <sort>] hostname

選項  
--說明 顯示使用資訊
--ipv4 包含 ipv4 結果 (預設為 true)
--ipv6 包含 ipv6 結果 (預設為 true)
--排序 按照偏好順序排列地址 (預設為 true)

過濾器

設定封包篩選的指令


Usage:  ffx net filter [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
清單 列出篩選設定的指令。

list

列出篩選設定的指令。


Usage:  ffx net filter list

選項  
--說明 顯示使用資訊

篩選器 - 已淘汰

使用已淘汰 API 設定封包篩選的指令


Usage:  ffx net filter-deprecated [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get-nat-rules 取得 nat 規則
get-rdr-rules 取得層級規則
get-rules 取得篩選器規則
set-nat-rules 設定 nat 規則 (如需 NAT 規則格式,請參閱 netfilter::parser 程式庫)
set-rdr-rules 設定 rdr 規則 (如需 RDR 規則格式的 netfilter::parser 程式庫)
set-rules 設定篩選器規則 (請參閱 netfilter::parser 程式庫瞭解規則格式)

get-nat-rules

取得 nat 規則


Usage:  ffx net filter-deprecated get-nat-rules

選項  
--說明 顯示使用資訊

get-rdr-rules

取得層級規則


Usage:  ffx net filter-deprecated get-rdr-rules

選項  
--說明 顯示使用資訊

get-rules

取得篩選器規則


Usage:  ffx net filter-deprecated get-rules

選項  
--說明 顯示使用資訊

set-nat-rules

設定 nat 規則 (如需 NAT 規則格式,請參閱 netfilter::parser 程式庫)


Usage:  ffx net filter-deprecated set-nat-rules rules

選項  
--說明 顯示使用資訊

設定層級規則

設定 rdr 規則 (如需 RDR 規則格式的 netfilter::parser 程式庫)


Usage:  ffx net filter-deprecated set-rdr-rules rules

選項  
--說明 顯示使用資訊

set-rules

設定篩選器規則 (請參閱 netfilter::parser 程式庫瞭解規則格式)


Usage:  ffx net filter-deprecated set-rules rules

選項  
--說明 顯示使用資訊

if

網路介面的指令


Usage:  ffx net if [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
addr 用於更新網路介面位址的指令
橋梁 在網路介面之間建立橋接
停用 會停用網路介面
enable 啟用網路介面
get 查詢網路介面
Gigmp 取得或配置 IGMP 設定
ip-forward 取得或設定介面的 IP 轉送
清單 列出網路介面 (支援 ffx 機器輸出)
毫升 可取得或進行 MLD 設定

addr

用於更新網路介面位址的指令


Usage:  ffx net if addr [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 將位址新增至網路介面
Del 從網路介面刪除位址
等待 等待網路介面上指派位址。根據預設,等候任何位址,如果已指定 --ipv6,則會等待 IPv6 位址。
新增

將位址新增至網路介面


Usage:  ffx net if addr add [--no-subnet-route] nicid or name:ifname addr prefix

選項  
--說明 顯示使用資訊
--no-subnet-route 略過為這個介面和位址新增本機子網路路徑的步驟
del

從網路介面刪除位址


Usage:  ffx net if addr del nicid or name:ifname addr [prefix]

選項  
--說明 顯示使用資訊
等待

等待網路介面上指派位址。根據預設,等候任何位址,如果已指定 --ipv6,則會等待 IPv6 位址。


Usage:  ffx net if addr wait [--ipv6] nicid or name:ifname

選項  
--說明 顯示使用資訊
--ipv6 等待 IPv6 位址

在網路介面之間建立橋接


Usage:  ffx net if bridge [nicid or name:ifname...]

選項  
--說明 顯示使用資訊

停用

會停用網路介面


Usage:  ffx net if disable nicid or name:ifname

選項  
--說明 顯示使用資訊

enable

啟用網路介面


Usage:  ffx net if enable nicid or name:ifname

選項  
--說明 顯示使用資訊

get

查詢網路介面


Usage:  ffx net if get nicid or name:ifname

選項  
--說明 顯示使用資訊

取得或配置 IGMP 設定


Usage:  ffx net if igmp [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 取得介面的 IGMP 設定
設定 進行介面的 IGMP 設定
get

取得介面的 IGMP 設定


Usage:  ffx net if igmp get nicid or name:ifname

選項  
--說明 顯示使用資訊
設定

進行介面的 IGMP 設定


Usage:  ffx net if igmp set [--version <version>] nicid or name:ifname

選項  
--說明 顯示使用資訊
--版本 要執行的 IGMP 版本

ip-forward

取得或設定介面的 IP 轉送


Usage:  ffx net if ip-forward [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 取得介面的 IP 轉送
設定 設定介面的 IP 轉送
get

取得介面的 IP 轉送


Usage:  ffx net if ip-forward get nicid or name:ifname ip_version

選項  
--說明 顯示使用資訊
設定

設定介面的 IP 轉送


Usage:  ffx net if ip-forward set nicid or name:ifname ip_version enable

選項  
--說明 顯示使用資訊

list

列出網路介面 (支援 ffx 機器輸出)


Usage:  ffx net if list [name_pattern]

選項  
--說明 顯示使用資訊

毫升

可取得或進行 MLD 設定


Usage:  ffx net if mld [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 可取得介面的 MLD 設定
設定 為介面進行 MLD 設定
get

可取得介面的 MLD 設定


Usage:  ffx net if mld get nicid or name:ifname

選項  
--說明 顯示使用資訊
設定

為介面進行 MLD 設定


Usage:  ffx net if mld set [--version <version>] nicid or name:ifname

選項  
--說明 顯示使用資訊
--版本 要執行的 MLD 版本

log

記錄指令


Usage:  ffx net log [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
set-packets 將封包記錄到 stdout

set-packets

將封包記錄到 stdout


Usage:  ffx net log set-packets enabled

選項  
--說明 顯示使用資訊

遷移作業

用於控制從 netstack2 遷移至 netst33 的 Netstack 選項


Usage:  ffx net migration [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
更清楚 用於清除遷移設定的 Netstack 版本。
get 會顯示目前為遷移作業設定的 Netstack 版本。
設定 會在下次啟動時將 Netstack 版本設為

清除

用於清除遷移設定的 Netstack 版本。


Usage:  ffx net migration clear

選項  
--說明 顯示使用資訊

get

會顯示目前為遷移作業設定的 Netstack 版本。


Usage:  ffx net migration get

選項  
--說明 顯示使用資訊

設定

會在下次開機時將 Netstack 版本設為 |ns2| 或 |ns3|。


Usage:  ffx net migration set version

選項  
--說明 顯示使用資訊

鄰近資料表的指令


Usage:  ffx net neigh [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 將一個項目新增至鄰點資料表
更清楚 從鄰近表格中移除與網路介面相關聯的所有項目
設定 用於「Neighbor Unreachability Detection」設定的指令
Del 從鄰近表格移除項目
清單 列出鄰近資料表項目 (支援 ffx 機器輸出)
智慧手錶 會觀察鄰近資料表項目的狀態變更 (支援 ffx 機器輸出)

新增

將一個項目新增至鄰點資料表


Usage:  ffx net neigh add nicid or name:ifname ip mac

選項  
--說明 顯示使用資訊

清除

從鄰近表格中移除與網路介面相關聯的所有項目


Usage:  ffx net neigh clear nicid or name:ifname ip_version

選項  
--說明 顯示使用資訊

config

用於「Neighbor Unreachability Detection」設定的指令


Usage:  ffx net neigh config [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 會傳回所提供介面目前的 NUD 設定選項
更新 針對提供的介面更新目前的 NUD 設定選項
get

會傳回所提供介面目前的 NUD 設定選項


Usage:  ffx net neigh config get nicid or name:ifname ip_version

選項  
--說明 顯示使用資訊
更新

針對提供的介面更新目前的 NUD 設定選項


Usage:  ffx net neigh config update [--base-reachable-time <base-reachable-time>] nicid or name:ifname ip_version

選項  
--說明 顯示使用資訊
--base-reachable-time 計算隨機連線時間的基礎持續時間 (以奈秒為單位)

del

從鄰近表格移除項目


Usage:  ffx net neigh del nicid or name:ifname ip

選項  
--說明 顯示使用資訊

list

列出鄰近資料表項目 (支援 ffx 機器輸出)


Usage:  ffx net neigh list

選項  
--說明 顯示使用資訊

手錶

會觀察鄰近資料表項目的狀態變更 (支援 ffx 機器輸出)


Usage:  ffx net neigh watch

選項  
--說明 顯示使用資訊

路線

路徑資料表的指令


Usage:  ffx net route [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 將路徑新增到路線表
Del 從路線表刪除路徑
清單 列出裝置 (支援 ffx 機器輸出)

新增

將路徑新增到路線表


Usage:  ffx net route add --destination <destination> --netmask <netmask or prefix length> [--gateway <gateway>] [--nicid <nicid or name:ifname>] [--metric <metric>]

選項  
--說明 顯示使用資訊
--destination 目標網路的聯播網 ID
--netmask 與目的地對應的網路遮罩或前置字串長度
--gateway 第一個躍點路由器的 IP 位址
--nicid 路徑的外送網路介面
--metric 該路線的指標

del

從路線表刪除路徑


Usage:  ffx net route del --destination <destination> --netmask <netmask or prefix length> [--gateway <gateway>] [--nicid <nicid or name:ifname>] [--metric <metric>]

選項  
--說明 顯示使用資訊
--destination 目標網路的聯播網 ID
--netmask 與目的地對應的網路遮罩或前置字串長度
--gateway 第一個躍點路由器的 IP 位址
--nicid 路徑的外送網路介面
--metric 該路線的指標

list

列出裝置 (支援 ffx 機器輸出)


Usage:  ffx net route list

選項  
--說明 顯示使用資訊

平台

管理平台建構的必備條件


Usage:  ffx platform [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
預檢 評估建立及經營 Fuchsia 的合適性

預檢

評估建立及經營 Fuchsia 的合適性


Usage:  ffx platform preflight [--json]

選項  
--說明 顯示使用資訊
--json 則會輸出 JSON 而非使用者可理解的文字。

產品

探索及使用產品組合中繼資料和圖片資料。


Usage:  ffx product [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
建立 根據產品組合的輸出結果建立產品套裝組合。
下載 擷取圖片資料。
get-artifacts 取得產品組合中一組構件的路徑。
get-image-path 根據類型和版位,取得產品組合中的圖片路徑。
get-repository 取得產品組合中的存放區資訊。
get-version 取得產品組合的版本。
清單 擷取 PB 資料。
查詢 擷取圖片資料。
節目 顯示產品組合中的詳細資料清單。

create

根據產品組合的輸出結果建立產品套裝組合。


Usage:  ffx product create --product-name <product-name> --product-version <product-version> --partitions <partitions> [--system-a <system-a>] [--system-b <system-b>] [--system-r <system-r>] [--tuf-keys <tuf-keys>] [--update-package-version-file <update-package-version-file>] [--update-package-epoch <update-package-epoch>] [--virtual-device <virtual-device...>] [--recommended-device <recommended-device>] --out-dir <out-dir> [--delivery-blob-type <delivery-blob-type>] [--with-deprecated-flash-manifest] [--gerrit-size-report <gerrit-size-report>]

選項  
--說明 顯示使用資訊
--product-name product.board 標籤,例如「workstation_eng.x64」。
--product-version 專屬版本。
--分區 分區設定路徑,其中列出目標的實體分區。
--system-a 組合資訊清單路徑,該資訊清單會指定要放在版位 A 中的圖片。
--system-b 組合資訊清單路徑,該資訊清單會指定要放在版位 B 中的圖片。
--system-r 組合資訊清單路徑,該資訊清單會指定要放在版位 R 中的圖片。
--tuf-keys TUF 金鑰目錄的路徑,其中應包含 root.json、Snapshot.json、target.json 和 timestamp.json。如有提供,系統就會在產品套件中建立 TUF 存放區,並填入產品 blob。
--update-package-version-file 檔案,內含要放入更新套件中的「產品」版本。
--update-package-epoch 回溯 OTA 版本Fuchsia 會拒絕週期較短的更新。
--virtual-device 虛擬裝置規格檔案 (要納入產品套件) 的路徑。可重複用於加入多個虛擬裝置。
--recommended-device 虛擬裝置規格檔案名稱,以便標示為「建議」裝置進行模擬。
--out-dir 編寫產品套件的目錄。
--delivery-blob-type 產品所需的傳送 blob 類型。
--with-deprecated-flash-manifest 建立已淘汰的 Flash 資訊清單以確保回溯相容性。
--gerrit-size-report 選用的圖片大小報表,用於指出對應至分區的圖片尺寸。

下載

擷取圖片資料。


Usage:  ffx product download [--force] [--auth <auth>] [--base-url <base-url>] [--version <version>] [--branch <branch>] manifest_url product_dir

選項  
--說明 顯示使用資訊
--強制性 再次取得資料 (即使資料已在本機)。
--auth 使用 OAuth2 的特定驗證流程 (請參閱範例;預設:pkce)。
--base-url 要在哪裡查看產品套件資訊清單。
--版本 篩選下列產品:.
--branch 篩選下列產品:.

範例

Auth flow choices for --auth include:
  `--auth no-auth` do not use auth.
  `--auth pkce` to use PKCE auth flow (requires GUI browser).
  `--auth device-experimental` to use device flow.
  `--auth ` run tool at given path which will print an access token to stdout and exit 0.
    
  `--auth default` let the tool decide which auth flow to use.

取得構件

取得產品組合中一組構件的路徑。


Usage:  ffx product get-artifacts -g <artifacts-group> [-r] product_bundle

選項  
--說明 顯示使用資訊
-g、--artifacts-group 選取要列出的構件群組
-r、--relative-path 是否傳回相對路徑

get-image-path

根據類型和版位,取得產品組合中的圖片路徑。


Usage:  ffx product get-image-path [--slot <slot>] [--image-type <image-type>] [-b <bootloader>] [-r] product_bundle

選項  
--說明 顯示使用資訊
--版位 也就是圖片存放的版位
--image-type 圖片的類型
-b、--bootloader 系統啟動載入程式的類型
-r、--relative-path 是否傳回相對路徑

取得存放區

取得產品組合中的存放區資訊。


Usage:  ffx product get-repository product_bundle

選項  
--說明 顯示使用資訊

get-version

取得產品組合的版本。


Usage:  ffx product get-version product_bundle

選項  
--說明 顯示使用資訊

list

擷取 PB 資料。


Usage:  ffx product list [--auth <auth>] [--base-url <base-url>] [--version <version>] [--branch <branch>]

選項  
--說明 顯示使用資訊
--auth 使用 OAuth2 的特定驗證流程 (請參閱範例;預設:pkce)。
--base-url 要在哪裡查看產品套件資訊清單。
--版本 篩選下列產品:.
--branch 篩選下列產品:.

範例

Auth flow choices for --auth include:
  `--auth oob` to use Out-of-Band auth (deprecated).
  `--auth pkce` to use PKCE auth flow (requires GUI browser).
  `--auth ` run tool at given path which will print an access token to stdout and exit 0.
    

查詢

擷取圖片資料。


Usage:  ffx product lookup [--auth <auth>] [--base-url <base-url>] name version

選項  
--說明 顯示使用資訊
--auth 使用 OAuth2 的特定驗證流程 (請參閱範例;預設:pkce)。
--base-url 要在哪裡查看產品套件資訊清單。

範例

Auth flow choices for --auth include:
  `--auth oob` to use Out-of-Band auth (deprecated).
  `--auth pkce` to use PKCE auth flow (requires GUI browser).
  `--auth ` run tool at given path which will print an access token to stdout and exit 0.
    

節目

顯示產品組合中的詳細資料清單。


Usage:  ffx product show [--devices] [--device <device>] product_bundle_path

選項  
--說明 顯示使用資訊
--裝置 列出連結至此產品套件的虛擬裝置。
--裝置 列印此產品套裝組合連結的虛擬裝置詳細資料。

存放區

檢查及管理套件存放區


Usage:  ffx repository [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 讓 Daemon 瞭解特定產品套件存放區
add-from-pm 讓 Daemon 瞭解 pm 建構的特定存放區
建立 建立存放區。
預設 管理預設存放區
清單 列出所有存放區
套件 列出存放區中的套件
publish 發布套件。
移除
放送 (實驗功能) 提供存放區伺服器,將存放區註冊到裝置
伺服器 檢查及管理存放區伺服器

新增

讓 Daemon 瞭解特定產品套件存放區


Usage:  ffx repository add [-p <prefix>] product_bundle_dir

選項  
--說明 顯示使用資訊
-p、--prefix 存放區的前置字串為 NAME。預設為 devhost

從下午新增

讓 Daemon 瞭解 pm 建構的特定存放區


Usage:  ffx repository add-from-pm [-r <repository>] [--alias <alias...>] pm_repo_path

選項  
--說明 顯示使用資訊
-r、--repository 存放區將命名為 NAME。預設為 devhost
--alias 當這個存放區在目標中註冊時,系統會將此存放區的別名設為這些存放區的名稱。

create

建立存放區。


Usage:  ffx repository create [--time-versioning] [--keys <keys>] repo_path

選項  
--說明 顯示使用資訊
--time-versioning 根據目前時間設定存放區版本,而非單調遞增版本
--keys 存放區金鑰目錄的路徑。預設在「repo_path」/keys 中產生金鑰。

預設

管理預設存放區


Usage:  ffx repository default [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 取得預設設定的存放區
設定 設定預設存放區
未設定 清除預設的存放區

範例

For one-off overrides for the default use `--repository` option:

    $ ffx repository  --repository  ...

Or use the `--config` option:

    $ ffx --config repository.default= repository 

備忘錄

  • Manages the default configured repository for all operations. The default
    repository is designated by a * next to the name. This is an alias for the
    repository.default configuration key.

get

取得預設設定的存放區


Usage:  ffx repository default get

選項  
--說明 顯示使用資訊

備忘錄

  • Returns the default configured repository from the 'User Configuration'.
    Returns an empty string if no default is configured.

設定

設定預設存放區


Usage:  ffx repository default set [-l <level>] [-b <build-dir>] name

選項  
--說明 顯示使用資訊
-l、--level 設定層級,例如「user」、「build」或「global」
-b、--build-dir 選用目錄,與提供的建構設定建立關聯

範例

To set the default repository:

   $ ffx repository default set 

To set the 'repository.default` key at the global configuration:

   $ ffx repository default set -l global 

To specify a default repository for a specific build directory:

   $ ffx repository default set -l build -b ~/fuchsia/out 

備忘錄

  • Sets the repository.default configuration key. By default sets the key in
    the 'User Configuration'. Can be used in conjuction with ffx repository list
    to list the names of the discovered repositorys.

After setting the default repository, ffx repository list will mark the default with a * in the output list.

未設定

清除預設的存放區


Usage:  ffx repository default unset [-l <level>] [-b <build-dir>]

選項  
--說明 顯示使用資訊
-l、--level 設定層級,例如「user」、「build」或「global」
-b、--build-dir 選用目錄,與提供的建構設定建立關聯

範例

To clear the default repository:

    $ ffx repository default unset

To clear the `repository.default` key from global configuration:

    $ ffx repository default unset -l global

To specify a specific build directory:

    $ ffx repository default unset -l build -b ~/fuchsia/out

備忘錄

  • Clears the repository.default configuration key. By default clears the
    'User Configuration'. Returns a warning if the key is already empty.

list

列出所有存放區


Usage:  ffx repository list

選項  
--說明 顯示使用資訊

套件

列出存放區中的套件


Usage:  ffx repository package [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
擷取封存 從存放區擷取套件封存檔
清單 檢查及管理套件存放區
節目 檢查套件內容

解壓縮封存

從存放區擷取套件封存檔


Usage:  ffx repository package extract-archive -o <out> [-r <repository>] package

選項  
--說明 顯示使用資訊
-o、--out 擷取的封存輸出路徑。
-r、--repository 從這個存放區擷取套件

list

檢查及管理套件存放區


Usage:  ffx repository package list [-r <repository>] [--full-hash] [--include-components <include-components>]

選項  
--說明 顯示使用資訊
-r、--repository 列出來自此存放區的套件
--full-hash 如果為 true,套件雜湊將完整顯示 (不會遭到截斷)。
--include-components 切換是否要擷取每個套件中的元件,並顯示在輸出資料表中

節目

檢查套件內容


Usage:  ffx repository package show [-r <repository>] [--full-hash] [--include-subpackages <include-subpackages>] package

選項  
--說明 顯示使用資訊
-r、--repository 列出此存放區中的套件內容。
--full-hash 如果為 true,套件雜湊將完整顯示 (不會遭到截斷)。
--include-subpackages 如果為 true,則顯示套件包含的子套件內容。

publish

發布套件。


Usage:  ffx repository publish [--signing-keys <signing-keys>] [--trusted-keys <trusted-keys>] [--trusted-root <trusted-root>] [--package <package...>] [--package-list <package-list...>] [--package-archive <package-archive...>] [--product-bundle <product-bundle...>] [--time-versioning] [--metadata-current-time <metadata-current-time>] [--refresh-root] [--clean] [--depfile <depfile>] [--copy-mode <copy-mode>] [--delivery-blob-type <delivery-blob-type>] [--watch] [--ignore-missing-packages] [--blob-manifest <blob-manifest>] [--blob-repo-dir <blob-repo-dir>] repo_path

選項  
--說明 顯示使用資訊
--signing-keys 簽署中繼資料 (但不信任金鑰輪替) 的金鑰路徑
--trusted-keys 用於簽署及信任中繼資料的金鑰路徑 (預設存放區 keys/ 目錄)
--trusted-root 初始受信任根中繼資料的路徑 (預設為使用存放區中的 1.root.json)
--套件 套件資訊清單路徑
--package-list 套件清單資訊清單的路徑
--package-archive 套件封存路徑
--product-bundle 產品組合路徑
--time-versioning 根據時間設定存放區版本,而非單調遞增版本
--metadata-current-time 用來確認中繼資料是否已過期,以及新中繼資料到期時間的 RFC 3339 時間 (預設採用目前時間)
--refresh-root 產生新的根中繼資料,以及所有其他中繼資料
--清理 清理存放區,只保留新的出版品
--depfile 產生 depfile
--copy-mode 模式,用於將 blob 複製到存放區。「複製」、「複製-覆寫」或「硬連結」(預設「複製」)。
--delivery-blob-type 要產生的提交 blob 類型 (預設值:類型 1)
--觀看 檔案變更時重新發布套件
--ignore-missing-packages 如果套件路徑不存在,則忽略
--blob-manifest 寫入 blob 資訊清單的路徑
--blob-repo-dir blob 目錄的路徑 (預設為「$repo_path/repository/blobs」)

remove


Usage:  ffx repository remove name

選項  
--說明 顯示使用資訊

放送

(實驗功能) 提供存放區伺服器,將存放區註冊到裝置


Usage:  ffx repository serve [-r <repository>] [--address <address>] [--repo-path <repo-path>] [--product-bundle <product-bundle>] [--alias <alias...>] [--storage-type <storage-type>] [--alias-conflict-mode <alias-conflict-mode>] [--port-path <port-path>] [--no-device]

選項  
--說明 顯示使用資訊
-r、--repository 註冊這個存放區預設值為 devhost
--address 為存放區提供服務的位址請注意,此名稱可以是 IPV4 或 IPV6。例如 [::]:8083 或 127.0.0.1:8083,預設值為 [::]:8083
--repo-path 套件存放區的位置預設值是由從 ffx 結構定義取得的建構目錄指定。
--product-bundle 產品組合的位置。
--alias 設定重新編寫規則將每個 alias 主機對應至 name 識別的存放區。
--storage-type 允許在重新啟動後保留這個存放區。預設值為 Ephemeral
--alias-conflict-mode 解決別名註冊衝突時的解決機制。必須是 error-outreplace。預設值為 replace
--port-path 伺服器通訊埠資訊的寫入位置 (通訊埠以動態方式執行個體化時使用)。
--no-device 如果為 true,則不會向裝置註冊存放區。預設值為 false

伺服器

檢查及管理存放區伺服器


Usage:  ffx repository server [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
開始 啟動存放區伺服器。請注意,從 ffx repository list 列出的所有存放區都會以子路徑的形式啟動。
狀態 擷取存放區伺服器的狀態。若伺服器正在執行,也會傳回通訊端位址。請注意,ffx repository list 下的所有存放區都會在傳回的位址以子路徑的形式執行。
停止 停止存放區伺服器

開始

啟動存放區伺服器。請注意,從 ffx repository list 列出的所有存放區都會以子路徑的形式啟動。


Usage:  ffx repository server start [--address <address>]

選項  
--說明 顯示使用資訊
--address 要啟動存放區的位址請注意,此名稱可以是 IPV4 或 IPV6。例如 [::]:8083 或 127.0.0.1:8083

資格

擷取存放區伺服器的狀態。若伺服器正在執行,也會傳回通訊端位址。請注意,ffx repository list 下的所有存放區都會在傳回的位址以子路徑的形式執行。


Usage:  ffx repository server status

選項  
--說明 顯示使用資訊

停止

停止存放區伺服器


Usage:  ffx repository server stop

選項  
--說明 顯示使用資訊

sdk

修改或查詢已安裝的 SDK


Usage:  ffx sdk [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
填入路徑 使用 fuchsha-sdk-run 工具的符號連結填入指定路徑,以執行專案專用的 SDK 工具
run 透過使用中的 SDK 執行主機工具
設定 設定 SDK 相關的設定選項
版本 擷取現行 SDK 版本

填入路徑

使用 fuchsha-sdk-run 工具的符號連結填入指定路徑,以執行專案專用的 SDK 工具


Usage:  ffx sdk populate-path path

選項  
--說明 顯示使用資訊

run

透過使用中的 SDK 執行主機工具


Usage:  ffx sdk run name args

選項  
--說明 顯示使用資訊

設定

設定 SDK 相關的設定選項


Usage:  ffx sdk set [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
根層級 設定偏好 SDK 根層級的路徑

根層級

設定偏好 SDK 根層級的路徑


Usage:  ffx sdk set root path

選項  
--說明 顯示使用資訊

version

擷取現行 SDK 版本


Usage:  ffx sdk version

選項  
--說明 顯示使用資訊

課程

控制工作階段元件。


Usage:  ffx session [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 將元素加入目前的工作階段。

如果使用 --persist 選項,套件應位於基礎或快取套件組合中,否則可能在重新啟動後無法啟動。| launch | 啟動工作階段元件。| 移除 | 從目前工作階段中移除元素。

永久性元素會永久移除。系統不會移除元素使用的任何永久儲存空間。| restart | 重新啟動目前的工作階段元件。 | show | 顯示目前工作階段的資訊 | 開始 | 啟動預設工作階段元件。| 停止 | 停止工作階段元件。

備忘錄

  • See https://fuchsia.dev/fuchsia-src/glossary#session-component.

新增

將元素加入目前的工作階段。

如果使用 --persist 選項,套件應位於基礎或快取套件組合中,否則可能在重新啟動後無法啟動。


Usage:  ffx session add [--interactive] [--persist] [--name <name>] url

選項  
--說明 顯示使用資訊
--互動式 讓元素保持運作,直到指令結束為止
--persist 讓元素在重新啟動後持續存在
--name 元素名稱;如未指定,則預設為隨機的元素名稱

範例

To add the `bouncing_ball.cm` component as an element:

    $ ffx session add fuchsia-pkg://fuchsia.com/bouncing_ball#meta/bouncing_ball.cm

發布

啟動工作階段元件。


Usage:  ffx session launch url

選項  
--說明 顯示使用資訊

範例

To launch the `hello-world-session.cm` component as a session:

    $ ffx session launch fuchsia-pkg://fuchsia.com/hello-world-session#meta/hello-world-session.cm

remove

從目前工作階段移除元素。

永久性元素會永久移除。元素使用的所有永久儲存空間不會移除。


Usage:  ffx session remove name

選項  
--說明 顯示使用資訊

重新啟動。

重新啟動目前的工作階段元件。


Usage:  ffx session restart

選項  
--說明 顯示使用資訊

備忘錄

  • Destroys the existing session component, if any, then creates and starts a new component with the same URL. Requires that a session componentwas previously launched.

節目

顯示目前工作階段的相關資訊


Usage:  ffx session show

選項  
--說明 顯示使用資訊

開始

啟動預設工作階段元件。


Usage:  ffx session start

選項  
--說明 顯示使用資訊

備忘錄

  • The default session component is specified by the URL session_urlin session_manager's structured configuration.

停止

停止工作階段元件。


Usage:  ffx session stop

選項  
--說明 顯示使用資訊

目標

與目標裝置或模擬器互動


Usage:  ffx target [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
新增 讓 Daemon 瞭解特定目標
系統啟動載入程式 與系統啟動載入程式通訊
clear-preferred-ssh-address 清除先前設定的 SSH 位址
預設 管理預設目標
echo 對目標執行 echo 測試
閃光燈 將圖片刷新至目標裝置
get-ssh-address 取得目標的 SSH 位址
取得時間 取得目標裝置的單調時間
清單 列出所有目標
關閉 關機達標
重新啟動 重新啟動目標
移除 讓 Daemon 忘記特定目標
存放區 與目標存放區註冊互動
螢幕截圖 擷取目標的螢幕截圖
set-preferred-ssh-address 設定偏好的 SSH 位址
節目 顯示目標的相關資訊
快照 拍攝目標狀態的快照
ssh 透過 SSH 連線至目標裝置
更新 更新目標的基礎系統軟體
等待 等待能夠與目標建立遙控器的連線。

備忘錄

  • The target subcommand contains various commands for target management
    and interaction.

Typically, this is the entry workflow for users, allowing for target discovery and provisioning before moving on to component or session workflows once the system is up and running on the target.

Most of the commands depend on the RCS (Remote Control Service) on the target.

新增

讓 Daemon 瞭解特定目標


Usage:  ffx target add [-n] addr

選項  
--說明 顯示使用資訊
-n、--nowait 不用等待 Fuchsia 裝置的連線驗證。

範例

To add a remote target forwarded via ssh:

    $ ffx target add 127.0.0.1:8022

Or to add a target using its IPV6:

    $ ffx target add fe80::32fd:38ff:fea8:a00a

備忘錄

  • Manually add a target based on its IP address. The command accepts IPV4
    or IPV6 addresses, including a port number: <addr> = <ip addr:port>.

Typically, the daemon automatically discovers targets as they come online. However, manually adding a target allows for specifying a port number or address, often used for remote workflows.

This command will attempt to connect to the target in order to verify that RCS can be used, allowing for typical FFX related workflows. If you do not wish to use this, then you can run use the --nowait flag to return immediately. This can be useful for debugging connection issues.

If you send SIGINT (Ctrl-C) to the command before the connection to the target is verified, the target will be removed. If RCS cannot be connected to (e.g. some connectivity error is encountered), the target will also be removed.

系統啟動載入程式

與系統啟動載入程式通訊


Usage:  ffx target bootloader [-m <manifest>] [-p <product>] [-b <product-bundle>] [--skip-verify] [subcommand...]

選項  
--說明 顯示使用資訊
-m、--manifest 刷新資訊清單或含有圖片和資訊清單的 ZIP 檔案路徑
-p、--product 資訊清單中的產品項目 - 預設值為 fuchsia
-b、--product-bundle 選填的產品套裝組合名稱
--skip-verify 略過硬體驗證。這是危險的,請確定你使用的圖片與裝置相符
子指令  
啟動 RAM 會啟動 Fastboot 目標。
資訊 列印目標的 Quickboot 變數。
鎖定 鎖定 Quickboot 目標。
解鎖 解鎖 Quickboot 目標。

啟動

RAM 會啟動 Fastboot 目標。


Usage:  ffx target bootloader boot [-z <zbi>] [-v <vbmeta>] [-s <slot>]

選項  
--說明 顯示使用資訊
-z、--zbi 選用的 zbi 圖片檔路徑
-v、--vbmeta 要使用的選用 vbmeta 映像檔路徑
-s、--slot 對應到 Flash 資訊清單中的分區的版位 -

只會在沒有 zbi 和 vbmeta 檔案時使用

info (資訊)

列印目標的 Quickboot 變數。


Usage:  ffx target bootloader info

選項  
--說明 顯示使用資訊

鎖定

鎖定 Quickboot 目標。


Usage:  ffx target bootloader lock

選項  
--說明 顯示使用資訊

解除鎖定

解鎖 Quickboot 目標。


Usage:  ffx target bootloader unlock [-c <cred>] [--force]

選項  
--說明 顯示使用資訊
-c、--cred 用於解鎖裝置的選用憑證檔案路徑
--強制性 會略過針對此指令危險的警告訊息

clear-preferred-ssh-address

清除先前設定的 SSH 位址


Usage:  ffx target clear-preferred-ssh-address

選項  
--說明 顯示使用資訊

備忘錄

  • Clears a preferred SSH address that was set using the
    set-preferred-ssh-address command on the default target. Executing this command
    severs any existing connection to the target and establishes a new connection.
    The newly selected address is chosen using the standard address selection
    logic.

預設

管理預設目標


Usage:  ffx target default [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
get 取得預設設定的目標
設定 設定預設目標
未設定 清除預設設定的目標

範例

For one-off overrides for the default use `--target` option:

    $ ffx --target  

Or use the `--config` option:

    $ ffx --config target.default= 

備忘錄

  • Manages the default configured target for all operations. The default
    target is designated by a * next to the name. This is an alias for the
    target.default configuration key.

get

取得預設設定的目標


Usage:  ffx target default get [-l <level>] [-b <build-dir>]

選項  
--說明 顯示使用資訊
-l、--level 設定層級,例如「user」、「build」或「global」,預設為搜尋所有層級
-b、--build-dir 選用目錄,與提供的建構設定建立關聯

備忘錄

  • Returns the default configured target from the 'User Configuration'.
    Returns an empty string if no default is configured.

設定

設定預設目標


Usage:  ffx target default set [-l <level>] [-b <build-dir>] nodename

選項  
--說明 顯示使用資訊
-l、--level 設定層級,例如「user」、「build」或「global」
-b、--build-dir 選用目錄,與提供的建構設定建立關聯

範例

To set the default target:

   $ ffx target default set 

To set the 'target.default` key at the global configuration:

   $ ffx target default set -l global 

To specify a default target for a specific build directory:

   $ ffx target default set -l build -b ~/fuchsia/out 

備忘錄

  • Sets the target.default configuration key. By default sets the key in
    the 'User Configuration'. Can be used in conjuction with ffx target list
    to list the names of the discovered targets.

After setting the default target, ffx target list will mark the default with a * in the output list.

未設定

清除預設設定的目標


Usage:  ffx target default unset [-l <level>] [-b <build-dir>]

選項  
--說明 顯示使用資訊
-l、--level 設定層級,例如「user」、「build」或「global」
-b、--build-dir 選用目錄,與提供的建構設定建立關聯

範例

To clear the default target:

    $ ffx target default unset

To clear the `target.default` key from global configuration:

    $ ffx target default unset -l global

To specify a specific build directory:

    $ ffx target default unset -l build -b ~/fuchsia/out

備忘錄

  • Clears the target.default configuration key. By default clears the
    'User Configuration'. Returns a warning if the key is already empty.

echo

對目標執行 echo 測試


Usage:  ffx target echo [--repeat] [text]

選項  
--說明 顯示使用資訊
--重複 重複執行 echo 測試,直到指令終止為止

閃光

將圖片刷新至目標裝置


Usage:  ffx target flash [-p <product>] [-b <product-bundle>] [-m <manifest>] [--oem-stage <oem-stage...>] [--authorized-keys <authorized-keys>] [--no-bootloader-reboot] [--skip-verify] [manifest_path]

選項  
--說明 顯示使用資訊
-p、--product 資訊清單中的產品項目 - 預設值為 fuchsia
-b、--product-bundle 選填的產品套裝組合名稱
-m、--manifest 選用的資訊清單路徑
--oem-stage 記憶體階段檔案 - 可以多次提供
--authorized-keys 授權金鑰檔案的路徑 - 預設為在 ffx 設定中為 ssh.pub 金鑰設定的值。如果檔案不存在,系統將建立該檔案。
--no-bootloader-reboot 系統啟動載入程式映像檔刷新後,裝置不應重新啟動
--skip-verify 略過硬體驗證。這是危險的,請確認你要刷新的圖像與裝置相符

範例

To flash a specific image:

    $ ffx target flash --manifest $(fx get-build-dir)/flash.json --product fuchsia

To include SSH keys as well:

    $ ffx target flash
    --authorized-keys ~/fuchsia/.ssh/authorized_keys
    $(fx get-build-dir)/flash.json
    --product fuchsia

備忘錄

  • Flashes an image to a target device using the fastboot protocol.
    Requires a specific  file and  name as an input.

This is only applicable to a physical device and not an emulator target. The target device is typically connected via a micro-USB connection to the host system.

The format is a JSON file generated when building a fuchsia and can be found in the build output directory.

The --oem-stage option can be supplied multiple times for several OEM files. The format expects a single OEM command to execute after staging the given file.

The format for the --oem-stage parameter is a comma separated pair: ','

get-ssh-address

取得目標的 SSH 位址


Usage:  ffx target get-ssh-address [-t <timeout>]

選項  
--說明 顯示使用資訊
-t、--timeout 逾時 (以秒為單位) [預設 = 1.0]

備忘錄

  • Return the SSH address of the default target defined in the
    target.default key. By default this comes from the 'User Configuration'.

The command takes a value in seconds with a default of 1.0 and overrides the value in the target.interaction.timeout key.

錯誤  
1 取得 SSH 位址時發生逾時
2 無法取得目標的 SSH 位址

領取時間

取得目標裝置的單調時間


Usage:  ffx target get-time

選項  
--說明 顯示使用資訊

範例

To get the target time:

    $ ffx target get-time

list

列出所有目標


Usage:  ffx target list [-f <format>] [--no-ipv4] [--no-ipv6] [nodename]

選項  
--說明 顯示使用資訊
-f、--format 決定清單作業的輸出格式
--no-ipv4 不傳回 IPv4 位址
--no-ipv6 不傳回 IPv6 位址

範例

To list targets in short form:

    $ ffx target list --format s
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283 pecan-guru-clerk-rhyme

To list targets with only their addresses:

    $ ffx target list --format a
    fe80::4415:3606:fb52:e2bc%zx-f80ff974f283

備忘錄

  • List all targets that the daemon currently has in memory. This includes
    manually added targets. The daemon also proactively discovers targets as
    they come online. Use ffx target list to always get the latest list
    of targets.

The default target is marked with a '*' next to the node name. The table has the following columns:

NAME = The name of the target.
SERIAL = The serial number of the target.
TYPE = The product type of the target.
STATE = The high-level state of the target.
ADDRS/IP = The discovered and known addresses of the target.
RCS = Indicates if the Remote Control Service is running on the target.

「NAME」欄會顯示目標宣傳的名稱。當目標處於早期啟動狀態 (例如 Quickboot) 時,NAME 欄可能是 <unknown>,其中 STATE 為 fastboot,且 SERIAL 屬性。

根據預設,list 指令會以表格格式輸出。如要覆寫格式,請傳遞 --format 並採用下列選項:「simple」、「tabular|table|tab」、「addresses|addrs|addr」、「name-only」、「json|JSON」或簡短格式「s」、「t」、「a」、「n」、「j」。

Zedboot 探索功能預設為停用。如要啟用 Zedboot 目標的探索功能,請執行:

$ ffx config set discovery.zedboot.enabled true

錯誤  
2 如果提供節點名稱,如果無法解析節點名稱,系統會傳回錯誤代碼 2 的錯誤代碼 2。

關閉

關機達標


Usage:  ffx target off

選項  
--說明 顯示使用資訊

備忘錄

  • Power off a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
    FIDL API to send the power off command.

'fuchsia.hardware.power.statecontrol.Admin' is exposed by the 'power_manager' component. To verify that the target exposes this service, ffx component select or ffx component knock can be used.

錯誤  
1 關機目標時發生逾時。

重開。

重新啟動目標


Usage:  ffx target reboot [-b] [-r]

選項  
--說明 顯示使用資訊
-b、--bootloader 重新啟動以使用系統啟動載入程式
-r、--recovery 重新啟動即可復原

備忘錄

  • Reboot a target. Uses the 'fuchsia.hardware.power.statecontrol.Admin'
    FIDL API to send the reboot command.

By default, target boots fully. This behavior can be overrided by passing in either --bootloader or --recovery to boot into the bootloader or recovery, respectively.

'fuchsia.hardware.power.statecontrol.Admin' is exposed by the 'power_manager' component. To verify that the target exposes this service, ffx component select or ffx component knock can be used.

錯誤  
1 關機目標時發生逾時。

remove

讓 Daemon 忘記特定目標


Usage:  ffx target remove name_or_addr

選項  
--說明 顯示使用資訊

範例

To remove a target by its target name:

    $ ffx target remove correct-horse-battery-staple

Or to remove a target using its IP address:

    $ ffx target remove fe80::32fd:38ff:fea8:a00a

備忘錄

  • IP addresses are matched by their full string representation.
    for best results, copy the exact address from ffx target list.

存放區

與目標存放區註冊互動


Usage:  ffx target repository [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
取消註冊 使目標忘記特定存放區
清單 可列出目標中的所有存放區
register 將目標知道特定存放區

備忘錄

  • The `repository` subcommand contains various commands for repository management
    and interaction on targets.
    
    Most of the commands depend on the RCS (Remote Control Service) on the target.

取消註冊

使目標忘記特定存放區


Usage:  ffx target repository deregister [-r <repository>]

選項  
--說明 顯示使用資訊
-r、--repository 從目標 (而非預設值) 中移除名為 name 的存放區。

list

可列出目標中的所有存放區


Usage:  ffx target repository list

選項  
--說明 顯示使用資訊

register

將目標知道特定存放區


Usage:  ffx target repository register [-r <repository>] [--storage-type <storage-type>] [--alias <alias...>] [--alias-conflict-mode <alias-conflict-mode>]

選項  
--說明 顯示使用資訊
-r、--repository 註冊這個存放區,而非使用預設值。
--storage-type 允許在重新啟動後保留這個存放區。
--alias 設定重新編寫規則,將每個 alias 主機對應至 name 識別的存放區。
--alias-conflict-mode 解決別名註冊衝突時的解決機制。必須是 error-outreplace。預設值為 replace

螢幕截圖

擷取目標的螢幕截圖


Usage:  ffx target screenshot [-d <dir>] [--format <format>]

選項  
--說明 顯示使用資訊
-d、--dir 覆寫儲存螢幕截圖的預設目錄
--格式 擷取螢幕截圖格式。如未提供任何值,則系統會使用 bgra,
    Accepted values: bgra, rgba, png

範例

Store the target's screenshot in a directory:

    $ ffx target screenshot -d .
    Exported ./screenshot

備忘錄

  • This command connects to a running target to take its screenshot.
    The --dir can be supplied to override the default
    screenshot saving location /tmp/screenshot/YYYYMMDD_HHMMSS/.
    The --format can be supplied to override the default format png.
    Accepted format values: bgra, rgba, png.
    The screenshot file name is screenshot.<format>.

set-preferred-ssh-address

設定偏好的 SSH 位址


Usage:  ffx target set-preferred-ssh-address addr

選項  
--說明 顯示使用資訊

範例

To set a preferred IPv4 SSH address:

    $ ffx target set-preferred-ssh-address 127.0.0.1

Or to set a preferred IPv6 SSH address:

    $ ffx target set-preferred-ssh-addres fe80::32fd:38ff:fea8:a00a%qemu

If provided, the scope may either correspond to the numerical ID or the
interface name.

備忘錄

  • Manually set the preferred SSH address on the default target. If
    successful, then any existing connection to the target is severed and a new
    connection is established. The specified address is not persisted across daemon
    version changes or restarts.

節目

顯示目標的相關資訊


Usage:  ffx target show [--desc] [--label] [--json] [--version]

選項  
--說明 顯示使用資訊
--desc 顯示項目的說明
--label 顯示項目標籤
--json 將輸出格式顯示為 JSON 物件
--版本 顯示版本

備忘錄

  • Displays a detailed information about the target.

The default output is intended for a human reader. This output can be decorated with machine readable labels (--label) and descriptions of each field (--desc).

The 'label' fields in the machine readable output (--json) will remain stable across software updates and is not localized (compare to 'title' which may change or be localized). The 'value' field will be one of: 'null', 'bool', 'string', or a list of strings.

錯誤  
1 擷取目標資訊時發生逾時。

數據匯報

拍攝目標狀態的快照


Usage:  ffx target snapshot [-d <dir>] [--dump-annotations]

選項  
--說明 顯示使用資訊
-d、--dir 儲存快照的有效目錄
--dump-annotations 列印註解而不擷取快照,會忽略 dir 標記

範例

Store the target's snapshot in the current directory:

    $ ffx target snapshot -d .
    Exported ./snapshot.zip

備忘錄

  • This command connects to a running target to acquire its snapshot, which contains
    useful debugging information about the target. The --dir can be supplied to override the default
    snapshot directory /tmp/snapshots/YYYYMMDD_HHMMSS/.

Snapshot contents: - Build information and annotations - Kernel and system logs - Inspect data

ssh

透過 SSH 連線至目標裝置


Usage:  ffx target ssh [--sshconfig <sshconfig>] [command...]

選項  
--說明 顯示使用資訊
--sshconfig 要使用的自訂 SSH 設定檔路徑。

範例

To ssh to a specific device:

    $ ffx -t fuchsia-EEEE-NNNN target ssh

To ssh and run a command:

    $ ffx target ssh 'echo $USER'

更新

更新目標的基礎系統軟體


Usage:  ffx target update [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
頻道 查看及管理更新頻道
立即檢查 檢查並執行系統更新作業
強制安裝 手動觸發系統更新工具

備忘錄

  • This command interfaces with system update services on the target.

管道

查看及管理更新頻道


Usage:  ffx target update channel [subcommand...]

選項  
--說明 顯示使用資訊
子指令  
取得目前版本 傳回目前設定的更新管道
取得下一個 傳回下一個版本或目標更新管道
清單 列出已知更新管道
設定 設定更新管道

備忘錄

  • Channel management commands and operations. Interfaces directly with
    the 'fuchsia.update.channelcontrol.ChannelControl' service on the target
    system.
取得目前版本

傳回目前設定的更新管道


Usage:  ffx target update channel get-current

選項  
--說明 顯示使用資訊

備忘錄

  • For developer product configurations, this is by default 'devhost'.
錯誤  
1 取得更新管道時發生逾時。
取得下一個

傳回下一個版本或目標更新管道


Usage:  ffx target update channel get-next

選項  
--說明 顯示使用資訊

備忘錄

  • Returns the next or target channel. This differs from get when the
    next successful update changes the configured update channel on the
    system.
錯誤  
1 取得更新管道時發生逾時。
list

列出已知更新管道


Usage:  ffx target update channel list

選項  
--說明 顯示使用資訊

備忘錄

  • This lists all the known next or target update channels on the system.

Returns an empty list if no other update channels are configured.

錯誤  
1 取得更新版本清單時發生逾時。
設定

設定更新管道


Usage:  ffx target update channel set channel

選項  
--說明 顯示使用資訊

範例

To list all the known update channels:

    $ ffx target update channel list

Then, use a valid channel from the list:

    $ ffx target update channel set 

備忘錄

  • Sets the next or target update channel on the device. When paired with
    ffx target update check-now, ensures the update is check against the
    next or target channel. When the update is successful, next or target
    channel becomes the current channel.

Use ffx target update channel list to list known system update channels.

錯誤  
1 設定更新管道時發生逾時。

立即查看

檢查並執行系統更新作業


Usage:  ffx target update check-now [--service-initiated] [--monitor]

選項  
--說明 顯示使用資訊
--service-initiated 更新檢查由服務在背景啟動。
--監控 並監控狀態更新

範例

To check for update and monitor progress:

    $ ffx target update check-now --monitor

備忘錄

  • Triggers an update check operation and performs the update if available.
    Interfaces using the 'fuchsia.update Manager' protocol with the system
    update service on the target.

The command takes in an optional --monitor switch to watch the progress of the update. The output is displayed in stdout.

The command also takes an optional --service-initiated switch to indicate a separate service has initiated a check for update.

強制安裝

手動觸發系統更新工具


Usage:  ffx target update force-install [--reboot <reboot>] update_pkg_url

選項  
--說明 顯示使用資訊
--重新啟動 自動重新啟動,進入新系統

範例

With a known update package URL, trigger an update and reboot:

    $ ffx target update force-install fuchsia-pkg://fuchsia.com/update

Don't reboot after update:

    $ ffx target update force-install
    fuchsia-pkg://fuchsia.com/update
    --reboot false

備忘錄

  • Directly invoke the system updater to install the provided update,
    bypassing any update checks.

Interfaces using the 'fuchsia.update.installer' protocol to update the system. Requires an in the following format:

fuchsia-pkg://fuchsia.com/update

Takes an optional --reboot <true|false> to trigger a system reboot after update has been successfully applied.

等待

等待能夠與目標建立遙控器的連線。


Usage:  ffx target wait [-t <timeout>] [-d]

選項  
--說明 顯示使用資訊
-t、--timeout 逾時 (以秒為單位) [預設 = 120]。如果值為 0,表示沒有逾時。
-d、--down 等待目標停止運作
錯誤  
1 取得 SSH 位址時發生逾時

version

列印 ffx 工具和 Daemon 版本


Usage:  ffx version [-v]

選項  
--說明 顯示使用資訊
-v、--verbose 如果為 true,則包含 ffx 和 Daemon 的詳細資料