Freigeben über


CycleCloud CLI

Mit der Azure CycleCloud CLI können Sie Ihre Installation über eine Konsolen- oder Skriptdatei verwalten.

Globale CLI-Parameter

Diese sind für alle Befehle verfügbar.

-h, --help

diese Hilfemeldung anzeigen und beenden

-v, --version

Zeigt die Version für die CLI an.

--config=CONFIG_FILE

Gibt den Pfad zu einer nicht standardmäßigen Konfigurationsdatei an, die für diesen Befehl verwendet werden soll.

--loglevel=LOG_LEVEL

Legt die Standardprotokollebene für die CLI fest.

Cyclecloud-Konto

Verwalten von Cloudanbieterkonten.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]
Unterbefehl description
list Konten auflisten
account_name anzeigen <> Detail für ein Konto anzeigen
create Erstellen eines neuen Kontos
account_name bearbeiten <> Bearbeiten eines vorhandenen Kontos
löschen <account_name> Löschen eines vorhandenen Kontos

Cyclecloud-Kontoliste

Konten auflisten

cyclecloud account list

Cyclecloud-Konto anzeigen

Detail für ein Konto anzeigen

cyclecloud account show <account_name>

Cyclecloud-Konto erstellen

Erstellen eines neuen Kontos

cyclecloud account create [-o OUTPUT_FILE]
                          [--dry-run]
                          [-f INPUT_FILE]

-o OUTPUT_FILE

Schreibt die Konfigurationsparameter auf den Datenträger

--dry-run

Fordert Informationen auf und überprüft sie, erlässt jedoch keine Änderungen.

-f INPUT_FILE

Liest die Definition aus einer Konfigurationsdatei anstelle der Eingabeaufforderung

Cyclecloud-Kontobearbeitung

Bearbeiten eines vorhandenen Kontos

cyclecloud account edit <account_name> [-o OUTPUT_FILE]
                                       [--dry-run]
                                       [-f INPUT_FILE]

-o OUTPUT_FILE

Schreibt die Konfigurationsparameter auf den Datenträger

--dry-run

Fordert Informationen auf und überprüft sie, erlässt jedoch keine Änderungen.

-f INPUT_FILE

Liest die Definition aus einer Konfigurationsdatei anstelle der Eingabeaufforderung

Cyclecloud-Konto löschen

Löschen eines vorhandenen Kontos

cyclecloud account delete <account_name> [--force]

--force

Wenn true, werden Sie nicht aufgefordert, das Konto zu löschen.

cyclecloud add_node

Fügt dem Cluster weitere Knoten hinzu.

cyclecloud add_node <CLUSTER> [--template=TEMPLATE]
                              [--count=COUNT]
                              [--fixed]

-t TEMPLATE, --template=TEMPLATE

Die Vorlage, die für diesen Knoten verwendet werden soll. Wenn nicht angegeben, ist die Standardeinstellung die einzige vorlage zu verwenden, die andernfalls fehler verfügbar ist.

-c COUNT, --count=COUNT

Wie viele Knoten gestartet werden sollen. Wenn nichts angegeben ist, wird der Standardwert 1 verwendet.

-f, --fixed

Wenn festgelegt, wird der Clustervorlage der Knoten endgültig (bis zur Entfernung) hinzugefügt. Andernfalls wird der Knoten automatisch entfernt, wenn er beendet wird.

cyclecloud config

Einfaches Wechseln zwischen Cyclecloud-Konfigurationen

cyclecloud config <command>
Unterbefehl description
show Anzeigen der aktuellen Konfiguration in Verwendung
list Verfügbare Konfigurationen auflisten
erstellen config_name <> Erstellen einer neuen Konfiguration
umbenennen <old_name new_name><> Umbenennen einer vorhandenen Konfiguration
config_name verwenden <> Wechseln zu einer angegebenen Konfiguration
config_name entfernen <> Entfernen einer benannten Konfiguration

cyclecloud config show

Anzeigen der aktuellen Konfiguration in Verwendung

cyclecloud config show

Cyclecloud-Konfigurationsliste

Verfügbare Konfigurationen auflisten

cyclecloud config list

cyclecloud config create

Erstellen einer neuen Konfiguration

cyclecloud config create <config_name>

cyclecloud config rename

Umbenennen einer vorhandenen Konfiguration

cyclecloud config rename <old_name> <new_name>

cyclecloud config use

Wechseln zu einer angegebenen Konfiguration

cyclecloud config use <config_name>

cyclecloud config remove

Entfernen einer benannten Konfiguration

cyclecloud config remove <config_name>

cyclecloud connect

Stellt eine Verbindung mit einer ausgeführten Instanz im Cluster dar. Ab 7.8 kann der Name entweder ein Knotenname, ein Hostname oder eine IP-Adresse sein.

cyclecloud connect <NAME> [--keyfile=KEYFILE]
                          [--cluster=CLUSTER]
                          [--user=USER]
                          [--bastion-host=BASTION-HOST]
                          [--bastion-port=BASTION-PORT]
                          [--bastion-user=BASTION-USER]
                          [--bastion-key=BASTION-KEY]

-k KEYFILE, --keyfile=KEYFILE

Der zu verwendende Keypair, sofern nicht auf dem Knoten oder dem Knoten angegeben, ist nicht vorhanden.

-c CLUSTER, --cluster=CLUSTER

Der Cluster, in dem sich der Knoten befindet, wenn der Name ein Knotenname ist. Optional, es sei denn, es gibt mehrere Knoten mit demselben Namen.

-u USER, --user=USER

Der Benutzer, der sich bei dem Knoten anmeldet.

--bastion-host=BASTION-HOST

SSH-Bastionhost zum Weiterleiten von Verbindungen durch.

--bastion-port=BASTION-PORT

SSH-Port für die Verbindung mit der Bastion.

--bastion-user=BASTION-USER

Benutzeranmeldung für die Verbindung mit der Bastion.

--bastion-key=BASTION-KEY

Private Schlüsseldatei zum Herstellen einer Verbindung mit der Bastion.

cyclecloud copy_cluster

Erstellt eine Kopie eines Clusters.

cyclecloud copy_cluster <source_cluster_name> <new_cluster_name> [--parameters=PARAMETERS]

-p PARAMETERS, --parameters=PARAMETERS

Die zu verwendende Parameterdatei

cyclecloud create_cluster

Erstellt einen Cluster aus einer vorhandenen Vorlage.

cyclecloud create_cluster <TEMPLATE> <NAME> [--force]
                                            [--parameters=PARAMETERS]
                                            [--parameter-override=PARAMETER_OVERRIDE]

--force

Wenn angegeben, wird der Cluster ersetzt, wenn er vorhanden ist.

-p PARAMETERS, --parameters=PARAMETERS

Die zu verwendende Parameterdatei

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Fügen Sie einen bestimmten Parameter hinzu oder überschreiben Sie sie. Hat Vorrang vor Werten, die in -p angegeben sind.

Cyclecloud-Anmeldeinformationen

Verwalten von Anmeldeinformationen für das Cloudanbieterkonto.

cyclecloud credential <command>
Unterbefehl description
list Listenanmeldeinformationen
create Erstellen von neuen Anmeldeinformationen
bearbeiten account_name <> Bearbeiten einer vorhandenen Anmeldeinformationen
löschen account_name <> Löschen einer vorhandenen Anmeldeinformationen

Cyclecloud-Anmeldeinformationenliste

Listenanmeldeinformationen

cyclecloud credential list

cyclecloud-Anmeldeinformationen erstellen

Erstellen von neuen Anmeldeinformationen

cyclecloud credential create

Cyclecloud-Anmeldeinformationen bearbeiten

Bearbeiten einer vorhandenen Anmeldeinformationen

cyclecloud credential edit <account_name>

Cyclecloud-Anmeldeinformationen löschen

Löschen einer vorhandenen Anmeldeinformationen

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Löscht einen nicht ausgeführten Cluster.

cyclecloud delete_cluster <CLUSTER> [--recursive]
                                    [--force]

