Commandes de l'interface de ligne de commande

Liste des commandes de l'interface de ligne de commande pour l'analyse des ressources.

Commande Description Obligatoire Facultatif
oci resource-analytics -h
Utilisez l'interface de ligne de commande du plan de contrôle d'analyse des ressources pour gérer les instances d'analyse des ressources et leurs attachements de location, ou pour activer/désactiver OAC sur les instances ADW.
Instance d'analyse des ressources
oci resource-analytics resource-analytics-instance -h
Un ResourceAnalyticsInstance est une analyse de logement ADW pour toutes les ressources OCI d'un client.
oci resource-analytics resource-analytics-instance create [OPTIONS]
Crée un fichier ResourceAnalyticsInstance. --adw-admin-password-password [text]--compartment-id, -c [text]--included-regions [complex type]--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]
Déplace un élément ResourceAnalyticsInstance vers un autre compartiment au sein de la même location. Pour des informations sur le déplacement des ressources entre des compartiments, voir Déplacement des ressources vers un autre compartiment.

--compartment-id, -c [texte]

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

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

oci resource-analytics resource-analytics-instance delete [OPTIONS]
Supprime une ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--force

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

oci resource-analytics resource-analytics-instance disable-oac [OPTIONS]
Désactivez une instance OAC pour ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

oci resource-analytics resource-analytics-instance enable-oac [OPTIONS]
Attache une instance OAC à ResourceAnalyticsInstance.

--attachment-details [type complexe]

--type de pièce jointe [texte]

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

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

oci resource-analytics resource-analytics-instance get [OPTIONS]
Obtient des informations sur un fichier ResourceAnalyticsInstance. --resource-analytics-instance-id [text] --from-json [texte]
oci resource-analytics resource-analytics-instance list [OPTIONS]
Obtient la liste ResourceAnalyticsInstances.

--tous les éléments

--compartment-id, -c [texte]

--display-name [texte]

--from-json [texte]

--id [texte]

--lifecycle-state [texte]

--limit [entier]

--page [texte]

--page-size [entier]

--sort-par [texte]

--ordre de tri [texte]

oci resource-analytics resource-analytics-instance update [OPTIONS]
Met à jour un fichier ResourceAnalyticsInstance. --resource-analytics-instance-id [text]

--defined-tags [type complexe]

--description [texte]

--display-name [texte]

--force

--freeform-tags [type complexe]

--from-json [texte]

--if-match [texte]

--included-regions [type complexe]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

Fichiers joints de location
oci resource-analytics tenancy-attachment -h
Une location TenancyAttachment est une location de client attachée à ResourceAnalyticsInstance. Les locations attachées sont incluses dans la collection d'analyses.
oci resource-analytics tenancy-attachment create [OPTIONS]
Crée un fichier 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]
Supprime une TenancyAttachment. --tenancy-attachment-id [texte]

--force

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

oci resource-analytics tenancy-attachment get [OPTIONS]
Obtient des informations sur un fichier TenancyAttachment. --tenancy-attachment-id [texte] --from-json [texte]
oci resource-analytics tenancy-attachment list [OPTIONS]
Obtient la liste TenancyAttachments.

--tous les éléments

--from-json [texte]

--id [texte]

--lifecycle-state [texte]

--limit [entier]

--page [texte]

--page-size [entier]

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

--sort-par [texte]

--ordre de tri [texte]

oci resource-analytics tenancy-attachment update [OPTIONS]
Met à jour un fichier TenancyAttachment.

--description [texte]

--tenancy-attachment-id [texte]

--from-json [texte]

--if-match [texte]

--max-wait-seconds [entier]

--wait-for-state [texte]

--wait-interval-seconds [entier]

Demandes de travail
oci resource-analytics work-request -h
Demande de travail asynchrone. Les demandes de travail vous aident à surveiller les opérations de longue durée. Lorsque vous lancez une opération de longue durée, le service crée une demande de travail. Une demande de travail est un journal d'activité qui vous permet d'effectuer le suivi de chaque étape de la progression de l'opération. Chaque demande de travail dispose d'un OCID qui vous permet d'interagir avec elle par programmation et de l'utiliser pour l'automatisation.
oci resource-analytics work-request cancel [OPTIONS]
Annule une demande de travail. --work-request-id [texte]

--force

--from-json [texte]

--if-match [texte]

oci resource-analytics work-request get [OPTIONS]
Obtient les détails d'une demande de travail. --work-request-id [texte] --from-json [texte]
oci resource-analytics work-request list [OPTIONS]
Liste les demandes de travail d'un compartiment.

--tous les éléments

--compartment-id, -c [texte]

--from-json [texte]

--limit [entier]

--page [texte]

--page-size [entier]

--resource-id [texte]

--sort-par [texte]

--ordre de tri [texte]

--status [text]

--work-request-id [texte]

Erreurs de demande de travail
oci resource-analytics work-request-error -h
Une erreur s'est produite lors de l'exécution d'une opération suivie par une demande de travail.
oci resource-analytics work-request-error list [OPTIONS]
Répertorie les erreurs pour une demande de travail. --work-request-id [texte]

--tous les éléments

--from-json [texte]

--limit [entier]

--page [texte]

--page-size [entier]

--sort-par [texte]

--ordre de tri [texte]

Journaux de demande de travail
oci resource-analytics work-request-log-entry -h
Message de journal de l'exécution d'une opération suivie par une demande de travail.
oci resource-analytics work-request-log-entry list [OPTIONS]
Répertorie les journaux pour une demande de travail. --work-request-id [texte]

--tous les éléments

--from-json [texte]

--limit [entier]

--page [texte]

--page-size [entier]

--sort-par [texte]

--ordre de tri [texte]

Descriptions des paramètres

Paramètre Description Texte standard de la trousse SDK
--adw-admin-password-password [texte] Mot de passe pour que ADW soit créé dans la location d'utilisateur. Le mot de passe doit comporter entre 12 et 30 caractères et doit contenir au moins 1 majuscule, 1 minuscule et 1 caractère numérique. Il ne peut pas contenir le symbole de guillemet double " ou le nom d'utilisateur, admin, quelle que soit la casse.
--tous les éléments Extrait toutes les pages de résultats. Si vous indiquez cette option, vous ne pouvez pas fournir l'option --limit. Texte standard de la trousse SDK
--attachment-details [type complexe]

Il s'agit d'un type complexe dont la valeur doit être dans un format JSON valide. La valeur peut être fournie sous forme de chaîne sur la ligne de commande ou transmise en tant que fichier en utilisant la syntaxe file://path/to/file.

L'option --generate-param-json-input peut servir à générer un exemple de JSON, qui doit être fourni. Nous recommandons de stocker cet exemple dans un fichier, de le modifier au besoin, puis de le retransmettre en utilisant la syntaxe file://.

--type de pièce jointe [texte]

Type d'attachement utilisé par l'instance OAC.

Les valeurs acceptées sont les suivantes :

MANAGED
--compartment-id, -c [texte] OCID du compartiment dans lequel créer ResourceAnalyticsInstance. OCID du compartiment vers lequel déplacer ResourceAnalyticsInstance. OCID du compartiment dans lequel lister les ressources.
--defined-tags [type complexe]

Marqueurs définis pour cette ressource. Chaque clé est prédéfinie et porte sur un espace de noms. Pour plus d'informations, voir Marqueurs de ressource.

Exemple :

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

Il s'agit d'un type complexe dont la valeur doit être dans un format JSON valide. La valeur peut être fournie sous forme de chaîne sur la ligne de commande ou transmise en tant que fichier en utilisant la syntaxe file://path/to/file.

L'option --generate-param-json-input peut servir à générer un exemple de JSON, qui doit être fourni. Nous recommandons de stocker cet exemple dans un fichier, de le modifier au besoin, puis de le retransmettre en utilisant la syntaxe file://.

Texte standard de la trousse SDK
--description [texte] Description de l'instance ResourceAnalyticsInstance. Description de la location.
--display-name [texte] Nom convivial. Il ne doit pas nécessairement être unique et il est modifiable. N'entrez pas d'informations confidentielles. Filtre qui retourne uniquement les ressources correspondant exactement au nom d'affichage particulier.
--id [texte]

OCID de ResourceAnalyticsInstance.

OCID de TenancyAttachment.

--if-match [texte] Pour un contrôle optimiste des accès simultanés. Dans l'appel PUT ou DELETE pour une ressource, réglez le paramètre if-match à la valeur de l'étag à partir d'une réponse précédente GET ou POST pour cette ressource. La ressource est mise à jour ou supprimée uniquement si l'étag que vous fournissez correspond à la valeur etag courante de la ressource. Texte standard de la trousse SDK
--included-regions [type complexe]

Régions à inclure dans la collecte de données. ID région, par exemple us-ashburn-1. Au moins une région est requise. Il s'agit d'un type complexe dont la valeur doit être dans un format JSON valide. La valeur peut être fournie sous forme de chaîne sur la ligne de commande ou transmise en tant que fichier en utilisant la syntaxe file://path/to/file.

L'option --generate-param-json-input peut servir à générer un exemple de JSON, qui doit être fourni. Nous recommandons de stocker cet exemple dans un fichier, de le modifier au besoin, puis de le retransmettre en utilisant la syntaxe file://.

--is-mutual-tls-required [booléen] Exiger le protocole TLS mutuel (mTLS) lors de l'authentification des connexions à la base de données ADW.
--freeform-tags [type complexe]

Marqueurs à structure libre pour la ressource. Chaque marqueur est une paire clé-valeur sans nom, type ni espace de nom prédéfini. Pour plus d'informations, voir Marqueurs de ressource.

Exemple :

{"Department": "Finance"}

Il s'agit d'un type complexe dont la valeur doit être dans un format JSON valide. La valeur peut être fournie sous forme de chaîne sur la ligne de commande ou transmise en tant que fichier en utilisant la syntaxe file://path/to/file.

L'option --generate-param-json-input peut servir à générer un exemple de JSON, qui doit être fourni. Nous recommandons de stocker cet exemple dans un fichier, de le modifier au besoin, puis de le retransmettre en utilisant la syntaxe file://.

Texte standard de la trousse SDK
--from-json [texte]

Fournissez une entrée pour cette commande en tant que document JSON à partir d'un fichier à l'aide de la syntaxe file://path-to/file.

Vous pouvez utiliser l'option --generate-full-command-json-input pour générer un fichier-échantillon json à utiliser avec cette option de commande. Les noms de clé sont préalimentés et correspondent aux noms des options de commande (convertis au format camelCase, par exemple, compartment-id devient compartmentId), tandis que les valeurs des clés doivent être indiquées par l'utilisateur avant d'utiliser le fichier-échantillon en tant qu'entrée pour cette commande. Pour toute option de commande acceptant de nombreuses valeurs, la valeur de la clé peut être un tableau JSON.

Des options peuvent toujours être fournies sur la ligne de commande. Si une option existe à la fois dans le document JSON et dans la ligne de commande, la valeur indiquée pour cette dernière est utilisée.

Pour des exemples d'utilisation de cette option, voir Utilisation de l'interface de ligne de commande avec des options JSON avancées.

Texte standard de la trousse SDK
--force

Effectuez la suppression sans demander de confirmation.

Effectuez la mise à jour sans demander de confirmation.

Texte standard de la trousse SDK
--lifecycle-state [texte]

Filtre pour retourner uniquement les ressources correspondant à l'état de cycle de vie spécifique. La valeur de l'état n'est pas sensible à la casse.

