sfctl replica

Ermöglicht es, Replikate zu verwalten, die zu Servicepartitionen gehören.

Befehle

Befehl	BESCHREIBUNG
deployed	Ruft die Details eines Replikats ab, das auf einem Service Fabric-Knoten bereitgestellt wird.
deployed-list	Ruft die Liste der Replikate ab, die auf einem Service Fabric-Knoten bereitgestellt werden.
health	Ruft die Integrität eines zustandsbehafteten Service Fabric-Dienstreplikats oder einer zustandslosen Service Fabric-Dienstinstanz ab.
info	Ruft die Informationen zu einem Replikat einer Service Fabric-Partition ab.
list	Ruft die Informationen zu Replikaten einer Service Fabric-Dienstpartition ab.
remove	Entfernt ein Dienstreplikat, das auf einem Knoten ausgeführt wird.
report-health	Sendet einen Integritätsbericht zu dem Service Fabric-Replikat.
restart	Startet ein Dienstreplikat eines permanenten Diensts neu, das auf einem Knoten ausgeführt wird.

sfctl replica deployed

Ruft die Details eines Replikats ab, das auf einem Service Fabric-Knoten bereitgestellt wird.

Ruft die Details des Replikats ab, das auf einem Service Fabric-Knoten bereitgestellt wird. Die Informationen umfassen Dienstart, Dienstname, aktueller Dienstvorgang, Startzeitpunkt des aktuellen Dienstvorgangs, Partitions-ID, Replikat/Instanz-ID, gemeldete Last und weitere Informationen.

Argumente

Argument	BESCHREIBUNG
--node-name [erforderlich]	Der Name des Knotens.
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [Erforderlich]	Der Bezeichner (ID) des Replikats.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica deployed-list

Ruft die Liste der Replikate ab, die auf einem Service Fabric-Knoten bereitgestellt werden.

Ruft die Liste mit den Informationen über die Replikate ab, die auf einem Service Fabric-Knoten bereitgestellt sind. Die Informationen umfassen Partitions-ID, Replikat-ID, Status des Replikats, Name des Diensts, Name des Diensttyps und andere Informationen. Verwenden Sie die Abfrageparameter „PartitionId“ oder „ServiceManifestName“, um Informationen über die bereitgestellte Replikate zurückzugeben, die den angegebenen Werten für diese Parameter entsprechen.

Argumente

Argument	BESCHREIBUNG
--application-id [erforderlich]	Die Identität (ID) der Anwendung. Dies ist üblicherweise der vollständige Name der Anwendung ohne das URI-Schema „fabric:“. Ab Version 6.0 wird für hierarchische Namen das Zeichen „~“ als Trennzeichen verwendet. Hat eine Anwendung beispielsweise den Namen „fabric://meineapp/app1“, hat die Anwendungsidentität in 6.0 und höher den Wert „meineapp~app1“ und in früheren Versionen den Wert „meineapp/app1“.
--node-name [erforderlich]	Der Name des Knotens.
--partition-id	Die Identität (ID) der Partition.
--service-manifest-name	Der Name eines Dienstmanifests, das als Bestandteil eines Anwendungstyps in einem Service Fabric-Cluster registriert ist.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica health

Ruft die Integrität eines zustandsbehafteten Service Fabric-Dienstreplikats oder einer zustandslosen Service Fabric-Dienstinstanz ab.

Ruft die Integrität eines Service Fabric-Replikats ab. Verwenden Sie „EventsHealthStateFilter“, um die Sammlung der Integritätsereignisse (HealthEvents), die für das Replikat gemeldet wurden, anhand des Integritätsstatus zu filtern.

Argumente

Argument	BESCHREIBUNG
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [Erforderlich]	Der Bezeichner (ID) des Replikats.
--events-health-state-filter	Ermöglicht das Filtern der Collection zurückgegebener HealthEvent-Objekte anhand des Integritätsstatus. Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus. Es werden nur Ereignisse zurückgegeben, die dem Filter entsprechen. Alle Ereignisse werden verwendet, um den aggregierten Integritätsstatus auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine flagbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen OR-Operator abgerufen werden. Ist der angegebene Wert beispielsweise gleich „6“, werden alle Ereignisse zurückgegeben, für die „HealthState“ den Wert für OK (2) oder Warnung (4) hat. – Default: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null. – None: Filter, der mit keinem Wert für „HealthState“ übereinstimmt. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1". – Ok: Filter, der mit Eingaben übereinstimmt, für die „HealthState“ den Wert „Ok“ hat. Der Wert ist "2". – Warning: Filter, der mit Eingaben übereinstimmt, für die „HealthState“ den Wert „Warning“ hat. Der Wert ist "4". – Error: Filter, der mit Eingaben übereinstimmt, für die „HealthState“ den Wert „Error“ hat. Der Wert ist gleich „8“. – All: Filter, der mit Eingaben übereinstimmt, die einen beliebigen Wert für „HealthState“ haben. Der Wert ist gleich „65535“.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica info

Ruft die Informationen zu einem Replikat einer Service Fabric-Partition ab.

Die Antwort enthält die ID, die Rolle, den Status, die Integrität, den Knotennamen, die Betriebszeit und andere Details zu dem Replikat.

Argumente

Argument	BESCHREIBUNG
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [Erforderlich]	Der Bezeichner (ID) des Replikats.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica list

Ruft die Informationen zu Replikaten einer Service Fabric-Dienstpartition ab.

Der GetReplicas-Endpunkt gibt Informationen zu den Replikaten der angegebenen Partition zurück. Die Antwort enthält die ID, die Rolle, den Status, die Integrität, den Knotennamen, die Betriebszeit und andere Details zu dem Replikat.

Argumente

Argument	BESCHREIBUNG
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--continuation-token	Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica remove

Entfernt ein Dienstreplikat, das auf einem Knoten ausgeführt wird.

Diese API simuliert einen Service Fabric-Replikatfehler durch Entfernen eines Replikats aus einem Service Fabric-Cluster. Beim Entfernen wird das Replikat geschlossen und anschließend in die Rolle „None“ überführt, und dann werden alle Statusinformationen des Replikats aus dem Cluster entfernt. Diese API testet den Pfad für ein Entfernen des Replikatstatus und simuliert den dauerhaften Pfad für Berichten von Fehlern über Client-APIs. Warnung: Es werden keine Sicherheitsüberprüfungen ausgeführt, wenn diese API verwendet wird. Eine falsche Verwendung dieser API kann zum Verlust der Daten von zustandsbehafteten Diensten führen. Darüber hinaus wirkt sich das forceRemove-Flag auf alle anderen Repliken aus, die im selben Prozess gehostet werden.

Argumente

Argument	BESCHREIBUNG
--node-name [erforderlich]	Der Name des Knotens.
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [Erforderlich]	Der Bezeichner (ID) des Replikats.
--force-remove	Erzwingt ein Entfernen einer Service Fabric-Anwendung oder eines Service Fabric-Diensts, ohne den Ablauf für das ordnungsgemäße Herunterfahren zu durchlaufen. Dieser Parameter kann für ein erzwungenes Löschen einer Anwendung oder eines Diensts verwendet werden, für die oder den beim Löschen ein Timeout aufgetreten ist, weil Probleme im Dienstcode ein ordnungsgemäßes Schließen von Replikaten verhindern.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica report-health

Sendet einen Integritätsbericht zu dem Service Fabric-Replikat.

Meldet den Integritätszustand des angegebenen Service Fabric-Replikats. Der Bericht muss die Informationen über die Quelle des Integritätsberichts und die Eigenschaft enthalten, auf die sich der Bericht bezieht. Der Bericht wird an ein Service Fabric-Gatewayreplikat gesendet, das diesen an den Integritätsspeicher weiterleitet. Der Bericht wird möglicherweise vom Gateway akzeptiert, aber nach zusätzlicher Überprüfung vom Integritätsspeicher abgelehnt. Beispielsweise kann der Integritätsspeicher den Bericht aufgrund eines ungültigen Parameters wie etwa einer veralteten Sequenznummer ablehnen. Um festzustellen, ob der Bericht im Integritätsspeicher angewendet wurde, führen Sie „get replica health“ aus, und überprüfen Sie, ob der Bericht im Abschnitt „HealthEvents“ angezeigt wird.

Argumente

Argument	BESCHREIBUNG
--health-property [erforderlich]	Die Eigenschaft der Integritätsinformationen. Eine Entität kann Integritätsberichte für verschiedene Eigenschaften enthalten. Die Eigenschaft ist eine Zeichenfolge und keine feste Enumeration, um dem Reporter Flexibilität zu ermöglichen und entsprechend die Zustandsbedingung zu kategorisieren, die den Bericht auslöst. Beispielsweise kann ein Reporter mit der SourceId „LocalWatchdog“ den Zustand des verfügbaren Datenträgers auf einem Knoten überwachen und folglich die AvailableDisk-Eigenschaft auf diesem Knoten melden. Der gleiche Reporter kann die Knotenkonnektivität überwachen und folglich eine Connectivity-Eigenschaft auf dem gleichen Knoten melden. Im Integritätsspeicher werden diese Berichte als separate Integritätsereignisse für den angegebenen Knoten behandelt. Zusammen mit der SourceId identifiziert die Eigenschaft eindeutig die Integritätsinformationen.
--health-state [erforderlich]	Mögliche Werte sind: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'.
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [erforderlich]	Die Identität (ID) der Partition.
--source-id [erforderlich]	Der Quellenname, der die Client-, Watchdog- oder Systemkomponente identifiziert, die die Integritätsinformationen generiert hat.
--description	Die Beschreibung der Integritätsinformationen. Hierbei handelt es sich um Freitext, mit dem von Menschen lesbare Informationen über den Bericht hinzugefügt werden können. Die maximale Zeichenlänge für die Beschreibung beträgt 4096 Zeichen. Wenn die angegebene Zeichenfolge länger ist, wird sie automatisch abgeschnitten. Wird diese abgeschnitten, enthalten die letzten Zeichen der Beschreibung einen Marker „[abgeschnitten]“, und die gesamte Zeichenfolgenlänge beträgt 4096 Zeichen. Das Vorhandensein des Markers ist ein Hinweis für Benutzer, dass abgeschnittene Zeichenfolgen vorkommen. Beachten Sie, dass die Beschreibung bei abgeschnittenen Zeichenfolgen weniger als 4096 Zeichen von der ursprünglichen Zeichenfolge enthält.
--immediate	Ein Flag, das angibt, ob der Bericht sofort gesendet werden soll. Ein Integritätsbericht wird an eine Service Fabric-Gatewayanwendung gesendet, die diesen an den Integritätsspeicher weiterleitet. Wenn „Immediate“ auf „true“ festgelegt ist, wird der Bericht sofort vom HTTP-Gateway an den Integritätsspeicher gesendet, unabhängig von den Fabric-Clienteinstellungen, die die HTTP-Gatewayanwendung verwendet. Dies ist für kritische Berichte hilfreich, die schnellstmöglich gesendet werden sollen. Abhängig von der zeitlichen Steuerung und anderen Bedingungen können beim Senden des Berichts trotzdem möglicherweise Fehler auftreten, z.B., wenn das HTTP-Gateway geschlossen ist oder die Meldung das Gateway nicht erreicht. Wenn „Immediate“ auf „false“ festgelegt ist, wird der Bericht basierend auf den Integritätsclienteinstellungen vom HTTP-Gateway gesendet. Aus diesem Grund wird der Bericht entsprechend der HealthReportSendInterval-Konfiguration batchweise verarbeitet. Dies ist die empfohlene Einstellung, da der Integritätsclient die Optimierung von Meldungen des Integritätsberichts für den Integritätsspeicher sowie die Verarbeitung von Integritätsberichten ermöglicht. Standardmäßig werden Berichte nicht sofort gesendet.
--remove-when-expired	Ein Wert, der angibt, ob der Bericht aus dem Integritätsspeicher entfernt wird, wenn er abläuft. Wenn dieser Wert auf „true“ festgelegt ist, wird der Bericht aus dem Integritätsspeicher entfernt, nachdem er abgelaufen ist. Wenn dieser Wert auf „false“ festgelegt ist, wird der Bericht als Fehler behandelt, wenn er abgelaufen ist. Der Wert dieser Eigenschaft ist standardmäßig auf „false“ festgelegt. Wenn Clients in regelmäßigen Abständen Berichte erstellen, sollte RemoveWhenExpired auf „false“ (Standardwert) festgelegt sein. Denn falls der Reporter Probleme (z.B. Deadlocks) haben und keine Berichte erstellen können sollte, wird die Entität entsprechend auf Fehler ausgewertet, wenn der Integritätsbericht abläuft. Hierdurch wird die Entität nicht als in einem fehlerhaften Integritätszustand befindlich gekennzeichnet.
--sequence-number	Die Sequenznummer für diesen Integritätsbericht als numerische Zeichenfolge. Die Sequenznummer des Berichts wird vom Integritätsspeicher zur Erkennung veralteter Berichte verwendet. Wenn diese nicht angegeben ist, wird beim Hinzufügen eines Berichts automatisch eine Sequenznummer vom Integritätsclient generiert.
--service-kind	Die Art des Dienstreplikats (zustandsbehaftet oder zustandslos), für die die Integrität gemeldet wird. Folgende Werte sind möglich: 'Stateless', 'Stateful'. Standard: Stateful.
--timeout -t	Standardwert: 60.
--ttl	Die Dauer, für die dieser Integritätsbericht gültig ist. Bei diesem Feld wird das ISO8601-Format zur Angabe der Dauer verwendet. Wenn Clients in regelmäßigen Abständen Berichte erstellen, sollten sie Berichte in einem höherer Intervall als die Gültigkeitsdauer senden. Wenn Clients Berichte zur Übertragung erstellen, können sie die Gültigkeitsdauer auf einen unbegrenzten Wert festlegen. Wenn die Gültigkeitsdauer abläuft, wird das Integritätsereignis, das die Integritätsinformationen enthält, entweder aus dem Integritätsspeicher entfernt, sofern RemoveWhenExpired auf „true“ festgelegt ist, oder auf Fehler ausgewertet, sofern RemoveWhenExpired auf „false“ festgelegt ist. Wenn kein Wert angegeben ist, wird die Gültigkeitsdauer standardmäßig auf einen unbegrenzten Wert festgelegt.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

sfctl replica restart

Startet ein Dienstreplikat eines permanenten Diensts neu, das auf einem Knoten ausgeführt wird.

Startet ein Dienstreplikat eines permanenten Diensts neu, das auf einem Knoten ausgeführt wird. Warnung: Es werden keine Sicherheitsüberprüfungen ausgeführt, wenn diese API verwendet wird. Eine falsche Verwendung dieser API kann zum Verlust der Verfügbarkeit von zustandsbehafteten Diensten führen.

Argumente

Argument	BESCHREIBUNG
--node-name [erforderlich]	Der Name des Knotens.
--partition-id [erforderlich]	Die Identität (ID) der Partition.
--replica-id [Erforderlich]	Der Bezeichner (ID) des Replikats.
--timeout -t	Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden. Standardwert: 60.

Globale Argumente

Argument	BESCHREIBUNG
--debug	Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
--help -h	Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
--output -o	Ausgabeformat. Zulässige Werte: json, jsonc, table, tsv. Standardwert: json.
--query	JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
--verbose	Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

Nächste Schritte

• Einrichten der Service Fabric-Befehlszeilenschnittstelle
• Informationen zum Verwenden der Service Fabric-Befehlszeilenschnittstelle mit den Beispielskripts