sfctl node
管理構成叢集的節點。
命令
| 命令 | 描述 |
|---|---|
| add-configuration-parameter-overrides | 新增指定節點上的組態覆寫清單。 |
| disable | 停用具有指定停用意圖的 Service Fabric 叢集節點。 |
| enable | 啟動目前停用的 Service Fabric 叢集節點。 |
| get-configuration-overrides | 取得指定節點上的組態覆寫清單。 |
| health | 取得 Service Fabric 節點的健康情況。 |
| 資訊 | 取得 Service Fabric 叢集中特定節點的相關信息。 |
| 清單 | 取得 Service Fabric 叢集中的節點清單。 |
| 負載 | 取得 Service Fabric 節點的載入資訊。 |
| remove-configuration-overrides | 拿掉指定節點上的組態覆寫。 |
| remove-state | 通知 Service Fabric 已永久移除或遺失節點上的保存狀態。 |
| report-health | 在 Service Fabric 節點上傳送健康情況報告。 |
| restart | 重新啟動 Service Fabric 叢集節點。 |
| 轉換 | 啟動或停止叢集節點。 |
| transition-status | 取得使用 StartNodeTransition 啟動之作業的進度。 |
sfctl node 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。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node disable
停用具有指定停用意圖的 Service Fabric 叢集節點。
停用具有指定停用意圖的 Service Fabric 叢集節點。 一旦停用進行中，可以增加停用意圖，但不會減少（例如，使用 Pause 意圖停用的節點可以透過重新啟動進一步停用，但不是另一種方式。 節點可能會在停用之後，隨時使用啟用節點作業來重新啟用。 如果停用未完成，這會取消停用。 在停用時關閉並備份的節點，仍然需要重新啟用，才能在該節點上放置服務。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --deactivation-intent | 描述停用節點的意圖或原因。 可能的值如下。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node enable
啟動目前停用的 Service Fabric 叢集節點。
啟動目前停用的 Service Fabric 叢集節點。 啟用之後，節點會再次成為放置新複本的可行目標，而且會重新啟用節點上剩餘的任何已停用複本。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node get-configuration-overrides
取得指定節點上的組態覆寫清單。
此 API 允許在指定的節點上取得所有現有的組態覆寫。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node health
取得 Service Fabric 節點的健康情況。
取得 Service Fabric 節點的健康情況。 使用 EventsHealthStateFilter，根據健康情況狀態篩選節點上報告的健康情況事件集合。 如果您依名稱指定的節點不存在於健康狀態存放區中，則會傳回錯誤。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --events-health-state-filter | 允許根據健康情況狀態篩選傳回的HealthEvent物件集合。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選的事件。 所有事件都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的所有事件。 - 預設值 - 預設值。 符合任何 HealthState。 值為零。 - 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。 - 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。 - 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。 - 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。 - 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node info
取得 Service Fabric 叢集中特定節點的相關信息。
回應包含節點的名稱、狀態、標識碼、健康情況、運行時間和其他詳細數據。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node list
取得 Service Fabric 叢集中的節點清單。
回應包含節點的名稱、狀態、標識碼、健康情況、運行時間和其他詳細數據。
引數
| Argument | 描述 |
|---|---|
| --continuation-token | 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。 |
| --max-results | 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。 |
| --node-status-filter | 允許根據 NodeStatus 篩選節點。 只會傳回符合指定篩選值的節點。 篩選值可以是下列其中一項。 預設值：預設值。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node load
取得 Service Fabric 節點的載入資訊。
針對已定義負載或容量的所有計量，擷取 Service Fabric 節點的載入資訊。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node remove-configuration-overrides
拿掉指定節點上的組態覆寫。
此 API 允許移除指定節點上的所有現有組態覆寫。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node remove-state
通知 Service Fabric 已永久移除或遺失節點上的保存狀態。
這表示無法復原該節點的保存狀態。 如果硬碟已清除，或硬碟當機，通常會發生這種情況。 節點必須關閉，此作業才能成功。 此作業可讓 Service Fabric 知道該節點上的複本已不存在，而且 Service Fabric 應該停止等候這些複本重新出現。 如果未移除節點上的狀態，而且節點可以完整備份其狀態，請勿執行此 Cmdlet。 從 Service Fabric 6.5 開始，若要將此 API 用於種子節點，請將種子節點變更為一般（非種子）節點，然後叫用此 API 以移除節點狀態。 如果叢集在 Azure 上執行，在種子節點關閉之後，Service Fabric 會嘗試將它自動變更為非種子節點。 若要發生這種情況，請確定主要節點類型中的非種子節點數目不小於 Down 種子節點的數目。 如有必要，請將更多節點新增至主要節點類型，以達成此目的。 針對獨立叢集，如果向下種子節點不預期會完整備份其狀態，請從叢集中移除節點。 如需詳細資訊，請參閱 將節點新增或移除至在 Windows Server 上執行的獨立 Service Fabric 叢集。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node report-health
在 Service Fabric 節點上傳送健康情況報告。
報告指定 Service Fabric 節點的健康情況狀態。 報表必須包含其報告之健康情況報告來源和屬性的相關信息。 報告會傳送至 Service Fabric 網關節點，該節點會轉送至健康狀態存放區。 網關可以接受報告，但在額外的驗證之後，健康狀態存放區會拒絕。 例如，健康狀態存放區可能會因為無效的參數而拒絕報告，例如過時的序號。 若要查看報表是否已套用在健康狀態存放區中，請檢查報告是否出現在 HealthEvents 區段中。
引數
| Argument | 描述 |
|---|---|
| --health-property [必要] | 健康情況信息的屬性。 實體可以有不同屬性的健康情況報告。 屬性是字串，而不是固定列舉，可讓記者彈性地分類觸發報表的狀態條件。 例如，具有SourceId「LocalWatchdog」 的記者可以監視節點上可用磁碟的狀態，以便報告該節點上的 「AvailableDisk」 屬性。 相同的記者可以監視節點連線能力，因此它可以報告相同節點上的屬性「連線能力」。 在健康狀態存放區中，這些報告會被視為指定節點的個別健康情況事件。 屬性與SourceId一起，可唯一識別健康情況資訊。 |
| --health-state [必要] | 可能的值包括：『Invalid』、『Ok』、『Warning』、『Error』、『Unknown』。 |
| --node-name [必要] | 節點的名稱。 |
| --source-id [必要] | 識別產生健康情況資訊之用戶端/監視程式/系統元件的來源名稱。 |
| --描述 | 健康情況資訊的描述。 它代表用來新增人類可讀報表資訊的自由文字。 描述的最大字串長度為4096個字元。 如果提供的字串較長，則會自動截斷。 截斷時，描述的最後一個字元包含標記 “[Truncated]”，而字串大小總計為 4096 個字元。 標記的存在表示發生截斷的使用者。 請注意，截斷時，描述的原始字串少於 4096 個字元。 |
| --立即的 | 指出是否應立即傳送報表的旗標。 健康情況報告會傳送至 Service Fabric 閘道應用程式，此應用程式會轉送至健康狀態存放區。 如果 Immediate 設定為 true，則不論 HTTP 閘道應用程式所使用的網狀架構客戶端設定為何，報表都會立即從 HTTP 閘道傳送至健康狀態存放區。 這對於應儘快傳送的重要報告很有用。 根據計時和其他條件，傳送報告可能仍然失敗，例如，如果 HTTP 閘道已關閉或訊息未連線到閘道。 如果 [即時運算] 設定為 false，則會根據 HTTP 閘道的健康情況客戶端設定來傳送報告。 因此，它會根據 HealthReportSendInterval 組態進行批處理。 這是建議的設定，因為它可讓健康情況用戶端將健康情況報告訊息優化到健康狀態存放區，以及健康情況報告處理。 根據預設，報表不會立即傳送。 |
| --remove-when-expired | 值，指出報表在到期時是否從健康狀態存放區中移除。 如果設定為 true，報表會在到期後從健康狀態存放區中移除。 如果設定為 false，報表會在過期時被視為錯誤。 此屬性的值預設為 false。 當用戶端定期報告時，應該設定 RemoveWhenExpired false （預設值）。 如此一來，記者有問題（例如死結）且無法報告，實體會在健康情況報告到期時評估為錯誤。 這會將實體標示為處於錯誤健康狀態。 |
| --sequence-number | 此健康情況報告的序號為數值字串。 健康狀態存放區會使用報表序號來偵測過時的報告。 如果未指定，當加入報表時，健康情況用戶端會自動產生序號。 |
| --timeout -t | 預設值：60。 |
| --ttl | 此健康情況報告有效的持續時間。 此欄位會使用ISO8601格式來指定持續時間。 當用戶端定期報告時，他們應該傳送頻率高於存留時間的報告。 如果客戶端回報轉換，他們可以將存留時間設定為無限。 存留時間到期時，如果 RemoveWhenExpired 為 true，則會從健康狀態存放區移除包含健康情況資訊的健全狀況事件，如果 RemoveWhenExpired false，則會在錯誤時進行評估。 如果未指定，存留時間預設為無限值。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node restart
重新啟動 Service Fabric 叢集節點。
重新啟動已啟動的 Service Fabric 叢集節點。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --create-fabric-dump | 指定 True 以建立網狀架構節點進程的傾印。 這是區分大小寫的。 預設值：False。 |
| --node-instance-id | 目標節點的實例識別碼。 如果指定實例標識碼，則只有在節點與節點的目前實例相符時，才會重新啟動節點。 預設值 “0” 會符合任何實例標識碼。 您可以使用取得節點查詢來取得實例識別碼。 預設：0。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl node transition
啟動或停止叢集節點。
啟動或停止叢集節點。 叢集節點是進程，而不是OS實例本身。 若要啟動節點，請傳入 NodeTransitionType 參數的 “Start”。 若要停止節點，請傳入 NodeTransitionType 參數的 “Stop”。 此 API 會啟動作業 - 當 API 傳回節點可能尚未完成轉換時。 使用相同的 OperationId 呼叫 GetNodeTransitionProgress，以取得作業的進度。
引數
| Argument | 描述 |
|---|---|
| --node-instance-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。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://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。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |