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...]

选项
--help	显示使用情况信息
-c、--config	替换配置值（键=值、JSON 字符串或 JSON 配置文件的路径）
-e、--env	替换环境配置文件的路径（文件路径）
--machine	以指定格式为机器生成输出；可用格式：“json”“json-ready”
--架构	为 MachineWriter 输出生成 JSON 架构。生成架构时必须使用 --machine 选项。
--stamp	在包含退出代码的指定路径上创建图章文件
-t、--target	对单个或多个目标应用操作
-T、--timeout	替换默认代理超时
-l、--log-level	设置 ffx 输出的日志级别（默认值为 Info）。其他可能的值包括 Info、Error、warn 和 Trace。可以通过 log.level 配置设置予以保留。
--isolate-dir	使用指定目录启用隔离模式，将所有配置文件和套接字文件隔离到指定目录中。这会替换 FFX_ISOLATE_DIR 环境变量，也可以将 ffx 置于此模式。
-v、--verbose	根据日志级别将 ffx 输出记录到 stdio

子命令
组件	发现和管理组件
配置	查看和切换默认配置和用户配置
守护程序	与 ffx 守护程序交互/控制
调试	启动调试会话。
医生	对 ffx 工具和主机环境运行常规检查
net	查看和管理目标网络配置
平台	管理平台构建前提条件
产品	查找和访问商品套装元数据和图片数据。
代码库	检查和管理软件包代码库
sdk	修改或查询已安装的 SDK
会话	控制会话组件。
目标	与目标设备或模拟器交互
版本	输出 ffx 工具和守护程序版本

component

发现和管理组件

Usage:  ffx component [subcommand...]

选项
--help	显示使用情况信息

子命令
功能	列出引用某项功能的组件实例
collection	管理组件拓扑中的集合
复制	将文件复制到与组件相关联的目录中或从中复制文件。

路径可以是本地路径或远程路径的任意组合。| create | 创建一个动态组件实例，将其添加到 | debug | 使用 zxdb 调试正在运行的组件。| destroy | 销毁动态组件实例，将其从 | 医生指定的集合中移除 | 在运行时对组件执行诊断检查。 | explore | 生成作用域限定为组件实例的 shell。 | graph | 为组件拓扑中的组件输出 Graphviz 点图。未解析组件的子项不包括在此列表中。 | list | 列出组件拓扑中的组件。未解析组件的子项不包括在此列表中。 | reload | 以递归方式停止、取消解析和启动组件实例，更新代码和拓扑，同时保留资源 | resolve | 解析组件实例 | 路线 | 在运行时对组件执行功能路由。 | run | 在组件拓扑内的现有集合中创建和启动组件实例。 | 显示 | 显示有关组件实例的详细信息 | start | 启动组件 | stop | 停止组件实例 | storage | 管理组件的存储容量

权能

列出引用某项功能的组件实例

Usage:  ffx component capability capability

选项
--help	显示使用情况信息

示例

To show all components that reference a capability:

    $ ffx component capability fuchsia.net.routes

合集

管理组件拓扑中的集合

Usage:  ffx component collection [subcommand...]

选项
--help	显示使用情况信息

子命令
列表	列出组件拓扑中的所有集合
节目	显示有关组件拓扑中集合的详细信息

list

列出组件拓扑中的所有集合

Usage:  ffx component collection list

选项
--help	显示使用情况信息

电视节目

显示有关组件拓扑中集合的详细信息

Usage:  ffx component collection show query

选项
--help	显示使用情况信息

副本

将文件复制到与组件相关联的目录中或从中复制文件。 路径可以是本地路径或远程路径的任意组合。

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

选项
--help	显示使用情况信息
-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

选项
--help	显示使用情况信息
--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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息
-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.

探索

生成作用域限定为组件实例的 shell。

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

选项
--help	显示使用情况信息
--tools	要包含在 shell 环境中的工具包的网址列表。将更新 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>]

选项
--help	显示使用情况信息
-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]

选项
--help	显示使用情况信息
-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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

    $ ffx component resolve /core/brightness_manager

路线

在运行时对组件执行功能路由。

Usage:  ffx component route target [filter]

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息
-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

选项
--help	显示使用情况信息

示例

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

start

启动组件

Usage:  ffx component start [--debug] query

选项
--help	显示使用情况信息
--debug	在调试程序中启动该组件。如需调试已在运行的组件，请考虑使用 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

选项
--help	显示使用情况信息

示例

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...]

选项
--help	显示使用情况信息
--provider	存储空间服务组件的名称。默认为“/core”
--capability	要使用的存储空间的功能名称。示例：“data”“cache”“tmp”默认为“data”

子命令
复制	将文件复制到组件存储空间或从中复制文件。如果目标位置已经存在该文件，则会被覆盖。
删除	从组件的存储空间中删除文件。
全部删除	删除特定组件的存储空间内容。
列表	列出组件存储空间的内容。
make-directory	在组件的存储空间中创建一个新目录。如果该目录已存在，则此操作为空操作。

副本

将文件复制到组件存储空间或从中复制文件。如果目标位置已经存在该文件，则会被覆盖。

Usage:  ffx component storage copy source_path destination_path

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

选项
--help	显示使用情况信息

示例

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

配置

查看和切换默认配置和用户配置

Usage:  ffx config [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	在数组末尾添加配置值
分析	启用或停用 Google Analytics（分析）
check-ssh-keys	请检查 SSH 密钥配置，并根据需要创建密钥。
env	列出环境设置
获取	显示配置值
移除	移除指定级别的配置
设置	设定配置设置

添加

在数组末尾添加配置值

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

选项
--help	显示使用情况信息
-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.

Google Analytics（分析）

启用或停用 Google Analytics（分析）

Usage:  ffx config analytics [subcommand...]

选项
--help	显示使用情况信息

子命令
停用	停用分析
enable	启用分析
节目	显示数据分析

停用

停用分析

Usage:  ffx config analytics disable

选项
--help	显示使用情况信息

enable

启用分析

Usage:  ffx config analytics enable

选项
--help	显示使用情况信息

电视节目

显示数据分析

Usage:  ffx config analytics show

选项
--help	显示使用情况信息

检查 SSH 密钥

请检查 SSH 密钥配置，并根据需要创建密钥。

Usage:  ffx config check-ssh-keys

选项
--help	显示使用情况信息

env

列出环境设置

Usage:  ffx config env [subcommand...]

选项
--help	显示使用情况信息

子命令
获取	列出指定级别的环境
设置	设定环境设置

get

列出指定级别的环境

Usage:  ffx config env get [level]

选项
--help	显示使用情况信息

set

设定环境设置

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

选项
--help	显示使用情况信息
-l、--level	配置级别可能的值有“user”“build”“global”。默认值为“user”。
-b、--build-dir	一个可选的构建目录，用于关联所提供的构建配置 - 用于“构建”配置。如果未提供，它可能会尝试自动发现您的活跃 build 目录。

get

显示配置值

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

选项
--help	显示使用情况信息
-p、--process	如何处理结果。可能的值有“r/raw”、“s/sub/alternate”或“f/file”。默认为“替换”。目前仅在指定了名称的情况下受支持。
-s、--select	如何收集结果。可能的值有“first”和“all”。默认值为“first”。如果值为“first”，则返回根据优先级找到的第一个值。如果值为“all”，则所有配置级别的所有值都将汇总并返回。目前仅在指定了名称的情况下受支持。
-b、--build-dir	一个可选的构建目录，用于关联所提供的构建配置 - 用于“构建”配置。如果未提供，它可能会尝试自动发现您的活跃 build 目录。

错误
2	未找到值

移除

移除指定级别的配置

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

选项
--help	显示使用情况信息
-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.

set

设定配置设置

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

选项
--help	显示使用情况信息
-l、--level	配置级别可能的值有“user”“build”“global”。默认值为“user”。
-b、--build-dir	一个可选的构建目录，用于关联所提供的构建配置 - 用于“构建”配置。如果未提供，它可能会尝试自动发现您的活跃 build 目录。

守护程序

与 ffx 守护程序交互/控制

Usage:  ffx daemon [subcommand...]

选项
--help	显示使用情况信息

子命令
崩溃	让守护程序崩溃
echo	对守护程序运行 echo 测试
挂起	挂起守护程序
日志	转储守护程序日志
套接字	在不连接到守护程序套接字的情况下查询有关该守护程序套接字的信息
开始	作为守护程序运行（通常没必要），因为守护程序会按需自动启动。主要用于调试
停止	停止正在运行的守护程序

入睡

让守护程序崩溃

Usage:  ffx daemon crash

选项
--help	显示使用情况信息

echo

对守护程序运行 echo 测试

Usage:  ffx daemon echo [text]

选项
--help	显示使用情况信息

挂起

挂起守护程序

Usage:  ffx daemon hang

选项
--help	显示使用情况信息

log

转储守护程序日志

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

选项
--help	显示使用情况信息
-f、--follow	实时输出附加日志
-l、--line-count	显示最近的日志行。

套接字

在不连接到守护程序套接字的情况下查询有关该守护程序套接字的信息

Usage:  ffx daemon socket

选项
--help	显示使用情况信息

start

作为守护程序运行（通常没必要），因为守护程序会按需自动启动。主要用于调试

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

选项
--help	显示使用情况信息
--path	替换套接字将绑定到的路径

停止

停止正在运行的守护程序

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

选项
--help	显示使用情况信息
-w、--wait	无限期地等待守护程序在退出前停止（不应在自动化系统中使用）
--no-wait	不等待守护程序停止（默认行为 - 最终会被弃用）
-t、--timeout-ms	用于等待守护程序停止的可选超时（以毫秒为单位）。如果守护程序未自行退出，将尝试将其终止。

调试

启动调试会话。

Usage:  ffx debug [subcommand...]

选项
--help	显示使用情况信息

子命令
建立联系	启动调试程序并连接到目标
core	启动调试程序并打开小型转储
崩溃	在目标平台上捕获崩溃的进程
Fild	监控目标上的 FIDL 流量
limbo	控制目标上的进程限制
符号索引	管理其他调试命令使用的符号源
符号化处理	以标记格式对回溯进行符号化解析

连接

启动调试程序并连接到目标

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

选项
--help	显示使用情况信息
--debugger	在其他调试程序中启动 zxdb。目前，唯一有效的选项是“lldb”。
--agent-only	仅启动调试代理，而不启动 zxdb。系统将输出 UNIX 套接字路径，并可以在 zxdb shell 中通过“connect -u”进行连接。
-a、--attach	会附加到指定的进程该参数的解析方式与控制台中“attach”命令的解析方式相同。
-e、--execute	请执行一个 zxdb 命令将按顺序执行多个命令。
--new-agent	始终为此 zxdb 调用生成新的 DebugAgent 实例。

核心

启动调试程序并打开小型转储

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

选项
--help	显示使用情况信息
--zxdb-args	传递给 zxdb 的额外参数。

入睡

在目标平台上捕获崩溃的进程

Usage:  ffx debug crash

选项
--help	显示使用情况信息

小提琴

监控目标上的 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...]