-r, --recursive

Löschen Sie diesen Cluster und alle ihre Untercluster rekursiv.

--force

Erzwingen Sie, dass dieser Cluster gelöscht werden soll. Hinweis: Verwenden Sie diese Option nur, wenn alle Ressourcen in Ihrem Cloudanbieter bereits beendet werden!

cyclecloud delete_template

Löscht eine Clustervorlage

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

Exportieren von Parametern für einen bestimmten Cluster.

cyclecloud export_parameters <cluster_name> [-o OUTPUT_FILE]
                                            [--format=OUTPUT_FORMAT]

-o OUTPUT_FILE

Zum Erstellen schreibt die Clusterparameter auf den Datenträger.

--format=OUTPUT_FORMAT

Ausgabeformat

Cyclecloud-Bild

Verwalten von benutzerdefinierten Bildern.

cyclecloud image <command> [--account=ACCOUNTS]
                           [--name=NAME]
                           [--label=LABEL]
                           [--package-version=PACKAGE_VERSION]
                           [--bump-version=BUMP_VERSION]
                           [--os=OS]
                           [--jetpack-version=JETPACK_VERSION]
                           [--install-jetpack]
                           [--jetpack-platform=JETPACK_PLATFORM]
                           [--dry-run]
Unterbefehl description
hinzufügen <image_name> [...] Hinzufügen eines oder mehrerer Bilder

Cyclecloud-Bild hinzufügen

Hinzufügen eines oder mehrerer Bilder

cyclecloud image add <image_name> [...] [--account=ACCOUNTS]
                                        [--name=NAME]
                                        [--label=LABEL]
                                        [--package-version=PACKAGE_VERSION]
                                        [--bump-version=BUMP_VERSION]
                                        [--os=OS]
                                        [--jetpack-version=JETPACK_VERSION]
                                        [--install-jetpack]
                                        [--jetpack-platform=JETPACK_PLATFORM]
                                        [--dry-run]

--account=ACCOUNTS

Suchen Sie nur dieses Konto (kann für mehrere Konten wiederholt werden)

--name=NAME

Der Name des zu erstellenden Pakets (erforderlich)

--label=LABEL

Die Bezeichnung des zu erstellenden Pakets

--package-version=PACKAGE_VERSION

Verwenden Sie diese Version für das neue Bild anstelle des Standards von 1.0.0

--bump-version=BUMP_VERSION

Verwenden Sie "--bump-version minor", um die neueste Nebenversion um 1 (z. B. 1 bis 1.2) zu erhöhen oder "--bump-version major" oder "--bump-version patch" zu verwenden.

--os=OS

Verwenden sie "-os linux/windows", um das Betriebssystem auf dem Image anzugeben.

--jetpack-version=JETPACK_VERSION

Die Version von Jetpack, die installiert ist oder auf dem Image installiert werden soll

--install-jetpack

Installieren von Jetpack zur Laufzeit auf diesem Image

--jetpack-platform=JETPACK_PLATFORM