Les valeurs acceptées sont les suivantes :

ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
Texte standard de la trousse SDK
--limit [entier] Pour la pagination de liste. Nombre maximal de résultats par page, ou d'éléments à retourner dans un appel List paginé. Pour des détails importants sur le fonctionnement de la pagination, voir Pagination de liste. Texte standard de la trousse SDK
--max-wait-seconds [entier] Temps maximal d'attente de la demande de travail pour atteindre l'état défini par --wait-for-state. La valeur par défaut est 1200 secondes. Texte standard de la trousse SDK
--nsg-ids [type complexe]

Liste des OCID du groupe de sécurité de réseau. Il s'agit d'un type complexe dont la valeur doit être dans un format JSON valide. La valeur peut être fournie sous forme de chaîne sur la ligne de commande ou transmise en tant que fichier en utilisant la syntaxe file://path/to/file.

L'option --generate-param-json-input peut servir à générer un exemple de JSON, qui doit être fourni. Nous recommandons de stocker cet exemple dans un fichier, de le modifier au besoin, puis de le retransmettre en utilisant la syntaxe file://.

--page [texte] Pour la pagination de liste. Valeur de l'en-tête de réponse opc-next-page de l'appel List précédent. Pour des détails importants sur le fonctionnement de la pagination, voir Pagination de liste. Texte standard de la trousse SDK
--page-size [entier] Lors de l'extraction des résultats, le nombre de résultats à extraire par appel. Valide uniquement lorsqu'elle est utilisée avec --all ou --limit, et ignorée dans les autres cas. Texte standard de la trousse SDK
--resource-analytics-instance-id [text]

OCID de ResourceAnalyticsInstance.

OCID d'un ResourceAnalyticsInstance.

--resource-id [texte] OCID de la ressource affectée par la demande de travail. Texte standard de la trousse SDK
--sort-par [texte]

Champ de tri. Vous ne pouvez fournir qu'un seul ordre de tri. L'ordre par défaut de TIME_CREATED est décroissant. L'ordre par défaut pour DISPLAY_NAME est croissant.

Les valeurs acceptées sont les suivantes :

DISPLAY_NAME, TIME_CREATED

Champ de tri. Un seul ordre de tri peut être indiqué. L'ordre par défaut pour timeAccepted est décroissant.

Les valeurs acceptées sont les suivantes :

timeAccepted
Texte standard de la trousse SDK
--ordre de tri [texte]

Ordre de tri à utiliser, croissant (ASC) ou décroissant (DESC).

Les valeurs acceptées sont les suivantes :

ASC, DESC
Texte standard de la trousse SDK
--status [text]

Filtre pour retourner uniquement les ressources correspondant à l'état de cycle de vie spécifique.

Les valeurs acceptées sont les suivantes :

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
Texte standard de la trousse SDK
--subnet-id [texte] OCID du sous-réseau auquel la ressource est associée.
--wait-for-state [texte]

Cette opération crée, modifie ou supprime une ressource de manière asynchrone et utilise une demande de travail pour suivre la progression de l'opération. Spécifiez cette option pour exécuter l'action, puis patienter jusqu'à ce que la demande de travail atteigne un certain état. Plusieurs états peuvent être spécifiés, avec retour sur le premier. Par exemple, --wait-for-state SUCCEEDED --wait-for-state FAILED retournerait au premier état du cycle de vie atteint. Si le délai est dépassé, un code de retour de 2 est renvoyé. Pour toute autre erreur, un code de retour 1 est renvoyé.

Les valeurs acceptées sont les suivantes :

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
Texte standard de la trousse SDK
--wait-interval-seconds [entier] Vérifiez chaque --wait-interval-seconds pour voir si la demande de travail a atteint l'état défini par --wait-for-state. La valeur par défaut est 30 secondes. Texte standard de la trousse SDK
--work-request-id [texte] OCID de la demande de travail asynchrone. Texte standard de la trousse SDK