共用方式為

sfctl node

管理构成群集的节点。

命令

命令 说明
add-configuration-parameter-overrides 添加指定节点上的配置替代列表。
停用 使用指定的停用意向停用服务Fabric群集节点。
启用 激活当前已停用的服务Fabric群集节点。
get-configuration-overrides 获取指定节点上的配置替代列表。
健康状况 获取服务Fabric节点的运行状况。
info 获取有关服务Fabric群集中特定节点的信息。
list 获取服务Fabric群集中的节点列表。
加载 获取服务Fabric节点的加载信息。
remove-configuration-overrides 删除指定节点上的配置替代。
remove-state 通知服务Fabric永久删除或丢失节点上的持久状态。
report-health 在服务Fabric节点上发送运行状况报告。
重启 重启服务Fabric群集节点。
转换 启动或停止群集节点。
transition-status 获取使用 StartNodeTransition 启动的操作的进度。

sfctl 节点 add-configuration-parameter-overrides

添加指定节点上的配置替代列表。

此 API 允许在指定节点上添加所有现有配置替代。

参数

Argument 说明
--config-parameter-override-list [必需] 添加配置替代列表的说明。
--node-name [必需] 节点的名称。
--force 强制添加指定节点上的配置替代。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node disable

使用指定的停用意向停用服务Fabric群集节点。

使用指定的停用意向停用服务Fabric群集节点。 在停用的过程中，可以提高而不能降低停用意图（例如，根据 Pause 意图停用的节点可以进一步根据 Restart 停用，但反过来不行）。 在节点停用后，随时可以使用“激活节点”操作重新激活节点。 如果停用未完成，这将取消停用。 在已关闭并在停用状态下恢复启动的节点上放置服务之前，仍需重新激活该节点，

参数

Argument 说明
--node-name [必需] 节点的名称。
--deactivation-intent 描述停用节点的意图或原因。 可能的值如下。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node enable

激活当前已停用的服务Fabric群集节点。

激活当前已停用的服务Fabric群集节点。 激活后，该节点将成为再次放置新副本的可行目标，并重新激活节点上剩余的任何已停用副本。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl 节点 get-configuration-overrides

获取指定节点上的配置替代列表。

此 API 允许获取指定节点上的所有现有配置替代。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node health

获取服务Fabric节点的运行状况。

获取服务Fabric节点的运行状况。 使用 EventsHealthStateFilter 可以根据运行状态筛选针对节点报告的运行状况事件的集合。 如果按名称指定的节点在运行状况存储中不存在，则返回错误。

参数

Argument 说明
--node-name [必需] 节点的名称。
--events-health-state-filter 用于根据运行状况筛选返回的 HealthEvent 对象集合。 此参数的可能值包括以下运行状态之一的整数值。 仅返回与筛选器匹配的事件。 所有事件用于评估聚合运行状态。 如果未指定，则返回所有项。 状态值为基于标志的枚举，因此该值可以是使用按位“OR”运算符获取的值的组合。 例如，如果提供的值为 6，则返回 HealthState 值为 OK (2) 和 Warning (4) 的所有事件。
- Default - 默认值。 匹配任何 HealthState。 值为 0。
- None - 不与任何 HealthState 值匹配的筛选器。 未返回有关给定状态集合的结果时使用。 值为 1。
- Ok - 与 HealthState 值为 OK 的输入匹配的筛选器。 值为 2。
- Warning - 与 HealthState 值为 Warning 的输入匹配的筛选器。 值为 4。
- Error - 与 HealthState 值为 Error 的输入匹配的筛选器。 值为 8。
- All - 与具有任意 HealthState 值的输入匹配的筛选器。 值为 65535。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node info

获取有关服务Fabric群集中特定节点的信息。

响应包括有关节点的名称、状态、ID、运行状况、运行时间和其他详细信息。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node list

获取服务Fabric群集中的节点列表。

响应包括有关节点的名称、状态、ID、运行状况、运行时间和其他详细信息。

参数

