CLI-Befehle

Liste der CLI-Befehle für Resource Analytics.

Befehl Beschreibung Erforderlich Optional
oci resource-analytics -h
Mit der Resource Analytics-Control-Plane-CLI können Sie Resource Analytics-Instanzen und ihre Mandantenanhänge verwalten oder OAC auf ADW-Instanzen aktivieren bzw. deaktivieren.
Resource Analytics-Instanz
oci resource-analytics resource-analytics-instance -h
Eine ResourceAnalyticsInstance ist eine ADW-Gehäuseanalyse für alle OCI-Ressourcen eines Kunden.
oci resource-analytics resource-analytics-instance create [OPTIONS]
Erstellt eine ResourceAnalyticsInstance. --adw-admin-password-password [text]--compartment-id, -c [text]--included-regions [komplexer Typ]--subnet-id [text] --defined-tags [complex type]--description [text]--display-name [text]--freeform-tags [complex type]--from-json [text]--is-mutual-tls-required [boolean]--max-wait-seconds [integer]--nsg-ids [complex type]--wait-for-state [text]--wait-interval-seconds [integer]
oci resource-analytics resource-analytics-instance change-compartment [OPTIONS]
Verschiebt eine ResourceAnalyticsInstance in ein anderes Compartment innerhalb desselben Mandanten. Informationen zum Verschieben von Ressourcen zwischen Compartments finden Sie unter Ressourcen in ein anderes Compartment verschieben.

--compartment-id, -c [text]

--resource-analytics-instance-id [text]

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

oci resource-analytics resource-analytics-instance delete [OPTIONS]
Löscht eine ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--force

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

oci resource-analytics resource-analytics-instance disable-oac [OPTIONS]
Deaktivieren Sie eine OAC-Instanz für eine ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

oci resource-analytics resource-analytics-instance enable-oac [OPTIONS]
Hängt eine OAC-Instanz an eine ResourceAnalyticsInstance an.

--attachment-details [komplexer Typ]

--attachment-type [text]

--resource-analytics-instance-id [text]

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

oci resource-analytics resource-analytics-instance get [OPTIONS]
Ruft Informationen zu einer ResourceAnalyticsInstance ab. --resource-analytics-instance-id [text] --from-json [Text]
oci resource-analytics resource-analytics-instance list [OPTIONS]
Ruft eine Liste von ResourceAnalyticsInstances ab.

--alle

--compartment-id, -c [text]

--display-name [text]

--from-json [Text]

--id [Text]

--Lebenszyklusstatus [Text]

--limit [Ganzzahl]

--page [Text]

--page-size [Ganzzahl]

--sort-by [Text]

--sort-order [text]

oci resource-analytics resource-analytics-instance update [OPTIONS]
Aktualisiert eine ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--definierte Tags [komplexer Typ]

--Beschreibung [Text]

--display-name [text]

--force

--freeform-tags [komplexer Typ]

--from-json [Text]

--if-match [Text]

--included-regions [komplexer Typ]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

Mandantenanhänge
oci resource-analytics tenancy-attachment -h
Eine TenancyAttachment ist ein Mandant eines Kunden, der an eine ResourceAnalyticsInstance angehängt ist. Angehängte Mandanten sind in der Analytics-Sammlung enthalten.
oci resource-analytics tenancy-attachment create [OPTIONS]
Erstellt eine TenancyAttachment. --resource-analytics-instance-id [text]--tenancy-id [text] --description [text]--from-json [text]--max-wait-seconds [integer]--wait-for-state [text]--wait-interval-seconds [integer]
oci resource-analytics tenancy-attachment delete [OPTIONS]
Löscht eine TenancyAttachment. --tenancy-attachment-id [text]

--force

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

oci resource-analytics tenancy-attachment get [OPTIONS]
Ruft Informationen zu einer TenancyAttachment ab. --tenancy-attachment-id [text] --from-json [Text]
oci resource-analytics tenancy-attachment list [OPTIONS]
Ruft eine Liste von TenancyAttachments ab.

--alle

--from-json [Text]

--id [Text]

--Lebenszyklusstatus [Text]

--limit [Ganzzahl]

--page [Text]

--page-size [Ganzzahl]

--resource-analytics-instance-id [text]

--sort-by [Text]

--sort-order [text]

oci resource-analytics tenancy-attachment update [OPTIONS]
Aktualisiert eine TenancyAttachment.

--Beschreibung [Text]

--tenancy-attachment-id [text]

--from-json [Text]

--if-match [Text]

--max-wait-seconds [integer]

--wait-for-state [text]

--wait-interval-seconds [Ganzzahl]