选项
--help	显示使用情况信息
--from	用于指定来源。来源可以是：设备：这是默认输入。输入来自对一个或多个进程的实时监控。必须至少指定“--remote-pid”“--remote-name”“--remote-job-id”“--'remote-job-name”和“run”中的一项。dump：输入来自 stdin，它是一个或多个程序的日志输出。日志中用于转储系统调用的行，这些行会被解码并替换为解码的版本。所有其他行均保持不变。：播放。用于重放先前使用 --to 录制的会话（protobuf 格式）。路径指定了要读取的文件的名称。如果路径为“-”，则使用标准输入。此选项最多只能使用一次。
--to	会话将保存到指定的文件（二进制 protobuf 格式）。保存会话后，您可以使用“--from ”重放该会话。系统会保存原始数据。这意味着保存的数据与显示的数据无关。
--format	会话转储的显示格式可用的格式包括：美观：会话是美观输出（带颜色）。如果不使用 --with，这是默认输出。json：以 json 格式输出会话。textproto：以文本 protobuf 格式输出会话。无：标准输出中不会显示任何内容（此选项只有在与 --to 或 --with 一起使用时才有意义）。如果没有输出，则 fidlcat 的运行速度会更快（这样可以更好地监控实时组件）。使用 --with 时，这是默认输出。
--with	指定额外的总结输出。summary：在会话结束时，会话摘要将显示在标准输出中。top：在会话结束时，生成一个按进程、协议和方法对输出进行分组的视图。这些群组是按活动数量排序的，因此系统之前会列出包含更多相关活动的群组。按会话分组：针对每个会话显示所有活动的简短版本。等号后跟路径可以连接到一个选项，以将结果输出到文件而不是标准输出中（例如：--with summary=/tmp/x）。此选项可以多次使用。
--with-process-info	在每行显示进程名称、进程 ID 和线程 ID（对 grep 很有用）。
--stack	定义要显示的堆栈帧的数量。0：无（默认值）1：调用点（1 到 4 层）2：全栈帧（增加一些开销）
--系统调用	用于选择要解码和显示的系统调用的正则表达式。可以多次指定此选项。默认情况下，仅显示 zxchannel.* 系统调用。要显示所有系统调用，请使用：--syscalls ".*"
--exclude-syscalls	用于选择不解码和显示的系统调用的正则表达式。可以多次指定此选项。系统调用必须验证 --syscalls 才能显示此显示内容，而不验证 --excluded-syscalls。要显示除 zx_handle 系统调用之外的所有系统调用，请使用：--syscalls "." --Exclude-syscalls "zxhandle.
--messages	用来选择要显示的消息的正则表达式。如需显示消息，方法名称必须满足正则表达式的要求。可以多次指定此选项。消息过滤会对方法的完全限定名称起作用。
--exclude-messages	用于选择不显示消息的正则表达式。如果消息方法名称符合正则表达式，则不会显示消息（即使它满足 --messages ）。可以多次指定此选项。消息过滤会对方法的完全限定名称起作用。
--trigger	仅当找到方法名称符合过滤器要求的消息时，才开始显示消息和系统调用。可以多次指定此选项。消息过滤会对方法的完全限定名称起作用。
--thread	仅显示指定线程的事件。可以多次指定此选项。默认情况下，系统会显示所有事件。
--dump-messages	始终会对消息进行十六进制转储，即使我们可以对其进行解码。
--remote-pid	要跟踪的远程进程的 koid。
-f、--remote-name	进程的 。Fidlcat 将监控名称中包含 （ 是进程名称的子字符串）的所有现有和未来的进程。可以多次指定此选项。当与 --remote-job-id 或 --remote-job-name 一起使用时，系统只会考虑所选作业中的进程。
--extra-name	类似于“--remote-name”，但对于这些进程，仅当“--remote-name”或“--remote-component”之一启动时才会启动监控。此外，即使某些“--extra-name”进程仍在运行，fidlcat 也会在最后一个“--remote-name”或“--remote-component”停止时停止。如果您使用此选项，必须至少使用“--remote-name”或“--remote-component”指定过滤条件。可以多次指定此选项。
-c、--remote-component	我们要监控的组件的网址或名称。该组件中运行的所有进程都会受到监控。可以多次指定此选项。
--extra-component	类似于“--remote-component”；但对于这些组件，仅当“--remote-name”或“--remote-component”之一启动时才会启动监控。此外，即使有些“--extra-component”仍在运行，fidlcat 也会在最后一个“--remote-name”或“--remote-component”停止时停止。如果您使用此选项，必须至少使用“--remote-name”或“--remote-component”指定过滤条件。可以多次指定此选项。
--fidl-ir-path	以 .fidl.json 文件的形式添加指定路径作为 FIDL IR 的代码库。传递文件会添加给定文件。传递目录时，系统会添加该目录中的所有 .fidl.json 文件，以及从该目录可传递访问的任何目录。argfile 包含一个以换行符分隔的 .fidl.json 文件列表，该列表相对于包含 argfile 的目录；传递 argfile（以“@”字符开头）会添加该 argfile 中列出的所有文件。可以多次指定此选项。

Limbo

控制目标上的进程限制

Usage:  ffx debug limbo [subcommand...]

选项
--help	显示使用情况信息

子命令
停用	停用进程 limbo。将释放其中等待的所有待处理进程。
enable	启用进程 Limbo。现在，它将开始捕获崩溃进程。
列表	列出当前正在等待 limbo 的进程。此 Limbo 必须处于启用状态。
版本	从 Limbo 中释放一个进程。此 Limbo 必须处于启用状态。
状态	查询进程 limbo 的状态。

停用

停用进程 limbo。将释放其中等待的所有待处理进程。

Usage:  ffx debug limbo disable

选项
--help	显示使用情况信息

enable

启用进程 Limbo。现在，它将开始捕获崩溃进程。

Usage:  ffx debug limbo enable

选项
--help	显示使用情况信息

list

列出当前正在等待 limbo 的进程。此 Limbo 必须处于启用状态。

Usage:  ffx debug limbo list

选项
--help	显示使用情况信息

发布

从 Limbo 中释放一个进程。此 Limbo 必须处于启用状态。

Usage:  ffx debug limbo release pid

选项
--help	显示使用情况信息

资质

查询进程 limbo 的状态。

Usage:  ffx debug limbo status

选项
--help	显示使用情况信息

符号索引

管理其他调试命令使用的符号源

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

选项
--help	显示使用情况信息

子命令
添加	向符号索引添加路径或网址
干净	移除所有不存在的路径
列表	在符号索引中显示内容
移除	从符号索引中移除路径

备注

• 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

选项
--help	显示使用情况信息
--build-dir	zxdb 用于查找源代码的可选 build 目录

备注

• 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

选项
--help	显示使用情况信息

备注

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

list

在符号索引中显示内容

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

选项
--help	显示使用情况信息
-a、--aggregated	显示聚合符号索引

移除

从符号索引中移除路径

Usage:  ffx debug symbol-index remove source

选项
--help	显示使用情况信息

备注

• 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...]

选项
--help	显示使用情况信息
--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]

选项
--help	显示使用情况信息
--record	生成包含日志的输出 ZIP 文件
--no-config	不包含 ffx 配置文件
--retry-count	重试失败连接的次数
--retry-delay	尝试连接过程中的超时延迟（以毫秒为单位）
--restart-daemon	强制重启守护程序（即使连接正常）
-v、--verbose	详细, 显示所有步骤
--output-dir	覆盖医生记录的默认输出目录
--repair-keys	会检查 SSH 密钥一致性，并根据需要进行修复。这可能会导致所有设备被重新刷写。

示例

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...]

选项
--help	显示使用情况信息
--realm	发送命令时要定位的领域。默认为核心网络领域。

子命令
dhcp	用于接口 dhcp 客户端的命令
dhcpd	用于控制 DP 服务器的命令
dns	用于控制 DNS 解析器的命令
过滤器	用于配置数据包过滤的命令
已弃用过滤条件	用于使用已弃用的 API 配置数据包过滤的命令
if	网络接口命令
日志	命令
迁移	控制用于从 netstack2 迁移到 netstack3 的 netstack 选择
邻居	相邻表命令
路线	命令

dhcp

用于接口 dhcp 客户端的命令

Usage:  ffx net dhcp [subcommand...]

选项
--help	显示使用情况信息

子命令
开始	在接口上启动 dhcp 客户端
停止	在接口上停止 dhcp 客户端

start

在接口上启动 dhcp 客户端

Usage:  ffx net dhcp start nicid or name:ifname

选项
--help	显示使用情况信息

停止

在接口上停止 dhcp 客户端

Usage:  ffx net dhcp stop nicid or name:ifname

选项
--help	显示使用情况信息

丙烯酸酯

用于控制 DP 服务器的命令

Usage:  ffx net dhcpd [subcommand...]

选项
--help	显示使用情况信息

子命令
明确租赁	用于清除 dhcpd 维护的租期的主要命令。
获取	用于检索 DHCP 选项或服务器参数值的主命令。
列表	用于列出所有 DHCP 选项或服务器参数值的主命令。
重置	用于重置所有 DHCP 选项或服务器参数值的主命令。
设置	用于设置 DHCP 选项或服务器参数值的主要命令。
开始	用于启动 DHCP 服务器的主要命令。
停止	用于停止 DHCP 服务器的主命令。

出租

用于清除 dhcpd 维护的租期的主要命令。

Usage:  ffx net dhcpd clear-leases

选项
--help	显示使用情况信息

get

用于检索 DHCP 选项或服务器参数值的主命令。

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

选项
--help	显示使用情况信息

子命令
选项	指示 DHCP 选项参数的辅助命令。
参数	指示服务器参数参数的辅助命令。

选项

指示 DHCP 选项参数的辅助命令。

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

选项
--help	显示使用情况信息

子命令
all-subnets-local	此标记指示已连接网络的所有子网是否都具有相同的 MTU。
arp-cache-timeout	ARP 缓存条目超时。
boot-file-size	客户端的默认启动映像的大小。
bootfile-name	客户端的启动文件名。
广播地址	客户端子网的广播地址。
Cookie 服务器	可供客户端使用的 RFC 865 Cookie 服务器。
default-finger-server	可供客户端使用的默认 Finger 服务器。
default-ip-ttl	用于传出 IP 数据报的默认存留时间。
default-irc-server	可供客户端使用的默认 IRC 服务器。
default-www-server	可供客户端使用的默认 WWW 服务器。
domain-name	客户端的域名。
domain-name-server	可供客户端使用的域名系统服务器。
以太网封装	用于指定客户端应使用以太网 v2 还是 IEEE 802.3 封装的标志。
extensions-path	包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。
主机名	客户的名称。
impress-server	可供客户端使用的 Imagen Impress 服务器。
interface-mtu	客户端接口的 MTU。
ip-forwarding	启用/停用 IP 层数据包转发的标志。
log-server	可供客户端使用的 MIT-LCS UDP 日志服务器。
lpr-服务器	可供客户端使用的 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-plus-domain	网络信息系统+ 域名。
network-information-service-plus-servers	为客户端提供的网络信息 System+ 服务器。
network-time-protocol-servers	可供客户端使用的网络时间协议服务器。
nntp-server	可供客户端使用的 NNTP 服务器。
non-local-source-routing	标志启用/停用具有非本地来源路由的 IP 数据包的转发。
path-mtu-aging-timeout	在路径 MTU 值老化时使用的超时。
path-mtu-plateau-table	路径 MTU 发现的 MTU 大小表。
执行-mask-discovery	此标记指示客户端是否应通过 ICMP 执行子网掩码发现。
perform-router-discovery	此标记指示客户端是否应使用路由器发现请求路由器。
policy-filter	适用于非本地来源路由的政策过滤条件。
pop3 服务器	为客户端提供的 POP3 服务器。
rebinding-time-value	从地址分配开始，客户端转换为重新绑定状态的时间间隔。
renewal-time-value	从地址分配开始客户端转换为续订状态的时间间隔。
resource-location-server	可供客户端使用的 RFC 887 资源位置服务器。
根路径	包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。
路由器	客户端子网中的路由器。
router-solicitation-address	路由器请求请求的目标地址。
smtp-server	可供客户端使用的 SMTP 服务器。
静态路由	客户端应放入其路由缓存的静态路由。
stda-server	可供客户端使用的 StreetTalk Directory Assistance 服务器。
street-talk-server	可供客户端使用的 StreetTalk 服务器。
subnet-mask	客户端的子网掩码。
交换服务器	客户端交换服务器的地址。
tcp-default-ttl	传出 TCP 网段的默认存留时间。
tcp-keepalive-garbage	一个标志，用于指定客户端是否应发送含八位字节的 TCP keepalive 消息。
tcp-keepalive-interval	客户端在发送 TCP keepalive 消息前应等待的时间间隔。
tftp-服务器名称	可供客户端使用的 TFTP 服务器。
时间偏移	客户端相对于世界协调时间 (UTC) 的偏移量。
时间服务器	可供客户端使用的时间协议服务器。
trailer 封装	用于指定客户端是否应协商在 ARP 中使用预告片的标志。
特定于供应商的信息	用于在 DHCP 客户端和 DHCP 服务器之间交换供应商特定信息的选项。
x-window-system-display-manager	X 窗口系统显示管理器系统可供客户端使用。
x-window-system-font-server	可供客户端使用的 X Window System Font 服务器。

all-subnets-local

此标记指示已连接网络的所有子网是否都具有相同的 MTU。

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

选项
--help	显示使用情况信息
--local	一个标志，用于表明客户端所连接的 IP 网络的所有子部分是否具有相同的 MTU。

arp-cache-timeout

ARP 缓存条目超时。

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

选项
--help	显示使用情况信息
--超时	ARP 缓存条目的超时时间（以秒为单位）。

启动文件大小

客户端的默认启动映像的大小。

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

选项
--help	显示使用情况信息
--size	客户端默认启动映像的大小（以 512 个八位字节块为单位）。

启动文件名

客户端的启动文件名。

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

选项
--help	显示使用情况信息
--name	客户端的启动文件名。当 file 字段过载以包含选项时，则应使用此选项。

广播地址

客户端子网的广播地址。

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

选项
--help	显示使用情况信息
--addr	客户端子网的广播地址RFC 1122 中定义了合法值。

Cookie 服务器

可供客户端使用的 RFC 865 Cookie 服务器。

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

选项
--help	显示使用情况信息
--cookie-servers	客户端可用的 RFC 865 Cookie 服务器列表（按优先顺序排列）。

默认手指服务器

可供客户端使用的默认 Finger 服务器。

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

选项
--help	显示使用情况信息
--finger-servers	可供客户端使用的默认 Finger 服务器地址列表（按优先顺序排列）。

default-ip-ttl

用于传出 IP 数据报的默认存留时间。

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

选项
--help	显示使用情况信息
--ttl	用于传出 IP 数据报的默认存留时间。该值必须介于 1 到 255 之间。

默认 irc 服务器

可供客户端使用的默认 IRC 服务器。

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

选项
--help	显示使用情况信息
--irc-servers	可供客户端使用的互联网中继聊天服务器地址列表，按优先顺序列出。

default-www-server

可供客户端使用的默认 WWW 服务器。

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

选项
--help	显示使用情况信息
--www-servers	可供客户端使用的默认万维网 (WWW) 服务器地址列表（按优先顺序列出）。

域名

客户端的域名。

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

选项
--help	显示使用情况信息
--name	用于解析 DNS 中的主机名的客户端域名。

域名服务器

可供客户端使用的域名系统服务器。

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

选项
--help	显示使用情况信息
--domain-name-servers	客户端可用的 DNS 服务器列表（按偏好程度排列）；

以太网封装

用于指定客户端应使用以太网 v2 还是 IEEE 802.3 封装的标志。

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

选项
--help	显示使用情况信息
--encapsulate	一个标志，用于指定当为 false 时，客户端应使用以太网 v2 封装；当为 true 时，则使用 IEEE 802.3 封装。

扩展程序路径

包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。

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

选项
--help	显示使用情况信息
--path	TFTP 可检索文件的路径名称。此文件包含可解读为 BOOTP 供应商扩展字段的数据。与 BOOTP 供应商扩展字段不同，此文件的长度不受限制，并且系统会忽略对代码 18 的所有引用。

主机名

客户的名称。

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

选项
--help	显示使用情况信息
--name	客户端名称，不一定使用本地域名限定。

展示次数服务器

可供客户端使用的 Imagen Impress 服务器。

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

选项
--help	显示使用情况信息
--impress-servers	可供客户端使用的 Imagen Impress 服务器列表（按优先顺序排列）。

interface-mtu

客户端接口的 MTU。

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

选项
--help	显示使用情况信息
--mtu	客户端接口的 MTU。最小值为 68。

ip-forwarding

启用/停用 IP 层数据包转发的标志。

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

选项
--help	显示使用情况信息
--已启用	一个在 true 时启用 IP 层数据包转发的标志。

log-server

可供客户端使用的 MIT-LCS UDP 日志服务器。

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

选项
--help	显示使用情况信息
--log-servers	客户端可用的 MIT-LCS UDP 日志服务器列表（按优先顺序排列）。

lpr-服务器

可供客户端使用的 RFC 1179 行式打印机服务器。

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

选项
--help	显示使用情况信息
--lpr-servers	可供客户端使用的 RFC 1179 打印机服务器列表（按优先顺序排列）。

口罩供应商

此标记指示客户端是否应通过 ICMP 响应子网掩码发现请求。

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

选项
--help	显示使用情况信息
--供应商	指示客户端是否应通过 ICMP 响应子网掩码发现请求的标志。

max-datagram-reassembly-size

客户端应能够重新组装的数据报的最大大小。

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

选项
--help	显示使用情况信息
--size	客户端应该能够重组的最大大小的数据报（以八位字节为单位）。最小合法值为 576。

max-message-size

参与者愿意接受的 DHCP 消息的最大长度。

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

选项
--help	显示使用情况信息
--length	参与者愿意接受的 DHCP 消息中的最大长度（以八位字节为单位）。最小值为 576。

merit-dump-file

核心转储文件的路径名称。

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

选项
--help	显示使用情况信息
--path	客户端核心转储的路径名称。

mobile-ip-home-agent

可供客户端使用的移动 IP 本地代理。

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

选项
--help	显示使用情况信息
--home-agents	可供客户端使用的移动 IP 本地代理地址列表（按优先顺序列出）。

域名服务器

IEN 116 可供客户端使用的域名服务器。

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

选项
--help	显示使用情况信息
--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...>]

选项
--help	显示使用情况信息
--servers	可供客户端使用的 NetBIOS 数据报分发服务器列表，按优先顺序列出。

net-bios-over-tcpip-name-server

可供客户端使用的 NetBIOS 域名服务器。

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

选项
--help	显示使用情况信息
--servers	可供客户端使用的 NetBIOS 域名服务器地址列表（按优先顺序列出）。

net-bios-over-tcpip-node-type

客户端应使用的 NetBIOS 节点类型。

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

选项
--help	显示使用情况信息

子命令
b 节点	A B 节点类型。
h 节点	一种 H 节点类型。
m-node	M 节点类型。
p-node	一种 P 节点类型。

# 个 b 节点

A B 节点类型。

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

选项
--help	显示使用情况信息

# 个 h 节点

一种 H 节点类型。

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

选项
--help	显示使用情况信息

# 个 m 节点

M 节点类型。

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

选项
--help	显示使用情况信息

# 个 p 节点

一种 P 节点类型。

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

选项
--help	显示使用情况信息

net-bios-over-tcpip-scope

客户端的 NetBIOS 范围参数。

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

选项
--help	显示使用情况信息
--scope	RFC 1001 中针对客户端的 NetBIOS over TCP/IP 范围参数。

网络信息服务器

可供客户端使用的网络信息服务服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络信息服务服务器地址列表，按优先顺序列出。

network-information-service-domain

客户端的网络信息服务网域的名称。

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

选项
--help	显示使用情况信息
--domain-name	客户端的网络信息服务域的名称。

network-information-service-plus-domain

网络信息系统+ 域名。

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

选项
--help	显示使用情况信息
--domain-name	客户的 Network Information System+ 域名。

network-information-service-plus-servers

为客户端提供的网络信息 System+ 服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络信息系统+ 服务器地址列表，按优先顺序列出。

network-time-protocol-servers

可供客户端使用的网络时间协议服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络时间协议 (NTP) 服务器地址列表，按优先顺序列出。

nntp 服务器

可供客户端使用的 NNTP 服务器。

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

选项
--help	显示使用情况信息
--nntp-servers	客户端可用的网络新闻传输协议 (NNTP) 服务器地址列表，按优先顺序列出。

non-local-source-routing

标志启用/停用具有非本地来源路由的 IP 数据包的转发。

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

选项
--help	显示使用情况信息
--已启用	一个标志，用于转发具有非本地来源路由的 IP 数据包。

path-mtu-aging-timeout

在路径 MTU 值老化时使用的超时。

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

选项
--help	显示使用情况信息
--超时	超时（以秒为单位），可以 RFC 1191 中的机制再次使用路径 MTU 值。

path-mtu-plateau-table

路径 MTU 发现的 MTU 大小表。

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

选项
--help	显示使用情况信息
--mtu-sizes	MTU 大小列表（按从小到大的顺序排列）。最小值不能小于 68。

执行-遮盖发现

此标记指示客户端是否应通过 ICMP 执行子网掩码发现。

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

选项
--help	显示使用情况信息
--do-discovery	指示客户端是否应通过 ICMP 执行子网掩码发现的标志。

perform-router-discovery

此标记指示客户端是否应使用路由器发现请求路由器。

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

选项
--help	显示使用情况信息
--do-discovery	一个标志，指示客户端是否应使用 RFC 1256 中定义的路由器发现功能请求路由器。

政策过滤条件

适用于非本地来源路由的政策过滤条件。

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

选项
--help	显示使用情况信息
--addresses	IP 地址和子网掩码对列表。如果传入的来源路由数据包的下一个跃点与这两个键值对中的任一类型不匹配，则该数据包会被丢弃。

pop3 服务器

为客户端提供的 POP3 服务器。

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

选项
--help	显示使用情况信息
--pop3-servers	客户端可用的邮局协议 (POP3) 服务器地址列表，按优先顺序列出。

重新绑定时间值

从地址分配开始，客户端转换为重新绑定状态的时间间隔。

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

选项
--help	显示使用情况信息
--interval	指定地址后客户端转换到重新绑定状态的时间间隔（以秒为单位）。

续订时间值

从地址分配开始客户端转换为续订状态的时间间隔。

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