Argument 说明
--continuation-token 继续标记参数用于获取下一组结果。 当系统的结果不适合单个响应时，API 响应中将包含具有无空值的延续令牌。 当此值传递到下一个 API 调用时，API 返回下一组结果。 如果没有进一步的结果，则继续标记不包含值。 不应对此参数的值进行 URL 编码。
--max-results 作为分页查询的一部分返回的最大结果数。 此参数定义返回结果数的上限。 如果返回的结果不符合配置中定义的最大消息大小限制，则返回的结果可能小于指定的最大结果。 如果此参数为零或者未指定，则分页查询包含返回消息中最多可容纳的结果数。
--node-status-filter 用于根据 NodeStatus 筛选节点。 仅返回与指定筛选器值匹配的节点。 筛选器值可以是下列项之一。 默认值：default。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node load

获取服务Fabric节点的加载信息。

检索已定义负载或容量的所有指标的服务Fabric节点的负载信息。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl 节点 remove-configuration-overrides

删除指定节点上的配置替代。

此 API 允许删除指定节点上的所有现有配置替代。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node remove-state

通知服务Fabric永久删除或丢失节点上的持久状态。

这意味着无法恢复该节点的持久状态。 如果硬盘被擦除干净，或者硬盘崩溃，通常会发生这种情况。 节点必须已关闭，此操作才能成功。 此操作可让 Service Fabric知道该节点上的副本不再存在，并且服务Fabric应停止等待这些副本恢复。 如果节点上的状态尚未删除，并且节点可以备份其状态不变，请不要运行此 cmdlet。 从服务Fabric 6.5 开始，若要将此 API 用于种子节点，请将种子节点更改为常规（非种子）节点，然后调用此 API 以删除节点状态。 如果群集在Azure上运行，则种子节点关闭后，服务Fabric将尝试将其自动更改为非种子节点。 若要执行此操作，请确保主节点类型中的非种子节点数不小于向下种子节点的数量。 如果需要，请将更多节点添加到主节点类型以实现这一目标。 对于独立群集，如果预计向下种子节点不会恢复其状态不变，请从群集中删除节点。 有关详细信息，请参阅 向在 Windows Server0 上运行的独立服务Fabric群集添加或删除节点。

参数

Argument 说明
--node-name [必需] 节点的名称。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node report-health

在服务Fabric节点上发送运行状况报告。

报告指定服务Fabric节点的运行状况状态。 报告必须包含有关其报告的运行状况报告源和属性的信息。 报告将发送到服务Fabric网关节点，该节点将转发到运行状况存储。 该报告可能被网关接受但被运行状况存储在执行额外的验证后拒绝。 例如，运行状况存储可能会由于无效的参数（如过时的序列号）而拒绝该报告。 若要了解该报告是否已应用于运行状况存储中，请检查该报告是否显示在 HealthEvents 部分中。

参数

Argument 说明
--health-property [必需] 运行状况信息的属性。

一个实体可以有不同属性的运行状况报告。 该属性是一个字符串，不是固定的枚举，因此可使报告器灵活地对触发报告的状态条件进行分类。 例如，SourceId 为“LocalWatchdog”的报告器可以监视节点上的可用磁盘的状态，因此它可以报告该节点的“AvailableDisk”属性。 同一报告器可以监视节点连接，因此它可以报告同一节点的“Connectivity”属性。 在运行状况存储中，这些报告均被视为指定节点的单独运行状况事件。 与 SourceId 一起，该属性唯一地标识运行状况信息。
--health-state [必需] 可能的值包括：“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”。
--node-name [必需] 节点的名称。
--source-id [必需] 标识已生成运行状况信息的客户端/监视程序/系统组件的源名称。
--description 运行状况信息的说明。

它表示用于添加有关该报告的用户可读信息的自定义文本。 说明的最大字符串长度为 4,096 个字符。 如果提供的字符串较长，则会自动截断。 截断时，说明的最后一个字符包含标记“[截断]”，总字符串大小为 4,096 个字符。 该标记的存在向用户指示截断已发生。 截断时，说明的原始字符串中少于 4,096 个字符。
--immediate 一个用于指示是否应立即发送报告的标志。