Arbeitsanforderungen
oci resource-analytics work-request -h
Eine asynchrone Arbeitsanforderung. Mit Arbeitsanforderungen können Sie Vorgänge mit langer Ausführungszeit überwachen. Wenn Sie einen Prozess mit langer Ausführungszeit starten, erstellt der Service eine Arbeitsanforderung. Eine Arbeitsanforderung ist ein Aktivitätslog, mit dem Sie jeden Schritt im Fortschritt des Vorgangs verfolgen kann. Jede Arbeitsanforderung hat eine OCID, die es Ihnen ermöglicht, programmgesteuert mit der Arbeitsanforderung zu interagieren und sie zur Automatisierung zu verwenden.
oci resource-analytics work-request cancel [OPTIONS]
Bricht eine Arbeitsanforderung ab. --work-request-id [text]

--force

--from-json [Text]

--if-match [Text]

oci resource-analytics work-request get [OPTIONS]
Ruft die Details einer Arbeitsanforderung ab. --work-request-id [text] --from-json [Text]
oci resource-analytics work-request list [OPTIONS]
Listet die Arbeitsanforderungen in einem Compartment auf.

--alle

--compartment-id, -c [text]

--from-json [Text]

--limit [Ganzzahl]

--page [Text]

--page-size [Ganzzahl]

--resource-id [text]

--sort-by [Text]

--sort-order [text]

--status [Text]

--work-request-id [text]

Arbeitsanforderungsfehler
oci resource-analytics work-request-error -h
Beim Ausführen eines Vorgangs, der von einer Arbeitsanforderung verfolgt wird, ist ein Fehler aufgetreten.
oci resource-analytics work-request-error list [OPTIONS]
Listet die Fehler für eine Arbeitsanforderung auf. --work-request-id [text]

--alle

--from-json [Text]

--limit [Ganzzahl]

--page [Text]

--page-size [Ganzzahl]

--sort-by [Text]

--sort-order [text]

Arbeitsanforderungslogs
oci resource-analytics work-request-log-entry -h
Eine Logmeldung aus der Ausführung eines Vorgangs, der von einer Arbeitsanforderung verfolgt wird.
oci resource-analytics work-request-log-entry list [OPTIONS]
Listet die Logs für eine Arbeitsanforderung auf. --work-request-id [text]

--alle

--from-json [Text]

--limit [Ganzzahl]

--page [Text]

--page-size [Ganzzahl]

--sort-by [Text]

--sort-order [text]

Beschreibung der Parameter

Parameter Beschreibung SDK-Standardtext
--adw-admin-password-password [text] Kennwort für das ADW, das im Benutzermandanten erstellt werden soll. Das Kennwort muss zwischen 12 und 30 Zeichen enthalten und mindestens 1 Großbuchstaben, 1 Kleinbuchstaben und 1 numerisches Zeichen enthalten. Das doppelte Anführungszeichen " oder der Benutzername admin darf unabhängig von der Groß-/Kleinschreibung nicht enthalten sein.
--alle Ruft alle Seiten der Ergebnisse ab. Wenn Sie diese Option angeben, können Sie die Option --limit nicht angeben. SDK-Standardtext
--attachment-details [komplexer Typ]

Das ist ein komplexer Typ, dessen Wert ein gültiges JSON-Format aufweisen muss. Der Wert kann als Zeichenfolge in der Befehlszeile angegeben oder mit der Syntax file://path/to/file als Datei übergeben wird.

Mit der Option --generate-param-json-input können Sie ein Beispiel fur das JSON-Format generieren, das angegeben werden muss. Es wird empfohlen, dieses Beispiel in einer Datei zu Speichern, die nach Bedarf zu wechseln und sie dann über file:// erneut zu übergeben.

--attachment-type [text]

Der Anhangstyp, den die OAC-Instanz verwendet.

Zulässige Werte sind:

MANAGED
--compartment-id, -c [text] Die OCID des Compartments, in dem die ResourceAnalyticsInstance erstellt werden soll. Die OCID des Compartments, in das die ResourceAnalyticsInstance verschoben werden soll. Die OCID des Compartments, in dem Ressourcen aufgelistet werden sollen.
--definierte Tags [komplexer Typ]

Definierte Tags für diese Ressource. Jeder Schlüssel ist vordefiniert und gilt für einen bestimmten Namespace. Weitere Informationen finden Sie unter Ressourcentags.

Beispiel:

{"Operations": {"CostCenter": "42"}}

Das ist ein komplexer Typ, dessen Wert ein gültiges JSON-Format aufweisen muss. Der Wert kann als Zeichenfolge in der Befehlszeile angegeben oder mit der Syntax file://path/to/file als Datei übergeben wird.