选项
--help	显示使用情况信息
--interval	地址分配后客户端转换到续订状态的时间间隔（以秒为单位）。

资源位置服务器

可供客户端使用的 RFC 887 资源位置服务器。

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

选项
--help	显示使用情况信息
--resource-location-servers	可供客户端使用的 RFC 887 资源位置服务器列表（按优先顺序排列）。

根路径

包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。

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

选项
--help	显示使用情况信息
--path	TFTP 可检索文件的路径名称。此文件包含可解读为 BOOTP 供应商扩展字段的数据。与 BOOTP 供应商扩展字段不同，此文件的长度不受限制，并且系统会忽略对代码 18 的所有引用。

路由器

客户端子网中的路由器。

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

选项
--help	显示使用情况信息
--路由器	客户端子网中的路由器列表（按优先级顺序列出）。

路由器请求地址

路由器请求请求的目标地址。

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

选项
--help	显示使用情况信息
--addr	客户端应向该地址传输路由器请求请求的地址。

smtp-server

可供客户端使用的 SMTP 服务器。

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

选项
--help	显示使用情况信息
--smtp-servers	客户端可用的简单邮件传输协议 (SMTP) 服务器地址列表（按优先顺序列出）。

静态路由

客户端应放入其路由缓存的静态路由。

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

选项
--help	显示使用情况信息
--routes	目标地址/下一个跃点地址对的列表，用于定义客户端路由表的静态路由。路由应按优先级降序排列。在静态路由中使用 0.0.0.0 作为目的地是非法的。

stda 服务器

可供客户端使用的 StreetTalk Directory Assistance 服务器。

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

选项
--help	显示使用情况信息
--stda-servers	可供客户端使用的 StreetTalk Directory Assistance 服务器地址列表（按优先顺序排列）。

街头交谈服务器

可供客户端使用的 StreetTalk 服务器。

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

选项
--help	显示使用情况信息
--streettalk-servers	可供客户端使用的 StreetTalk 服务器地址列表（按优先顺序排列）。

子网掩码

客户端的子网掩码。

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

选项
--help	显示使用情况信息
--mask	一个 32 位的 IPv4 子网掩码

交换服务器

客户端交换服务器的地址。

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

选项
--help	显示使用情况信息
--address	客户端交换服务器的地址。

tcp-default-ttl

传出 TCP 网段的默认存留时间。

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

选项
--help	显示使用情况信息
--ttl	客户端应为传出 TCP 分段使用的默认存留时间。最小值为 1。

tcp-keepalive-garbage

一个标志，用于指定客户端是否应发送含八位字节的 TCP keepalive 消息。

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

选项
--help	显示使用情况信息
--send-garbage	一个标记，用于指定客户端是否应发送含八位字节的垃圾回收信息以与旧实现兼容。

tcp-keepalive-interval

客户端在发送 TCP keepalive 消息前应等待的时间间隔。

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

选项
--help	显示使用情况信息
--interval	客户端在发送 TCP keepalive 消息前应等待的时间间隔（以秒为单位）。值为 0 时，表示客户端不应发送 keepalive 消息，除非应用明确请求。

tftp 服务器名称

可供客户端使用的 TFTP 服务器。

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

选项
--help	显示使用情况信息
--name	客户端可用的 TFTP 服务器名称。当 sname 字段过载以包含选项时，应使用此选项。

时差

客户端相对于世界协调时间 (UTC) 的偏移量。

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

选项
--help	显示使用情况信息
--offset	客户端相对于世界协调时间 (UTC) 的偏移量（以秒为单位）。正偏移位于零子午线以东，负偏移位于零子午线以西。

时间服务器

可供客户端使用的时间协议服务器。

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

选项
--help	显示使用情况信息
--time-servers	可供客户端使用的时间服务器列表（按优先顺序排列）。

预告片封装

用于指定客户端是否应协商在 ARP 中使用预告片的标志。

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

选项
--help	显示使用情况信息
--预告片	一个标志，用于指定在使用 ARP 时客户端是否协商预告片的使用，符合 RFC 893 标准。

特定于供应商的信息

用于在 DHCP 客户端和 DHCP 服务器之间交换供应商特定信息的选项。

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

选项
--help	显示使用情况信息
--data	一个八位字节的不透明对象，用于交换特定于供应商的信息。

x-window-system-display-manager

X 窗口系统显示管理器系统可供客户端使用。

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

选项
--help	显示使用情况信息
--display-servers	可供客户使用的 X Window System Display Manager 系统地址列表（按优先顺序排列）。

x-window-system-font-server

可供客户端使用的 X Window System Font 服务器。

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

选项
--help	显示使用情况信息
--servers	可供客户端使用的 X Window System Font 服务器地址列表（按优先顺序排列）。

参数

指示服务器参数参数的辅助命令。

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

选项
--help	显示使用情况信息

子命令
address-pool	DHCP 服务器管理的地址池。
arp 探测	启用服务器行为，即服务器在发出 IP 地址之前发出 IP 地址。
bound-device-names	服务器将监听的网络设备的名称。
ip-addrs	服务器绑定到的 IPv4 地址。
lease-length	服务器提供的租期。
允许的 macs	服务器将向其发出租期的客户端 MAC 地址。
静态分配的地址数量	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>]

选项
--help	显示使用情况信息
--prefix-length	网络子网掩码的前缀长度
--range-start	DHCP 服务器将向客户端租用的地址范围的起始地址（含此范围）
--range-stop	服务器发送给客户端的地址范围的结束地址（含此范围）

arp 探测

启用服务器行为，即服务器在发出 IP 地址之前发出 IP 地址。

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

选项
--help	显示使用情况信息
--已启用	可启用如下服务器行为：服务器在发出 IP 地址之前，先发送 IP 地址。如果服务器收到响应，则会将地址标记为使用中，并使用其他地址重试。默认情况下，此行为处于停用状态。

绑定设备名称

服务器将监听的网络设备的名称。

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

选项
--help	显示使用情况信息

ip-addrs

服务器绑定到的 IPv4 地址。

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

选项
--help	显示使用情况信息
--addrs	服务器绑定到的 IPv4 地址列表。

lease-length

服务器提供的租期。

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

选项
--help	显示使用情况信息
--默认	向客户端发出的默认租用时长（以秒为单位）。
--max	服务器将向请求特定租期期限的客户端发出的租用时长上限值（以秒为单位）。如果默认值为 0，则最大租借长度等于默认租借长度。

允许的 macs

服务器将向其发出租期的客户端 MAC 地址。

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

选项
--help	显示使用情况信息
--macs	服务器将向其发放租期的客户端 MAC 地址。默认情况下，服务器没有允许的 MAC 列表，在这种情况下，它会尝试向每个请求 MAC 列表的客户端发出租金。如果 allow_macs 的长度不为零，则服务器将仅响应来自列表中具有 MAC 的客户端的租借请求。

静态分配的地址

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...>]

选项
--help	显示使用情况信息
--hosts	将租用由 assigned_addrs 预留的地址的主机。
--assigned-addrs	AddressPool 中的 IP 地址，该地址不会被租用给客户端。通常，网络管理员会将这些地址静态分配给始终开启的网络设备，这些设备应始终具有相同的 IP 地址，例如网络打印机。

list

用于列出所有 DHCP 选项或服务器参数值的主命令。

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

选项
--help	显示使用情况信息

子命令
选项	在 DHCP 选项上执行该命令。
参数	对服务器参数执行此命令。

选项

在 DHCP 选项上执行该命令。

Usage:  ffx net dhcpd list option

选项
--help	显示使用情况信息

参数

对服务器参数执行此命令。

Usage:  ffx net dhcpd list parameter

选项
--help	显示使用情况信息

重置

用于重置所有 DHCP 选项或服务器参数值的主命令。

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

选项
--help	显示使用情况信息

子命令
选项	在 DHCP 选项上执行该命令。
参数	对服务器参数执行此命令。

选项

在 DHCP 选项上执行该命令。

Usage:  ffx net dhcpd reset option

选项
--help	显示使用情况信息

参数

对服务器参数执行此命令。

Usage:  ffx net dhcpd reset parameter

选项
--help	显示使用情况信息

set

用于设置 DHCP 选项或服务器参数值的主要命令。

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

选项
--help	显示使用情况信息

子命令
选项	指示 DHCP 选项参数的辅助命令。
参数	指示服务器参数参数的辅助命令。

选项

指示 DHCP 选项参数的辅助命令。

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

选项
--help	显示使用情况信息

子命令
all-subnets-local	此标记指示已连接网络的所有子网是否都具有相同的 MTU。
arp-cache-timeout	ARP 缓存条目超时。
boot-file-size	客户端的默认启动映像的大小。
bootfile-name	客户端的启动文件名。
广播地址	客户端子网的广播地址。
Cookie 服务器	可供客户端使用的 RFC 865 Cookie 服务器。
default-finger-server	可供客户端使用的默认 Finger 服务器。
default-ip-ttl	用于传出 IP 数据报的默认存留时间。
default-irc-server	可供客户端使用的默认 IRC 服务器。
default-www-server	可供客户端使用的默认 WWW 服务器。
domain-name	客户端的域名。
domain-name-server	可供客户端使用的域名系统服务器。
以太网封装	用于指定客户端应使用以太网 v2 还是 IEEE 802.3 封装的标志。
extensions-path	包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。
主机名	客户的名称。
impress-server	可供客户端使用的 Imagen Impress 服务器。
interface-mtu	客户端接口的 MTU。
ip-forwarding	启用/停用 IP 层数据包转发的标志。
log-server	可供客户端使用的 MIT-LCS UDP 日志服务器。
lpr-服务器	可供客户端使用的 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-plus-domain	网络信息系统+ 域名。
network-information-service-plus-servers	为客户端提供的网络信息 System+ 服务器。
network-time-protocol-servers	可供客户端使用的网络时间协议服务器。
nntp-server	可供客户端使用的 NNTP 服务器。
non-local-source-routing	标志启用/停用具有非本地来源路由的 IP 数据包的转发。
path-mtu-aging-timeout	在路径 MTU 值老化时使用的超时。
path-mtu-plateau-table	路径 MTU 发现的 MTU 大小表。
执行-mask-discovery	此标记指示客户端是否应通过 ICMP 执行子网掩码发现。
perform-router-discovery	此标记指示客户端是否应使用路由器发现请求路由器。
policy-filter	适用于非本地来源路由的政策过滤条件。
pop3 服务器	为客户端提供的 POP3 服务器。
rebinding-time-value	从地址分配开始，客户端转换为重新绑定状态的时间间隔。
renewal-time-value	从地址分配开始客户端转换为续订状态的时间间隔。
resource-location-server	可供客户端使用的 RFC 887 资源位置服务器。
根路径	包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。
路由器	客户端子网中的路由器。
router-solicitation-address	路由器请求请求的目标地址。
smtp-server	可供客户端使用的 SMTP 服务器。
静态路由	客户端应放入其路由缓存的静态路由。
stda-server	可供客户端使用的 StreetTalk Directory Assistance 服务器。
street-talk-server	可供客户端使用的 StreetTalk 服务器。
subnet-mask	客户端的子网掩码。
交换服务器	客户端交换服务器的地址。
tcp-default-ttl	传出 TCP 网段的默认存留时间。
tcp-keepalive-garbage	一个标志，用于指定客户端是否应发送含八位字节的 TCP keepalive 消息。
tcp-keepalive-interval	客户端在发送 TCP keepalive 消息前应等待的时间间隔。
tftp-服务器名称	可供客户端使用的 TFTP 服务器。
时间偏移	客户端相对于世界协调时间 (UTC) 的偏移量。
时间服务器	可供客户端使用的时间协议服务器。
trailer 封装	用于指定客户端是否应协商在 ARP 中使用预告片的标志。
特定于供应商的信息	用于在 DHCP 客户端和 DHCP 服务器之间交换供应商特定信息的选项。
x-window-system-display-manager	X 窗口系统显示管理器系统可供客户端使用。
x-window-system-font-server	可供客户端使用的 X Window System Font 服务器。

all-subnets-local

此标记指示已连接网络的所有子网是否都具有相同的 MTU。

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

选项
--help	显示使用情况信息
--local	一个标志，用于表明客户端所连接的 IP 网络的所有子部分是否具有相同的 MTU。

arp-cache-timeout

ARP 缓存条目超时。

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

选项
--help	显示使用情况信息
--超时	ARP 缓存条目的超时时间（以秒为单位）。

启动文件大小

客户端的默认启动映像的大小。

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

选项
--help	显示使用情况信息
--size	客户端默认启动映像的大小（以 512 个八位字节块为单位）。

启动文件名

客户端的启动文件名。

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

选项
--help	显示使用情况信息
--name	客户端的启动文件名。当 file 字段过载以包含选项时，则应使用此选项。

广播地址

客户端子网的广播地址。

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

选项
--help	显示使用情况信息
--addr	客户端子网的广播地址RFC 1122 中定义了合法值。

Cookie 服务器

可供客户端使用的 RFC 865 Cookie 服务器。

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

选项
--help	显示使用情况信息
--cookie-servers	客户端可用的 RFC 865 Cookie 服务器列表（按优先顺序排列）。

默认手指服务器

可供客户端使用的默认 Finger 服务器。

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

选项
--help	显示使用情况信息
--finger-servers	可供客户端使用的默认 Finger 服务器地址列表（按优先顺序排列）。

default-ip-ttl

用于传出 IP 数据报的默认存留时间。

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

选项
--help	显示使用情况信息
--ttl	用于传出 IP 数据报的默认存留时间。该值必须介于 1 到 255 之间。

默认 irc 服务器

可供客户端使用的默认 IRC 服务器。

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

选项
--help	显示使用情况信息
--irc-servers	可供客户端使用的互联网中继聊天服务器地址列表，按优先顺序列出。

default-www-server

可供客户端使用的默认 WWW 服务器。

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

选项
--help	显示使用情况信息
--www-servers	可供客户端使用的默认万维网 (WWW) 服务器地址列表（按优先顺序列出）。

域名

客户端的域名。

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

选项
--help	显示使用情况信息
--name	用于解析 DNS 中的主机名的客户端域名。

域名服务器

可供客户端使用的域名系统服务器。

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

选项
--help	显示使用情况信息
--domain-name-servers	客户端可用的 DNS 服务器列表（按偏好程度排列）；

以太网封装

用于指定客户端应使用以太网 v2 还是 IEEE 802.3 封装的标志。

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

选项
--help	显示使用情况信息
--encapsulate	一个标志，用于指定当为 false 时，客户端应使用以太网 v2 封装；当为 true 时，则使用 IEEE 802.3 封装。

扩展程序路径

包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。

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

选项
--help	显示使用情况信息
--path	TFTP 可检索文件的路径名称。此文件包含可解读为 BOOTP 供应商扩展字段的数据。与 BOOTP 供应商扩展字段不同，此文件的长度不受限制，并且系统会忽略对代码 18 的所有引用。

主机名

客户的名称。

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

选项
--help	显示使用情况信息
--name	客户端名称，不一定使用本地域名限定。

展示次数服务器

可供客户端使用的 Imagen Impress 服务器。

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

选项
--help	显示使用情况信息
--impress-servers	可供客户端使用的 Imagen Impress 服务器列表（按优先顺序排列）。

interface-mtu

客户端接口的 MTU。

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

选项
--help	显示使用情况信息
--mtu	客户端接口的 MTU。最小值为 68。

ip-forwarding

启用/停用 IP 层数据包转发的标志。

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

选项
--help	显示使用情况信息
--已启用	一个在 true 时启用 IP 层数据包转发的标志。

log-server

可供客户端使用的 MIT-LCS UDP 日志服务器。

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

选项
--help	显示使用情况信息
--log-servers	客户端可用的 MIT-LCS UDP 日志服务器列表（按优先顺序排列）。

lpr-服务器

可供客户端使用的 RFC 1179 行式打印机服务器。

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

选项
--help	显示使用情况信息
--lpr-servers	可供客户端使用的 RFC 1179 打印机服务器列表（按优先顺序排列）。

口罩供应商

此标记指示客户端是否应通过 ICMP 响应子网掩码发现请求。

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

选项
--help	显示使用情况信息
--供应商	指示客户端是否应通过 ICMP 响应子网掩码发现请求的标志。

max-datagram-reassembly-size

客户端应能够重新组装的数据报的最大大小。

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

选项
--help	显示使用情况信息
--size	客户端应该能够重组的最大大小的数据报（以八位字节为单位）。最小合法值为 576。

max-message-size

参与者愿意接受的 DHCP 消息的最大长度。

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

选项
--help	显示使用情况信息
--length	参与者愿意接受的 DHCP 消息中的最大长度（以八位字节为单位）。最小值为 576。

merit-dump-file

核心转储文件的路径名称。

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

选项
--help	显示使用情况信息
--path	客户端核心转储的路径名称。

mobile-ip-home-agent

可供客户端使用的移动 IP 本地代理。

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

选项
--help	显示使用情况信息
--home-agents	可供客户端使用的移动 IP 本地代理地址列表（按优先顺序列出）。

域名服务器

IEN 116 可供客户端使用的域名服务器。

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

选项
--help	显示使用情况信息
--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...>]

选项
--help	显示使用情况信息
--servers	可供客户端使用的 NetBIOS 数据报分发服务器列表，按优先顺序列出。

net-bios-over-tcpip-name-server

可供客户端使用的 NetBIOS 域名服务器。

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

选项
--help	显示使用情况信息
--servers	可供客户端使用的 NetBIOS 域名服务器地址列表（按优先顺序列出）。

net-bios-over-tcpip-node-type

客户端应使用的 NetBIOS 节点类型。

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

选项
--help	显示使用情况信息

子命令
b 节点	A B 节点类型。
h 节点	一种 H 节点类型。
m-node	M 节点类型。
p-node	一种 P 节点类型。

# 个 b 节点

A B 节点类型。

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

选项
--help	显示使用情况信息

# 个 h 节点

一种 H 节点类型。

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

选项
--help	显示使用情况信息

# 个 m 节点

M 节点类型。

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

选项
--help	显示使用情况信息

# 个 p 节点

一种 P 节点类型。

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

选项
--help	显示使用情况信息

net-bios-over-tcpip-scope

客户端的 NetBIOS 范围参数。

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

选项
--help	显示使用情况信息
--scope	RFC 1001 中针对客户端的 NetBIOS over TCP/IP 范围参数。

网络信息服务器

可供客户端使用的网络信息服务服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络信息服务服务器地址列表，按优先顺序列出。

network-information-service-domain

客户端的网络信息服务网域的名称。

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

选项
--help	显示使用情况信息
--domain-name	客户端的网络信息服务域的名称。

network-information-service-plus-domain

网络信息系统+ 域名。

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

选项
--help	显示使用情况信息
--domain-name	客户的 Network Information System+ 域名。

network-information-service-plus-servers

为客户端提供的网络信息 System+ 服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络信息系统+ 服务器地址列表，按优先顺序列出。

network-time-protocol-servers

可供客户端使用的网络时间协议服务器。

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

选项
--help	显示使用情况信息
--servers	客户端可用的网络时间协议 (NTP) 服务器地址列表，按优先顺序列出。

nntp 服务器

可供客户端使用的 NNTP 服务器。

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

选项
--help	显示使用情况信息
--nntp-servers	客户端可用的网络新闻传输协议 (NNTP) 服务器地址列表，按优先顺序列出。

non-local-source-routing

标志启用/停用具有非本地来源路由的 IP 数据包的转发。

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

选项
--help	显示使用情况信息
--已启用	一个标志，用于转发具有非本地来源路由的 IP 数据包。

path-mtu-aging-timeout

在路径 MTU 值老化时使用的超时。

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

选项
--help	显示使用情况信息
--超时	超时（以秒为单位），可以 RFC 1191 中的机制再次使用路径 MTU 值。

path-mtu-plateau-table

路径 MTU 发现的 MTU 大小表。

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

选项
--help	显示使用情况信息
--mtu-sizes	MTU 大小列表（按从小到大的顺序排列）。最小值不能小于 68。

执行-遮盖发现

此标记指示客户端是否应通过 ICMP 执行子网掩码发现。

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

选项
--help	显示使用情况信息
--do-discovery	指示客户端是否应通过 ICMP 执行子网掩码发现的标志。

perform-router-discovery

此标记指示客户端是否应使用路由器发现请求路由器。

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

选项
--help	显示使用情况信息
--do-discovery	一个标志，用于表明客户端是否应使用 RFC 1256 中定义的路由器发现功能请求路由器。

政策过滤条件

适用于非本地来源路由的政策过滤条件。

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

选项
--help	显示使用情况信息
--addresses	IP 地址和子网掩码对列表。如果传入的来源路由数据包的下一个跃点与这两个键值对中的任一类型不匹配，则该数据包会被丢弃。

pop3 服务器

为客户端提供的 POP3 服务器。

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

选项
--help	显示使用情况信息
--pop3-servers	客户端可用的邮局协议 (POP3) 服务器地址列表，按优先顺序列出。

重新绑定时间值

从地址分配开始，客户端转换为重新绑定状态的时间间隔。

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

选项
--help	显示使用情况信息
--interval	指定地址后客户端转换到重新绑定状态的时间间隔（以秒为单位）。

续订时间值

从地址分配开始客户端转换为续订状态的时间间隔。

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

选项
--help	显示使用情况信息
--interval	地址分配后客户端转换到续订状态的时间间隔（以秒为单位）。

资源位置服务器

可供客户端使用的 RFC 887 资源位置服务器。

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

选项
--help	显示使用情况信息
--resource-location-servers	可供客户端使用的 RFC 887 资源位置服务器列表（按优先顺序排列）。

根路径

包含供应商扩展程序信息的 TFTP 可检索文件的路径名称。

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

选项
--help	显示使用情况信息
--path	TFTP 可检索文件的路径名称。此文件包含可解读为 BOOTP 供应商扩展字段的数据。与 BOOTP 供应商扩展字段不同，此文件的长度不受限制，并且系统会忽略对代码 18 的所有引用。

路由器

客户端子网中的路由器。

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

选项
--help	显示使用情况信息
--路由器	客户端子网中的路由器列表（按优先级顺序列出）。

路由器请求地址

路由器请求请求的目标地址。

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

选项
--help	显示使用情况信息
--addr	客户端应向该地址传输路由器请求请求的地址。

smtp-server

可供客户端使用的 SMTP 服务器。

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