运行状况报告将发送到服务Fabric网关应用程序，该应用程序将转发到运行状况存储。 如果 Immediate 设置为 true，则报告将立即从 HTTP 网关发送至运行状况存储，而无论 HTTP 网关应用程序使用的 Fabric 客户端设置如何。 这对于应尽快发送的关键报告十分有用。 由于计时和其他情况，发送报告可能仍会失败，例如，在 HTTP 网关已关闭或消息无法到达网关的情况下。 如果 Immediate 设置为 false，则报告将基于来自 HTTP 网关的运行状况客户端设置发送。 因此，它根据 HealthReportSendInterval 配置进行批处理。 这是建议的设置，因为它可让运行状况客户端优化发往运行状况存储的运行状况报告消息以及运行状况报告处理。 默认情况下，不会立即发送报表。
--remove-when-expired 该值指示是否在报告过期时从运行状况存储删除该报告。

如果设置为 true，报告在过期后将从运行状况存储中删除。 如果设置为 false，报告在过期时将被视为错误。 此属性的值在默认情况下为 false。 当客户端定期报告时，它们应将 RemoveWhenExpired 设置为 false（默认值）。 这样，如果记者有问题（例如死锁），并且无法报告，则当运行状况报告过期时，会以错误方式评估实体。 这会将该实体标记为处于“Error”运行状况状态。
--sequence-number 此运行状况报告的序列号（采用数字字符串形式）。

报告序列号由运行状况存储用来检测过时的报告。 如果未指定，则添加报表时，运行状况客户端自动生成序列号。
--timeout -t 默认值：60。
--ttl 此运行状况报告保持有效的持续时间。 此字段将 ISO8601 格式用于指定该持续时间。

当客户端定期报告时，它们应以高于生存时间的频率发送报告。 如果客户端以非定期的方式报告，它们可以将生存时间设置为无限。 生存时间过期时，包含运行状况信息的运行状况事件将从运行状况存储中删除（如果 RemoveWhenExpired 为 true），或者将会评估为处于错误状态（如果 RemoveWhenExpired 为 false）。 如果未指定，生存时间将默认为无限值。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node restart

重启服务Fabric群集节点。

重启服务Fabric已启动的群集节点。

参数

Argument 说明
--node-name [必需] 节点的名称。
--create-fabric-dump 指定 True 会创建结构节点进程的转储。 此参数区分大小写。 默认值：False。
--node-instance-id 目标节点的实例 ID。 如果指定了实例 ID，则仅当该 ID 与节点的当前实例匹配时，才重启该节点。 默认值“0”会匹配任何实例 ID。 可以使用 get node 查询获取实例 ID。 默认值：0。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node transition

启动或停止群集节点。

启动或停止群集节点。 群集节点是一个进程，而不是 OS 实例本身。 若要启动节点，请为 NodeTransitionType 参数传入“Start”。 若要停止节点，请为 NodeTransitionType 参数传入“Stop”。 此 API 启动操作 - API 返回时，节点可能尚未完成转换。 结合相同的 OperationId 调用 GetNodeTransitionProgress 可获取操作进度。

参数

Argument 说明
--node-instance-id [必需] 目标节点的节点实例 ID。 可通过 GetNodeInfo API 确定此信息。
--node-name [必需] 节点的名称。
--node-transition-type [必需] 指示要执行的转换类型。 NodeTransitionType.Start 启动已停止的节点。 NodeTransitionType.Stop 停止启动的节点。
--operation-id [必需] 用于标识此 API 的调用的 GUID。 需将此参数传入相应的 GetProgress API。
--stop-duration-in-seconds [必需] 使节点保持停止状态的持续时间，以秒为单位。 最小值为 600。 最大值为 14400。 此时间过后，节点将自动恢复启动状态。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl node transition-status

获取使用 StartNodeTransition 启动的操作的进度。

使用提供的 OperationId 获取通过 StartNodeTransition 启动的操作的进度。

参数

Argument 说明
--node-name [必需] 节点的名称。
--operation-id [必需] 用于标识此 API 的调用的 GUID。 需将此参数传入相应的 GetProgress API。
--timeout -t 执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。 默认值：60。

全局参数

Argument 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--query JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

后续步骤

  • Setup Service Fabric CLI。
  • 了解如何使用 sample 脚本使用 Service Fabric CLI。
  • Last updated on