Mit der Option --generate-param-json-input können Sie ein Beispiel fur das JSON-Format generieren, das angegeben werden muss. Es wird empfohlen, dieses Beispiel in einer Datei zu Speichern, die nach Bedarf zu wechseln und sie dann über file:// erneut zu übergeben.

SDK-Standardtext
--Beschreibung [Text] Eine Beschreibung der ResourceAnalyticsInstance-Instanz. Eine Beschreibung des Mandanten.
--display-name [text] Ein benutzerfreundlicher Name. Er muss nicht eindeutig sein und kann geändert werden. Geben Sie keine vertraulichen Informationen ein. Ein Filter, der nur Ressourcen zurückgibt, die genau mit dem jeweiligen Anzeigenamen übereinstimmen.
--id [Text]

Die OCID der ResourceAnalyticsInstance.

Die OCID der TenancyAttachment.

--if-match [Text] Für optimistische Nebenläufigkeitskontrolle. Setzen Sie im PUT- oder DELETE-Aufruf für eine Ressource den Parameter if-match auf den Wert des Etags aus einer vorherigen GET- oder POST-Antwort für diese Ressource. Die Ressource wird nur aktualisiert oder gelöscht, wenn das angegebene Etag mit dem aktuellen Etag-Wert der Ressource übereinstimmt. SDK-Standardtext
--included-regions [komplexer Typ]

Regionen, die in die Datenerfassung einbezogen werden sollen. Die Regions-ID. Beispiel: us-ashburn-1. Mindestens eine Region ist erforderlich. Das ist ein komplexer Typ, dessen Wert ein gültiges JSON-Format aufweisen muss. Der Wert kann als Zeichenfolge in der Befehlszeile angegeben oder mit der Syntax file://path/to/file als Datei übergeben wird.

Mit der Option --generate-param-json-input können Sie ein Beispiel fur das JSON-Format generieren, das angegeben werden muss. Es wird empfohlen, dieses Beispiel in einer Datei nach Bedarf zu speichern und sie dann durch die Syntax file:// erneut zu übergeben.

--is-mutual-tls-required [boolesch] Erfordert gegenseitiges TLS (mTLS) bei der Authentifizierung von Verbindungen zur ADW-Datenbank.
--freeform-tags [komplexer Typ]

Freiformtags für diese Ressource. Jedes Tag ist ein Schlüssel/Wert-Paar ohne vordefinierten Namen, Typ oder Namespace. Weitere Informationen finden Sie unter Ressourcentags.

Beispiel:

{"Department": "Finance"}

Das ist ein komplexer Typ, dessen Wert ein gültiges JSON-Format aufweisen muss. Der Wert kann als Zeichenfolge in der Befehlszeile angegeben oder mit der Syntax file://path/to/file als Datei übergeben wird.

Mit der Option --generate-param-json-input können Sie ein Beispiel dafür für das JSON-Format generieren, das angegeben werden muss. Es wird empfohlen, dieses Beispiel in einer Datei nach Bedarf zu speichern und sie dann durch die Syntax file:// erneut zu übergeben.

SDK-Standardtext
--from-json [Text]

Geben Sie mit der Syntax file://path-to/file eine Eingabe für diesen Befehl als JSON-Dokument aus einer Datei an.

Mit der Option --generate-full-command-json-input können Sie eine json-Beispieldatei generieren, welche mit dieser Befehlsoption verwendet werden soll. Die Schlüsselnamen werden vorab aufgeladen und stimmen mit den Befehlsoptionsnamen (konvertiert in das camelCase-Format, z.B. compartment-id wird compartmentId) überein, während die Werte der Schlüssel vom Benutzer aufgefüllt werden müssen, bevor die Beispieldatei als Eingabe für diesen Befehl verwendet wird. Bei jeder Befehlsoption, die viele Werte akzeptiert, kann der Wert des Schlüssels ein JSON-Array sein.

Optionen können weiterhin in der Befehlszeile angegeben werden. Wenn eine Option sowohl im JSON-Dokument als auch im Befehlszeile vorhanden ist, werden die in der Befehlszeile angegebenen Werte verwendet.

Beispiele zur Verwendung dieser Option finden Sie unter Verwenden der CLI mit erweiterten JSON-Optionen

SDK-Standardtext
--force

Löschen ohne Bestätigung durchführen.

Führen Sie das Update aus, ohne zur Bestätigung aufzufordern.

SDK-Standardtext
--Lebenszyklusstatus [Text]

Ein Filter, der nur Ressourcen zurückgibt, die dem spezifischen Lebenszyklusstatus entsprechen. Beim Statuswert wird die Groß-/Kleinschreibung nicht beachtet.

Zulässige Werte sind:

ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
SDK-Standardtext
--limit [Ganzzahl] Für Listenpaginierung. Die maximale Anzahl an Ergebnissen pro Seite oder an Elementen, die in einem paginierten List-Aufruf zurückgegeben werden. Wichtige Informationen zur Funktionsweise der Paginierung finden Sie unter Listenpaginierung. SDK-Standardtext
--max-wait-seconds [integer] Die maximale Wartezeit, bis die Arbeitsanforderung den von --wait-for-state definierten Status erreicht. Der Standardwert beträgt 1200 Sekunden. SDK-Standardtext
--nsg-ids [komplexer Typ]

Liste der Netzwerksicherheitsgruppen-OCID. Das ist ein komplexer Typ, dessen Wert ein gültiges JSON-Format aufweisen muss. Der Wert kann als Zeichenfolge in der Befehlszeile angegeben oder mit der Syntax file://path/to/file als Datei übergeben wird.

Mit der Option --generate-param-json-input können Sie ein Beispiel fur das JSON-Format generieren, das angegeben werden muss. Es wird empfohlen, dieses Beispiel in einer Datei nach Bedarf zu speichern und sie dann durch die Syntax file:// erneut zu übergeben.

--page [Text] Für Listenpaginierung. Der Wert des opc-next-page-Antwortheaders aus dem vorherigen List-Aufruf. Wichtige Informationen zur Funktionsweise der Paginierung finden Sie unter Listenpaginierung. SDK-Standardtext
--page-size [Ganzzahl] Beim Abrufen der Ergebnisse die Anzahl der pro Aufruf abzurufenden Ergebnisse. Nur gültig bei Verwendung mit --all oder --limit, andernfalls ignoriert. SDK-Standardtext
--resource-analytics-instance-id [text]

Die OCID der ResourceAnalyticsInstance.

Die OCID einer ResourceAnalyticsInstance.

--resource-id [text] Die OCID der Ressource, die von der Arbeitsanforderung betroffen ist. SDK-Standardtext
--sort-by [Text]

Das Feld, nach dem sortiert werden soll. Sie können nur eine Sortierreihenfolge angeben. Die Standardreihenfolge für TIME_CREATED ist absteigend. Die Standardreihenfolge für DISPLAY_NAME ist aufsteigend.

Zulässige Werte sind:

DISPLAY_NAME, TIME_CREATED

Das Feld, nach dem sortiert werden soll. Es kann nur eine Sortierreihenfolge angegeben werden. Die Standardreihenfolge für timeAccepted ist absteigend.

Zulässige Werte sind:

timeAccepted
SDK-Standardtext
--sort-order [text]

Die zu verwendende Sortierreihenfolge, entweder aufsteigend (ASC) oder absteigend (DESC).

Zulässige Werte sind:

ASC, DESC
SDK-Standardtext
--status [Text]

Ein Filter, der nur die Ressourcen zurückgibt, die dem spezifischen Lebenszyklusstatus entsprechen.

Zulässige Werte sind:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
SDK-Standardtext
--Subnetz-ID [Text] Die OCID des Subnetzes, mit dem die Ressource verknüpft ist.
--wait-for-state [text]

Dieser Vorgang erstellt, ändert oder löscht eine Ressource asynchron und verwendet eine Arbeitsanforderung, um den Fortschritt des Vorgangs zu verfolgen. Geben Sie diese Option ein, um die Aktion auszuführen, und warten Sie dann, bis die Arbeitsanforderung einen bestimmten Status erreicht. Es können mehrere Status angegeben werden. Eine Rückgabe erfolgt beim Erreichen des ersten Status. Beispiel: Mit --wait-for-state SUCCEEDED --wait-for-state FAILED erfolgt eine Rückgabe, sobald einer der beiden Lebenszyklusstatus erreicht wird. Wenn der Timeout erreicht ist, wird der Return Code 2 zurückgegeben. Bei jedem anderen Fehler wird der Return Code 1 zurückgegeben.

Zulässige Werte sind:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
SDK-Standardtext
--wait-interval-seconds [Ganzzahl] Prüfen Sie alle --wait-interval-seconds, um festzustellen, ob die Arbeitsanforderung den durch --wait-for-state definierten Status erreicht hat. Der Standardwert beträgt 30 Sekunden. SDK-Standardtext
--work-request-id [text] Die OCID der asynchronen Arbeitsanforderung. SDK-Standardtext