选项
--help	显示使用情况信息
--smtp-servers	客户端可用的简单邮件传输协议 (SMTP) 服务器地址列表（按优先顺序列出）。

静态路由

客户端应放入其路由缓存的静态路由。

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

选项
--help	显示使用情况信息
--routes	目标地址/下一个跃点地址对的列表，用于定义客户端路由表的静态路由。路由应按优先级降序排列。在静态路由中使用 0.0.0.0 作为目的地是非法的。

stda 服务器

可供客户端使用的 StreetTalk Directory Assistance 服务器。

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

选项
--help	显示使用情况信息
--stda-servers	可供客户端使用的 StreetTalk Directory Assistance 服务器地址列表（按优先顺序排列）。

街头交谈服务器

可供客户端使用的 StreetTalk 服务器。

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

选项
--help	显示使用情况信息
--streettalk-servers	可供客户端使用的 StreetTalk 服务器地址列表（按优先顺序排列）。

子网掩码

客户端的子网掩码。

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

选项
--help	显示使用情况信息
--mask	一个 32 位的 IPv4 子网掩码

交换服务器

客户端交换服务器的地址。

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

选项
--help	显示使用情况信息
--address	客户端交换服务器的地址。

tcp-default-ttl

传出 TCP 网段的默认存留时间。

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

选项
--help	显示使用情况信息
--ttl	客户端应为传出 TCP 分段使用的默认存留时间。最小值为 1。

tcp-keepalive-garbage

一个标志，用于指定客户端是否应发送含八位字节的 TCP keepalive 消息。

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

选项
--help	显示使用情况信息
--send-garbage	一个标记，用于指定客户端是否应发送含八位字节的垃圾回收信息以与旧实现兼容。

tcp-keepalive-interval

客户端在发送 TCP keepalive 消息前应等待的时间间隔。

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

选项
--help	显示使用情况信息
--interval	客户端在发送 TCP keepalive 消息前应等待的时间间隔（以秒为单位）。值为 0 时，表示客户端不应发送 keepalive 消息，除非应用明确请求。

tftp 服务器名称

可供客户端使用的 TFTP 服务器。

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

选项
--help	显示使用情况信息
--name	客户端可用的 TFTP 服务器名称。当 sname 字段过载以包含选项时，应使用此选项。

时差

客户端相对于世界协调时间 (UTC) 的偏移量。

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

选项
--help	显示使用情况信息
--offset	客户端相对于世界协调时间 (UTC) 的偏移量（以秒为单位）。正偏移位于零子午线以东，负偏移位于零子午线以西。

时间服务器

可供客户端使用的时间协议服务器。

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

选项
--help	显示使用情况信息
--time-servers	可供客户端使用的时间服务器列表（按优先顺序排列）。

预告片封装

用于指定客户端是否应协商在 ARP 中使用预告片的标志。

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

选项
--help	显示使用情况信息
--预告片	一个标志，用于指定在使用 ARP 时客户端是否协商预告片的使用，符合 RFC 893 标准。

特定于供应商的信息

用于在 DHCP 客户端和 DHCP 服务器之间交换供应商特定信息的选项。

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

选项
--help	显示使用情况信息
--data	一个八位字节的不透明对象，用于交换特定于供应商的信息。

x-window-system-display-manager

X 窗口系统显示管理器系统可供客户端使用。

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

选项
--help	显示使用情况信息
--display-servers	可供客户使用的 X Window System Display Manager 系统地址列表（按优先顺序排列）。

x-window-system-font-server

可供客户端使用的 X Window System Font 服务器。

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

选项
--help	显示使用情况信息
--servers	可供客户端使用的 X Window System Font 服务器地址列表（按优先顺序排列）。

参数

指示服务器参数参数的辅助命令。

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

选项
--help	显示使用情况信息

子命令
address-pool	DHCP 服务器管理的地址池。
arp 探测	启用服务器行为，即服务器在发出 IP 地址之前发出 IP 地址。
bound-device-names	服务器将监听的网络设备的名称。
ip-addrs	服务器绑定到的 IPv4 地址。
lease-length	服务器提供的租期。
允许的 macs	服务器将向其发出租期的客户端 MAC 地址。
静态分配的地址数量	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>]

选项
--help	显示使用情况信息
--prefix-length	网络子网掩码的前缀长度
--range-start	DHCP 服务器将向客户端租用的地址范围的起始地址（含此范围）
--range-stop	服务器发送给客户端的地址范围的结束地址（含此范围）

arp 探测

启用服务器行为，即服务器在发出 IP 地址之前发出 IP 地址。

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

选项
--help	显示使用情况信息
--已启用	可启用如下服务器行为：服务器在发出 IP 地址之前，先发送 IP 地址。如果服务器收到响应，则会将地址标记为使用中，并使用其他地址重试。默认情况下，此行为处于停用状态。

绑定设备名称

服务器将监听的网络设备的名称。

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

选项
--help	显示使用情况信息

ip-addrs

服务器绑定到的 IPv4 地址。

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

选项
--help	显示使用情况信息
--addrs	服务器绑定到的 IPv4 地址列表。

lease-length

服务器提供的租期。

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

选项
--help	显示使用情况信息
--默认	向客户端发出的默认租用时长（以秒为单位）。
--max	服务器将向请求特定租期期限的客户端发出的租用时长上限值（以秒为单位）。如果默认值为 0，则最大租借长度等于默认租借长度。

允许的 macs

服务器将向其发出租期的客户端 MAC 地址。

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

选项
--help	显示使用情况信息
--macs	服务器将向其发放租期的客户端 MAC 地址。默认情况下，服务器没有允许的 MAC 列表，在这种情况下，它会尝试向每个请求 MAC 列表的客户端发出租金。如果 allow_macs 的长度不为零，则服务器将仅响应来自列表中具有 MAC 的客户端的租借请求。

静态分配的地址

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...>]

选项
--help	显示使用情况信息
--hosts	将租用由 assigned_addrs 预留的地址的主机。
--assigned-addrs	AddressPool 中的 IP 地址，该地址不会被租用给客户端。通常，网络管理员会将这些地址静态分配给始终开启的网络设备，这些设备应始终具有相同的 IP 地址，例如网络打印机。

start

用于启动 DHCP 服务器的主要命令。

Usage:  ffx net dhcpd start

选项
--help	显示使用情况信息

停止

用于停止 DHCP 服务器的主命令。

Usage:  ffx net dhcpd stop

选项
--help	显示使用情况信息

dns

用于控制 DNS 解析器的命令

Usage:  ffx net dns [subcommand...]

选项
--help	显示使用情况信息

子命令
查询	对指定的主机名执行 DNS 解析

查询

对指定的主机名执行 DNS 解析

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

选项
--help	显示使用情况信息
--ipv4	包含 ipv4 结果（默认为 true）
--ipv6	包含 ipv6 结果（默认为 true）
--排序	按优先顺序对地址进行排序（默认为 true）

filter

用于配置数据包过滤的命令

Usage:  ffx net filter [subcommand...]

选项
--help	显示使用情况信息

子命令
列表	用于列出过滤配置的命令。

list

用于列出过滤配置的命令。

Usage:  ffx net filter list

选项
--help	显示使用情况信息

已弃用的过滤条件

用于使用已弃用的 API 配置数据包过滤的命令

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

选项
--help	显示使用情况信息

子命令
get-nat-rules	获取 nat 规则
get-rdr-rules	获取 RR 规则
get-rules	获取过滤规则
set-nat-rules	设置 nat 规则（请参阅 netfilter::parser 库了解 NAT 规则格式）
set-rdr-rules	设置 rdr 规则（请参阅 netfilter::parser 库了解 RDR 规则格式）
set-rules	设置过滤器规则（请参阅 netfilter::parser 库了解规则格式）

get-nat-rules

获取 nat 规则

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

选项
--help	显示使用情况信息

get-rdr 规则

获取 RR 规则

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

选项
--help	显示使用情况信息

get-rules

获取过滤规则

Usage:  ffx net filter-deprecated get-rules

选项
--help	显示使用情况信息

set-nat-rules

设置 nat 规则（请参阅 netfilter::parser 库了解 NAT 规则格式）

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

选项
--help	显示使用情况信息

set-rdr-rules

设置 rdr 规则（请参阅 netfilter::parser 库了解 RDR 规则格式）

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

选项
--help	显示使用情况信息

set-rules

设置过滤器规则（请参阅 netfilter::parser 库了解规则格式）

Usage:  ffx net filter-deprecated set-rules rules

选项
--help	显示使用情况信息

if

网络接口命令

Usage:  ffx net if [subcommand...]

选项
--help	显示使用情况信息

子命令
addr	用于更新网络接口地址的命令
桥	可在网络接口之间创建网桥
停用	停用网络接口
enable	用于启用网络接口
获取	查询网络接口
igmp	获取或设置 IGMP 配置
ip-forward	获取或设置接口的 IP 转发
列表	列出网络接口（支持 ffx 机器输出）
MLD	获取或设置 MLD 配置

addr

用于更新网络接口地址的命令

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

选项
--help	显示使用情况信息

子命令
添加	向网络接口添加地址
Del	从网络接口删除地址
等待	等待在网络接口上分配地址。默认情况下等待任何地址；如果指定了 --ipv6，则等待 IPv6 地址。

添加

向网络接口添加地址

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

选项
--help	显示使用情况信息
--no-subnet-route	跳过为此接口和地址添加本地子网路由的步骤

del

从网络接口删除地址

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

选项
--help	显示使用情况信息

等待

等待在网络接口上分配地址。默认情况下等待任何地址；如果指定了 --ipv6，则等待 IPv6 地址。

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

选项
--help	显示使用情况信息
--ipv6	等待 IPv6 地址

桥

可在网络接口之间创建网桥

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

选项
--help	显示使用情况信息

停用

停用网络接口

Usage:  ffx net if disable nicid or name:ifname

选项
--help	显示使用情况信息

enable

用于启用网络接口

Usage:  ffx net if enable nicid or name:ifname

选项
--help	显示使用情况信息

get

查询网络接口

Usage:  ffx net if get nicid or name:ifname

选项
--help	显示使用情况信息

Gmp

获取或设置 IGMP 配置

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

选项
--help	显示使用情况信息

子命令
获取	获取接口的 IGMP 配置
设置	为接口设置 IGMP 配置

get

获取接口的 IGMP 配置

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

选项
--help	显示使用情况信息

set

为接口设置 IGMP 配置

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

选项
--help	显示使用情况信息
--version	要执行的 IGMP 的版本

ip-forward

获取或设置接口的 IP 转发

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

选项
--help	显示使用情况信息

子命令
获取	获取接口的 IP 转发
设置	为接口设置 IP 转发

get

获取接口的 IP 转发

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

选项
--help	显示使用情况信息

set

为接口设置 IP 转发

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

选项
--help	显示使用情况信息

list

列出网络接口（支持 ffx 机器输出）

Usage:  ffx net if list [name_pattern]

选项
--help	显示使用情况信息

MLD

获取或设置 MLD 配置

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

选项
--help	显示使用情况信息

子命令
获取	获取接口的 MLD 配置
设置	为接口设置 MLD 配置

get

获取接口的 MLD 配置

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

选项
--help	显示使用情况信息

set

为接口设置 MLD 配置

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

选项
--help	显示使用情况信息
--version	要执行的 MLD 版本。

log

命令

Usage:  ffx net log [subcommand...]

选项
--help	显示使用情况信息

子命令
set-packets	到 stdout 的日志数据包

set-packets

到 stdout 的日志数据包

Usage:  ffx net log set-packets enabled

选项
--help	显示使用情况信息

迁移

控制用于从 netstack2 迁移到 netstack3 的 netstack 选择

Usage:  ffx net migration [subcommand...]

选项
--help	显示使用情况信息

子命令
清除	清除用于迁移配置的 netstack 版本。
获取	输出当前配置的 netstack 版本以进行迁移。
设置	将下次启动时的 netstack 版本设置为

清除

清除用于迁移配置的 netstack 版本。

Usage:  ffx net migration clear

选项
--help	显示使用情况信息

get

输出当前配置的 netstack 版本以进行迁移。

Usage:  ffx net migration get

选项
--help	显示使用情况信息

set

将下次启动时的 netstack 版本设置为 |ns2| 或 |ns3|。

Usage:  ffx net migration set version

选项
--help	显示使用情况信息

呼哧

相邻表命令

Usage:  ffx net neigh [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	向相邻表添加一个条目
清除	从相邻表中移除与网络接口关联的所有条目
配置	命令（适用于 Neighbor Unreachability Detection 配置）
Del	从相邻表中移除条目
列表	列出相邻表条目（支持 ffx 机器输出）
观看	监控相邻表条目的状态变化（支持 ffx 机器输出）

添加

向相邻表添加一个条目

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

选项
--help	显示使用情况信息

清除

从相邻表中移除与网络接口关联的所有条目

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

选项
--help	显示使用情况信息

配置

命令（适用于 Neighbor Unreachability Detection 配置）

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

选项
--help	显示使用情况信息

子命令
获取	返回所提供界面的当前 NUD 配置选项
更新	用于更新所提供界面的当前 NUD 配置选项

get

返回所提供界面的当前 NUD 配置选项

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

选项
--help	显示使用情况信息

update

用于更新所提供界面的当前 NUD 配置选项

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

选项
--help	显示使用情况信息
--base-reachable-time	一个基本时长（以纳秒为单位），用于计算随机到达时间

del

从相邻表中移除条目

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

选项
--help	显示使用情况信息

list

列出相邻表条目（支持 ffx 机器输出）

Usage:  ffx net neigh list

选项
--help	显示使用情况信息

手表

监控相邻表条目的状态变化（支持 ffx 机器输出）

Usage:  ffx net neigh watch

选项
--help	显示使用情况信息

路线

命令

Usage:  ffx net route [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	向路由表添加路由
Del	从路由表中删除路由
列表	列出设备（支持 ffx 机器输出）

添加

向路由表添加路由

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

选项
--help	显示使用情况信息
--destination	目标广告网络的网络 ID
--netmask	与目的地对应的网络掩码或前缀长度
--网关	第一个跃点路由器的 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>]

选项
--help	显示使用情况信息
--destination	目标广告网络的网络 ID
--netmask	与目的地对应的网络掩码或前缀长度
--网关	第一个跃点路由器的 IP 地址
--nicid	路由的传出网络接口
--metric	该路由的指标

list

列出设备（支持 ffx 机器输出）

Usage:  ffx net route list

选项
--help	显示使用情况信息

平台

管理平台构建前提条件

Usage:  ffx platform [subcommand...]

选项
--help	显示使用情况信息

子命令
预检	评估对于构建和运行 Fuchsia 的适用性

预检

评估对于构建和运行 Fuchsia 的适用性

Usage:  ffx platform preflight [--json]

选项
--help	显示使用情况信息
--json	输出 json 而不是人类可读的文本。

产品

查找和访问商品套装元数据和图片数据。

Usage:  ffx product [subcommand...]

选项
--help	显示使用情况信息

子命令
创建	使用 Product Assembly 的输出创建商品套装。
下载	检索图片数据。
get-artifacts	获取商品包内一组工件的路径。
get-image-path	根据类型和广告位获取商品套装中图片的路径。
get-Repository	获取商品包中的仓库信息。
get-version	获取套装的商品版本。
列表	检索 PB 数据。
查询	检索图片数据。
节目	显示商品套装内的详细信息列表。

create

使用 Product Assembly 的输出创建商品套装。

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>]

选项
--help	显示使用情况信息
--product-name	product.board 标签。例如“workstation_eng.x64”。
--product-version	此 product.board 的唯一版本。
--分区	指向分区配置的路径，其中列出目标的物理分区。
--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	要生成的可选图片大小报告，指示映射到分区时的图片大小。

download

检索图片数据。

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

选项
--help	显示使用情况信息
--force	再次获取相关数据，即使这些数据已存在于本地也是如此。
--auth	对 oauth2 使用特定的身份验证流程（请参阅示例；默认值：pkce）。
--base-url	在哪里可以找到捆绑商品清单
--version	过滤出.
--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

选项
--help	显示使用情况信息
-g、--artifacts-group	选择要列出的工件组
-r、--relative-path	是否返回相对路径

获取映像路径

根据类型和广告位获取商品套装中图片的路径。

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

选项
--help	显示使用情况信息
--slot	图片所在的广告位。
--image-type	图片的类型。
-b、--bootloader	引导加载程序的类型。
-r、--relative-path	是否返回相对路径

获取代码库

获取商品包中的仓库信息。

Usage:  ffx product get-repository product_bundle

选项
--help	显示使用情况信息

get-version

获取套装的商品版本。

Usage:  ffx product get-version product_bundle

选项
--help	显示使用情况信息

list

检索 PB 数据。

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

选项
--help	显示使用情况信息
--auth	对 oauth2 使用特定的身份验证流程（请参阅示例；默认值：pkce）。
--base-url	在哪里可以找到捆绑商品清单
--version	过滤出.
--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

选项
--help	显示使用情况信息
--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

选项
--help	显示使用情况信息
--devices	列出与此商品套装相关联的虚拟设备。
--设备	输出与此商品包关联的虚拟设备的详细信息。

仓库

检查和管理软件包代码库

Usage:  ffx repository [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	让守护程序了解特定的产品包代码库
add-from-pm	让守护程序了解特定的 pm-built 代码库
创建	创建代码库。
默认	管理默认代码库
列表	列出所有代码库
软件包	列出代码库中的软件包
publish	发布软件包。
移除
投放	（实验性）提供代码库服务器，将代码库注册到设备
服务器	检查和管理代码库服务器

添加

让守护程序了解特定的产品包代码库

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

选项
--help	显示使用情况信息
-p、--prefix	代码库的前缀为 NAME。默认设置为 devhost。

从下午添加

让守护程序了解特定的 pm-built 代码库

Usage:  ffx repository add-from-pm [-r <repository>] [--alias <alias...>] pm_repo_path

选项
--help	显示使用情况信息
-r、--repo	将命名为 NAME。默认设置为 devhost。
--alias	在目标上注册此代码库时，将此代码库的别名设置为这些名称。

create

创建代码库。

Usage:  ffx repository create [--time-versioning] [--keys <keys>] repo_path

选项
--help	显示使用情况信息
--time-versioning	根据当前时间设置仓库版本，而不是单调递增的版本
--keys	代码库密钥目录的路径。默认在“repo_path”/keys 中生成密钥。

default

管理默认代码库

Usage:  ffx repository default [subcommand...]

选项
--help	显示使用情况信息

子命令
获取	获取已配置的默认代码库
设置	设置默认代码库
未设置	清除已配置的默认代码库

示例

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

选项
--help	显示使用情况信息

备注

• Returns the default configured repository from the 'User Configuration'.
  Returns an empty string if no default is configured.

set

设置默认代码库

Usage:  ffx repository default set [-l <level>] [-b <build-dir>] name

选项
--help	显示使用情况信息
-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>]

选项
--help	显示使用情况信息
-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

选项
--help	显示使用情况信息

package

列出代码库中的软件包

Usage:  ffx repository package [subcommand...]

选项
--help	显示使用情况信息

子命令
提取-归档	从代码库中提取软件包归档文件
列表	检查和管理软件包代码库
节目	检查软件包的内容

提取-归档

从代码库中提取软件包归档文件

Usage:  ffx repository package extract-archive -o <out> [-r <repository>] package

选项
--help	显示使用情况信息
-o、--out	解压缩的归档文件的输出路径。
-r、--repo	从此代码库中提取软件包

list

检查和管理软件包代码库

Usage:  ffx repository package list [-r <repository>] [--full-hash] [--include-components <include-components>]

选项
--help	显示使用情况信息
-r、--repo	列出此代码库中的软件包。
--full-hash	如果为 true，则将完整显示软件包哈希（即，不会被截断）。
--include-components	切换是否提取每个软件包中的组件并将其显示在输出表中

电视节目

检查软件包的内容

Usage:  ffx repository package show [-r <repository>] [--full-hash] [--include-subpackages <include-subpackages>] package

选项
--help	显示使用情况信息
-r、--repo	列出此代码库中的软件包内容。
--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

选项
--help	显示使用情况信息
--signing-keys	用于对元数据进行签名的密钥的路径，但不信任用于密钥轮替的密钥
--trusted-keys	用于对元数据进行签名和信任的密钥的路径（默认代码库 keys/ 目录）
--trusted-root	初始可信根元数据的路径（默认使用代码库中的 1.root.json）
--package	软件包清单的路径
--package-list	软件包列表清单的路径
--package-archive	指向软件包归档的路径
--product-bundle	指向商品套装的路径
--time-versioning	根据时间设置仓库版本，而不是单调递增的版本
--metadata-current-time	用于查看元数据是否已过期以及新元数据应何时过期的 RFC 3339 时间（默认使用当前时间）
--refresh-root	生成新的根元数据以及所有其他元数据
--clean	清理代码库，以便只保留新发布内容
--depfile	生成一个 depfile 文件
--copy-mode	用于将 blob 复制到代码库的模式。“copy”“copy-overwrite”或“hard-link”（默认为“copy”）。
--delivery-blob-type	要生成的传送 blob 的类型（默认值：type 1）
--watch	文件发生更改时重新发布软件包
--ignore-missing-packages	如果软件包路径不存在，则忽略
--blob-manifest	将 blob 清单写入到的路径
--blob-repo-dir	blob 目录的路径（默认为“$repo_path/repo/blobs”）

移除

Usage:  ffx repository remove name

选项
--help	显示使用情况信息

传送

（实验性）提供代码库服务器，将代码库注册到设备

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]

选项
--help	显示使用情况信息
-r、--repo	注册此代码库。默认值为 devhost。
--address	用于提供代码库的地址。请注意，它可以是 IPV4 或 IPV6。例如，[::]:8083 或 127.0.0.1:8083，默认值为 [::]:8083。
--repo-path	软件包代码库的位置。默认值由从 ffx 上下文获取的 build 目录指定。
--product-bundle	产品套装的位置。
--alias	设置重写规则，将每个 alias 主机映射到 name 标识的代码库。
--storage-type	在重新启动后保留此代码库。默认值为 Ephemeral。
--alias-conflict-mode	别名注册冲突时的解决机制。必须是 error-out 或 replace。默认值为 replace。
--port-path	写入服务器端口信息的位置（以防端口动态实例化）。
--no-device	如果为 true，则不会将代码库注册到设备。默认值为 false。