Die jetpack-Plattform, die auf dem Bild verwendet wird (z. B. centos-7, ubuntu-14.04, Windows

--dry-run

Sucht nach übereinstimmenden Bildern, speichert jedoch keine Bildinformationen

cyclecloud import_cluster

Erstellt einen Cluster aus einer Textdatei. Wenn CLUSTER nicht angegeben ist und die Datei über einen einzelnen Cluster verfügt, wird der Name dieses Clusters verwendet.

cyclecloud import_cluster [CLUSTER] [-c TEMPLATE]
                                    [--force]
                                    [--as-template]
                                    [--file=FILE]
                                    [--parameters=PARAMETERS]
                                    [--parameter-override=PARAMETER_OVERRIDE]
                                    [--recursive]

-c TEMPLATE

Der Cluster in der zu importierenden Datei. Wenn nicht angegeben, wird der Name des neuen Clusters verwendet.

--force

Wenn angegeben, wird der Cluster ersetzt, wenn es vorhanden ist.

-t, --as-template

Wenn angegeben, wird der Cluster als Vorlage gespeichert, die nur zum Erstellen anderer Cluster verwendet werden kann.

-f FILE, --file=FILE

Die Datei, aus der die Vorlage importiert werden soll.

-p PARAMETERS, --parameters=PARAMETERS

Die zu verwendende Parameterdatei

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Fügen Sie einen bestimmten Parameter hinzu oder außer Kraft. Nimmt Vorrang vor Werten, die in -p angegeben sind.

-r, --recursive

Importiert den benannten Cluster und alle Cluster in der Datei, für die es sich um das übergeordnete Objekt handelt.

cyclecloud import_template

Importiert eine Clustervorlage aus einer Textdatei. Wenn DER NAME nicht angegeben ist, und die Datei über einen einzelnen Cluster verfügt, wird der Name dieses Clusters verwendet.

cyclecloud import_template [NAME] [-c TEMPLATE]
                                  [--force]
                                  [--file=FILE]

-c TEMPLATE

Die Vorlage in der zu importierenden Datei. Wenn nicht angegeben, wird der Name der neuen Vorlage verwendet.

--force

Wenn angegeben, wird die Vorlage ersetzt, wenn sie vorhanden ist

-f FILE, --file=FILE

Die Datei, aus der die Vorlage importiert werden soll.

cyclecloud initialisieren

Initialisiert CycleCloud-Einstellungen.

cyclecloud initialize [--batch]
                      [--force]
                      [--url=URL]
                      [--username=USERNAME]
                      [--password=PASSWORD]
                      [--verify-ssl=VERIFY-SSL]
                      [--name=NAMED_CONFIG]

--batch

Wenn angegeben, müssen die Argumente in der Befehlszeile angegeben werden. Fragen werden angenommen, dass es "nein" sein wird.

--force

Erzwingen Sie eine erneute Initialisierung, auch wenn gültige Konfigurationsdatei verfügbar ist.

--url=URL

Die Basis-URL für die CycleServer-Installation.

--username=USERNAME

Der Benutzername für die CycleServer-Installation.

--password=PASSWORD

Das Kennwort für die CycleServer-Installation.

--verify-ssl=VERIFY-SSL

Ob sie (true) oder nicht (false) SSL-Zertifikate für die CycleServer-Installation überprüfen möchten.

--name=NAMED_CONFIG

Erstellen einer benannten Konfiguration, die mit dem Konfigurationsbefehl verwendet werden kann

Cyclecloud-Schließfach

Verwalten von CycleCloud-Schließfächern.

cyclecloud locker <command>
Unterbefehl description
list Schließfächer auflisten
Schließfach anzeigen <> Details für ein Schließfach anzeigen

Cyclecloud-Schließfachliste

Schließfächer auflisten

cyclecloud locker list

Cyclecloud-Schließfachpräsentation

Details für ein Schließfach anzeigen

cyclecloud locker show <locker>

Cyclecloud-Projekt

Verwalten von CycleCloud-Projekten.

cyclecloud project <command> [--skip-teardown]
                             [--output-json=JSON_FILE]
                             [--junit-xml=JUNIT_FILE]
                             [--extra-var=EXTRA_VARS]
                             [--template=TEMPLATE]
                             [--name=CLUSTER_NAME]
                             [--global]
                             [--project-version=PROJECT_VERSION]
                             [--build-dir=BUILD_DIR]
Unterbefehl description
Initname <> Erstellen eines neuen leeren Projekts
URL-Pfad><abrufen <> ruft ein Projekt aus einer Github-URL <> auf <Pfad ab.>
info Anzeigen von Projektinformationen
<add_spec Spezifikation> fügt dem Projekt eine Spezifikation hinzu
<default_locker Schließfach> legt den Standard-Schließfach(n) fest, in den sie hochgeladen werden soll
test Ausführen des Integrationstests für eine bestimmte Clusterdefinition
build Erstellen des Projekts
Hochladen [Schließfach] Erstellen und Hochladen des Projekts mit dem angegebenen Schließfach (wird standardmäßig verwendet, wenn keine angegeben)
Download [Schließfach] Laden Sie die Projekt-Blobs aus den angegebenen Schließfächern herunter (verwendet standard, wenn keine angegeben)
<generate_template Datei> Generieren einer Clustervorlage für das Projekt, geschrieben in <Datei>

Cyclecloud-Projekt init

Erstellen eines neuen leeren Projekts

cyclecloud project init <name>

Cyclecloud-Projektabruf

ruft ein Projekt aus einer Github-URL <> auf <Pfad ab.>

cyclecloud project fetch <url> <path>

Cyclecloud-Projektinformationen

Anzeigen von Projektinformationen

cyclecloud project info

cyclecloud-Projekt add_spec

fügt dem Projekt eine Spezifikation hinzu

cyclecloud project add_spec <spec>

cyclecloud-Projekt default_locker

legt den Standard-Schließfach(n) fest, in den sie hochgeladen werden soll

cyclecloud project default_locker <locker> [--global]

--global

Legen Sie den globalen Standard anstelle des projektspezifischen Werts fest.

Cyclecloud-Projekttest

Ausführen des Integrationstests für eine bestimmte Clusterdefinition

cyclecloud project test [--skip-teardown]
                        [--output-json=JSON_FILE]
                        [--junit-xml=JUNIT_FILE]
                        [--extra-var=EXTRA_VARS]
                        [--template=TEMPLATE]
                        [--name=CLUSTER_NAME]

--skip-teardown

Überspringen des Abbruchclusters, der zum Testen erstellt wurde

--output-json=JSON_FILE

Ausgabe der Ergebnisse in die angegebene JSON-Datei

--junit-xml=JUNIT_FILE

Ausgabe der Ergebnisse im junit-xml-Format in die angegebene JSON-Datei

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Beliebige Schlüssel=Wertpaare, die zum Parametern der Clustervorlage unter Test verwendet werden

-t TEMPLATE, --template=TEMPLATE

Pfad zur Clustervorlagendatei

-n CLUSTER_NAME, --name=CLUSTER_NAME

Name der Clusterdefinition zum Testen

Cyclecloud-Projektbuild

Erstellen des Projekts

cyclecloud project build [--project-version=PROJECT_VERSION]
                         [--build-dir=BUILD_DIR]

--project-version=PROJECT_VERSION

Überschreiben der in project.ini vorhandenen Projektversion

--build-dir=BUILD_DIR

Das Buildverzeichnis

Cyclecloud-Projektupload

Erstellen und Hochladen des Projekts mit dem angegebenen Schließfach (wird standardmäßig verwendet, wenn keine angegeben)

cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]

--project-version=PROJECT_VERSION

Überschreiben der in project.ini vorhandenen Projektversion

Cyclecloud-Projektdownload

Laden Sie die Projekt-Blobs aus den angegebenen Schließfächern herunter (verwendet standard, wenn keine angegeben)

cyclecloud project download [locker]

cyclecloud-Projekt generate_template

Generieren einer Clustervorlage für das Projekt, geschrieben in <Datei>

cyclecloud project generate_template <file>

cyclecloud reboot_node

Starten Sie einen ausgeführten Knoten neu.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Entfernt einen Knoten aus dem Cluster (und beendet ihn, wenn es gestartet wurde).

cyclecloud remove_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                             [--instance-filter=INSTANCE_FILTER]
                                             [--creds=CREDS]
                                             [--no-prompt]
                                             [--force]

-f FILTER, --filter=FILTER

Entfernen Sie Knoten, die dem vollständigen Klassenanzeigeausdruck entsprechen.

--instance-filter=INSTANCE_FILTER

Entfernen Sie Knoten mit aktiven Instanzen, die dem vollständigen Klassenanzeigeausdruck entsprechen.

--creds=CREDS

Entfernen Sie Knoten, die mit dem benannten Satz von Anmeldeinformationen beginnen.

--no-prompt

Wenn angegeben, wird keine Bestätigung gefragt, bevor Knoten basierend auf einem Filter beendet werden.

--force