服务器

检查和管理代码库服务器

Usage:  ffx repository server [subcommand...]

选项
--help	显示使用情况信息

子命令
开始	启动代码库服务器。请注意，ffx repository list 中列出的所有代码库都将作为子路径启动。
状态	检索代码库服务器的状态。如果服务器正在运行，系统还会返回套接字地址。请注意，ffx repository list 下的所有代码库都将在返回的地址处作为子路径运行。
停止	停止代码库服务器

start

启动代码库服务器。请注意，ffx repository list 中列出的所有代码库都将作为子路径启动。

Usage:  ffx repository server start [--address <address>]

选项
--help	显示使用情况信息
--address	用于启动代码库的地址。请注意，它可以是 IPV4 或 IPV6。例如 [::]:8083 或 127.0.0.1:8083

资质

检索代码库服务器的状态。如果服务器正在运行，系统还会返回套接字地址。请注意，ffx repository list 下的所有代码库都将在返回的地址处作为子路径运行。

Usage:  ffx repository server status

选项
--help	显示使用情况信息

停止

停止代码库服务器

Usage:  ffx repository server stop

选项
--help	显示使用情况信息

sdk

修改或查询已安装的 SDK

Usage:  ffx sdk [subcommand...]

选项
--help	显示使用情况信息

子命令
填充路径	使用指向 fuchsha-sdk-run 工具的符号链接填充给定路径，以运行特定于项目的 SDK 工具
run	从活跃 SDK 运行主机工具
设置	设置与 SDK 相关的配置选项
版本	检索当前 SDK 的版本

填充路径

使用指向 fuchsha-sdk-run 工具的符号链接填充给定路径，以运行特定于项目的 SDK 工具

Usage:  ffx sdk populate-path path

选项
--help	显示使用情况信息

run

从活跃 SDK 运行主机工具

Usage:  ffx sdk run name args

选项
--help	显示使用情况信息

set

设置与 SDK 相关的配置选项

Usage:  ffx sdk set [subcommand...]

选项
--help	显示使用情况信息

子命令
根	设置首选 SDK 的根目录的路径

根

设置首选 SDK 的根目录的路径

Usage:  ffx sdk set root path

选项
--help	显示使用情况信息

version

检索当前 SDK 的版本

Usage:  ffx sdk version

选项
--help	显示使用情况信息

会话

控制会话组件。

Usage:  ffx session [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	向当前会话添加一个元素。

如果使用了 --persist 选项，则软件包应位于基础软件包或缓存软件包中，否则它可能会在重新启动后无法启动。| launch | 启动会话组件。 | remove | 从当前会话中移除元素。

永久性元素将被永久移除。元素使用的任何永久性存储空间都不会被移除。| restart | 重启当前会话组件。 | 显示 | 显示当前会话的相关信息 | start | 启动默认会话组件。 | stop | 停止会话组件。

备注

• See https://fuchsia.dev/fuchsia-src/glossary#session-component.

添加

向当前会话添加一个元素。

如果使用了 --persist 选项，则软件包应位于基础软件包或缓存软件包中，否则它可能会在重新启动后无法启动。

Usage:  ffx session add [--interactive] [--persist] [--name <name>] url

选项
--help	显示使用情况信息
--互动式	传递即可使元素在命令退出之前保持活动状态
--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

选项
--help	显示使用情况信息

示例

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

移除

从当前会话中移除某个元素。

永久性元素将被永久移除。元素使用的任何永久性存储空间都不会被移除。

Usage:  ffx session remove name

选项
--help	显示使用情况信息

重启

重启当前会话组件。

Usage:  ffx session restart

选项
--help	显示使用情况信息

备注

• 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

选项
--help	显示使用情况信息

start

启动默认会话组件。

Usage:  ffx session start

选项
--help	显示使用情况信息

备注

• The default session component is specified by the URL session_urlin session_manager's structured configuration.

停止

停止会话组件。

Usage:  ffx session stop

选项
--help	显示使用情况信息

目标值

与目标设备或模拟器交互

Usage:  ffx target [subcommand...]

选项
--help	显示使用情况信息

子命令
添加	让守护程序知道特定目标
引导加载程序	与引导加载程序通信
clear-preferred-ssh-address	清除之前配置的 SSH 地址
默认	管理默认目标
echo	针对目标运行 echo 测试
闪光灯	将映像刷写到目标设备
get-ssh-address	获取目标的 SSH 地址
获取时间	获取目标设备上的单调时间
列表	列出所有目标
关闭	关闭目标电源
重新启动	重新启动目标
移除	让守护程序忘记特定目标
代码库	与目标代码库注册交互
屏幕截图	对目标进行屏幕截图
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.

添加

让守护程序知道特定目标

Usage:  ffx target add [-n] addr

选项
--help	显示使用情况信息
-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...]

选项
--help	显示使用情况信息
-m、--manifest	刷写包含映像和清单的清单或 ZIP 文件的路径
-p、--product	清单中的商品条目 - 默认为 fuchsia
-b、--product-bundle	（可选）商品套装名称
--skip-verify	跳过硬件验证。这很危险，请确保您使用的图片与设备相符

子命令
启动	RAM 启动一个 fastboot 目标。
信息	输出目标的 fastboot 变量。
锁定	锁定 fastboot 目标。
解锁	解锁 fastboot 目标。

boot

RAM 启动一个 fastboot 目标。

Usage:  ffx target bootloader boot [-z <zbi>] [-v <vbmeta>] [-s <slot>]

选项
--help	显示使用情况信息
-z、--zbi	要使用的可选 Zbi 图片文件路径
-v、--vbmeta	要使用的 vbmeta 图片文件路径（可选）
-s、--slot	与 Flash 清单中的分区相对应的插槽 -

仅在不存在 zbi 和 vbmeta 文件时使用

信息

输出目标的 fastboot 变量。

Usage:  ffx target bootloader info

选项
--help	显示使用情况信息

锁定

锁定 fastboot 目标。

Usage:  ffx target bootloader lock

选项
--help	显示使用情况信息

解锁

解锁 fastboot 目标。

Usage:  ffx target bootloader unlock [-c <cred>] [--force]

选项
--help	显示使用情况信息
-c、--cred	用于解锁设备的凭据文件的可选路径
--force	跳过有关此命令危险的警告消息

clear-preferred-ssh-address

清除之前配置的 SSH 地址

Usage:  ffx target clear-preferred-ssh-address

选项
--help	显示使用情况信息

备注

• 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.

default

管理默认目标

Usage:  ffx target default [subcommand...]

选项
--help	显示使用情况信息

子命令
获取	获取已配置的默认目标
设置	设置默认目标
未设置	清除已配置的默认目标

示例

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>]

选项
--help	显示使用情况信息
-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.

set

设置默认目标

Usage:  ffx target default set [-l <level>] [-b <build-dir>] nodename

选项
--help	显示使用情况信息
-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>]

选项
--help	显示使用情况信息
-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]

选项
--help	显示使用情况信息
--重复	重复运行 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]

选项
--help	显示使用情况信息
-p、--product	清单中的商品条目 - 默认为 fuchsia
-b、--product-bundle	（可选）商品套装名称
-m、--manifest	可选的清单路径
--oem-stage	OEM 暂存文件 - 可多次提供
--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>]

选项
--help	显示使用情况信息
-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 地址

CANNOT TRANSLATE

获取目标设备上的单调时间

Usage:  ffx target get-time

选项
--help	显示使用情况信息

示例

To get the target time:

    $ ffx target get-time

list

列出所有目标

Usage:  ffx target list [-f <format>] [--no-ipv4] [--no-ipv6] [nodename]

选项
--help	显示使用情况信息
-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”列会显示该定位条件的宣传名称。当目标处于前期启动状态（例如 fastboot）时，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

已关闭

关闭目标电源

Usage:  ffx target off

选项
--help	显示使用情况信息

备注

• 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]

选项
--help	显示使用情况信息
-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	关闭目标时超时。

移除

让守护程序忘记特定目标

Usage:  ffx target remove name_or_addr

选项
--help	显示使用情况信息

示例

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...]

选项
--help	显示使用情况信息

子命令
取消注册	让目标忘记特定代码库
列表	列出目标上的所有代码库
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>]

选项
--help	显示使用情况信息
-r、--repo	从目标中移除名为 name 的代码库，而不是从默认代码库中移除。

list

列出目标上的所有代码库

Usage:  ffx target repository list

选项
--help	显示使用情况信息

register

让目标知道特定代码库

Usage:  ffx target repository register [-r <repository>] [--storage-type <storage-type>] [--alias <alias...>] [--alias-conflict-mode <alias-conflict-mode>]

选项
--help	显示使用情况信息
-r、--repo	注册此代码库，而不是注册默认的代码库。
--storage-type	在重新启动后保留此代码库。
--alias	设置重写规则，将每个 alias 主机映射到 name 标识的代码库。
--alias-conflict-mode	别名注册冲突时的解决机制。必须是 error-out 或 replace。默认值为 replace。

屏幕截图

对目标进行屏幕截图

Usage:  ffx target screenshot [-d <dir>] [--format <format>]

选项
--help	显示使用情况信息
-d、--dir	替换用于保存屏幕截图的默认目录
--format	屏幕截图格式。如果未提供任何值，将使用 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

选项
--help	显示使用情况信息

示例

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]

选项
--help	显示使用情况信息
--desc	显示条目说明
--标签	条目的显示标签
--json	将输出的格式设置为 JSON 对象
--version	显示版本

备注

• 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]

选项
--help	显示使用情况信息
-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...]

选项
--help	显示使用情况信息
--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'

update

更新目标上的基本系统软件

Usage:  ffx target update [subcommand...]

选项
--help	显示使用情况信息

子命令
渠道	查看和管理更新渠道
立即检查	检查并执行系统更新操作
强制安装	手动触发系统更新程序

备注

• This command interfaces with system update services on the target.

声道

查看和管理更新渠道

Usage:  ffx target update channel [subcommand...]

选项
--help	显示使用情况信息

子命令
get-current	返回当前配置的更新渠道
获取下一个	返回下一个或目标更新渠道
列表	列出已知更新渠道
设置	设置更新渠道

备注

• 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

选项
--help	显示使用情况信息

备注

• For developer product configurations, this is by default 'devhost'.

错误
1	获取更新渠道超时。

获取下一个

返回下一个或目标更新渠道

Usage:  ffx target update channel get-next

选项
--help	显示使用情况信息

备注

• 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

选项
--help	显示使用情况信息

备注

• 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	获取更新渠道列表时超时。

set

设置更新渠道

Usage:  ffx target update channel set channel

选项
--help	显示使用情况信息

示例

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]

选项
--help	显示使用情况信息
--service-initiated	更新检查由服务在后台启动。
--monitor	监控状态更新。

示例

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

选项
--help	显示使用情况信息
--reboot	自动触发重新启动到新系统

示例

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]

选项
--help	显示使用情况信息
-t、--timeout	超时秒数 [默认值 = 120]。值为 0 表示没有超时。
-d、--down	等待目标值下降

错误
1	获取 SSH 地址时超时

version

输出 ffx 工具和守护程序版本

Usage:  ffx version [-v]

选项
--help	显示使用情况信息
-v、--verbose	如果为 true，则包含有关 ffx 和守护程序的详细信息