Erzwingen Sie, dass dieser Knoten entfernt werden soll, auch wenn sie nicht beendet werden. Hinweis: Verwenden Sie diese Option nur, wenn die Ressourcen für diesen Knoten in Ihrem Cloudanbieter bereits beendet werden!

Cyclecloud-Wiederholungsversuche

Fehler beim Initialisieren von Initialisierungsvorgängen für den benannten Cluster.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Wiederholen Sie erneut Optionen in diesem Cluster und allen ihren Unterclustern.

cyclecloud show_cluster

Zeigt den Cluster oder Cluster in CycleCloud an.

cyclecloud show_cluster <CLUSTER> [--recursive]
                                  [--long]
                                  [--templates]

-r, --recursive

Zeigen Sie diesen Cluster und alle ihrer Untercluster an.

-l, --long

Listet jeden Knoten auf, anstatt eine Zusammenfassung zu zeigen.

-t, --templates

Fügen Sie Clustervorlagen in die Ausgabe ein.

cyclecloud show_nodes

Zeigen Sie Details von ausgewählten Knoten/Instanzen an.

cyclecloud show_nodes [NAME] [--attrs=ATTRS]
                             [--filter=FILTER]
                             [--instance-filter=INSTANCE_FILTER]
                             [--output=OUTPUT]
                             [--format=FORMAT]
                             [--creds=CREDS]
                             [--cluster=CLUSTER]
                             [--states=STATES]
                             [--long]
                             [--summary]

-a ATTRS, --attrs=ATTRS

Zeigen Sie den angegebenen Satz von Attributen an (durch Komma getrennte Liste).

-f FILTER, --filter=FILTER

Zeigen Sie nur Knoten an, die dem vollständigen Klassenanzeigeausdruck entsprechen.

--instance-filter=INSTANCE_FILTER

Zeigen Sie nur Knoten mit aktiven Instanzen an, die dem vollständigen Klassenanzeigeausdruck entsprechen.

--output=OUTPUT

Geben Sie die übereinstimmenden Knotenattribute aus, die von einer Python-Formatzeichenfolge mit benanntem Parameterformat beschrieben werden. Ex. --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n"

--format=FORMAT

Ändern Sie das Ausgabeanzeigeformat [xml | json | Text].

--creds=CREDS

Zeigen Sie nur Knoten an, die mit dem benannten Satz von Anmeldeinformationen gestartet wurden.

-c CLUSTER, --cluster=CLUSTER

Nur Knoten im angegebenen Cluster anzeigen.

--states=STATES

Zeigen Sie nur Knoten in den angegebenen Zuständen an (durch Komma getrennte Liste).

-l, --long

Zeigen Sie die vollständige Klassenanzeigedarstellung des Knotens an.

-s, --summary

Zeigen Sie eine minimale Darstellung des Knotens an.

cyclecloud start_cluster

Startet den benannten Cluster.

cyclecloud start_cluster <CLUSTER> [--recursive]
                                   [--test]

-r, --recursive

Starten Sie diesen Cluster und alle ihre Untercluster rekursiv.

-t, --test

Starten des Clusters im Testmodus

cyclecloud start_node

(Re-) Startet beendete Knoten in einem ausgeführten Cluster.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Beendet den benannten Cluster.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Beenden Sie diesen Cluster und alle ihre Untercluster rekursiv.

cyclecloud terminate_node

Beendet einen ausgeführten Knoten (aber verlässt ihn im Cluster).

cyclecloud terminate_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                                [--instance-filter=INSTANCE_FILTER]
                                                [--creds=CREDS]
                                                [--no-prompt]

-f FILTER, --filter=FILTER

Beenden Sie Knoten mit dem vollständigen Klassenanzeigeausdruck.

--instance-filter=INSTANCE_FILTER

Beenden Sie Knoten mit aktiven Instanzen, die dem vollständigen Klassenanzeigeausdruck entsprechen.

--creds=CREDS

Beenden von Knoten, die mit dem benannten Satz von Anmeldeinformationen beginnen.

--no-prompt

Wenn angegeben, wird keine Bestätigung gefragt, bevor Knoten basierend auf einem Filter beendet werden.