Utilisation de l'interface de ligne de commande

Affichage de l'aide relative à l'interface de ligne de commande

Vous pouvez afficher l'aide relative à la ligne de commande.

Transmission d'une entrée complexe

Les entrées complexes, comme les tableaux et les objets avec plusieurs valeurs, sont transmises au format JSON et peuvent être fournies en tant que chaînes sur la ligne de commande, en tant que fichiers, ou en tant que chaînes de ligne de commande et que fichiers.

MacOS, Linux ou Unix

La commande suivante indique comment transmettre deux valeurs pour l'objet --metadata.

oci os bucket create -ns mynamespace --name mybucket --metadata '{"key1":"value1","key2":"value2"}' --compartment-id ocid1.compartment.oc1..<example>

Windows

La commande suivante indique comment transmettre deux valeurs pour l'objet --metadata sous Windows.

oci os bucket create -ns mynamespace --name mybucket --metadata "{\"key1\":\"value1\",\"key2\":\"value2\"}" --compartment-id ocid1.compartment.oc1..<example>

Pour plus d'informations sur l'utilisation des chaînes JSON, reportez-vous à Options JSON avancées.

Formatage de la sortie sous forme de table

Par défaut, toutes les réponses à une commande sont renvoyées au format JSON. Par exemple, une réponse telle que la suivante est renvoyée lorsque vous exécutez la commande permettant d'obtenir la liste des régions.

{
  "data": [
    {
      "key": "FRA",
      "name": "eu-frankfurt-1"
    },
    {
      "key": "IAD",
      "name": "us-ashburn-1"
    },
    {
      "key": "ICN",
      "name": "ap-seoul-1"
    },
    {
      "key": "PHX",
      "name": "us-phoenix-1"
    },
    {
      "key": "LHR",
      "name": "uk-london-1"
    },
    {
      "key": "NRT",
      "name": "ap-tokyo-1"
    },			
    {
      "key": "YYZ",
      "name": "ca-toronto-1"
    }				
  ]
}

Dans certains cas, la lisibilité peut devenir un problème, facilement résolu en formatant la réponse sous forme de table. Pour obtenir une réponse à une commande sous forme de table, exécutez la commande suivante.

oci iam region list --output table

L'exemple de liste de régions suivant est renvoyé dans une table à deux colonnes.

+-----+----------------+
| key | name           |
+-----+----------------+
| FRA | eu-frankfurt-1 |
| IAD | us-ashburn-1   |
| ICN | ap-seoul-1     |
| PHX | us-phoenix-1   |
| NRT | ap-tokyo-1     |				
| LHR | uk-london-1    |
| YYZ | ca-toronto-1   |  
+-----+----------------+

Utilisation de requêtes

Vous pouvez filtrer la sortie à l'aide de l'option --query pour JSON. Cette option utilise le langage de requête JMESPath pour JSON.

Le filtrage est très utile lorsque vous traitez de grandes quantités de sorties. Par exemple, la commande suivante renvoie la liste de tous les compartiments :

oci iam compartment list --all

Cette commande renvoie de nombreuses informations. Certains des champs renvoyés sont compartment-id, name, lifecycle-state et defined-tags.

Sélection des champs à afficher

Vous pouvez sélectionner uniquement les champs voulus en spécifiant le nom du tableau et le nom des champs, transmis sous forme de tableau dont le contenu est délimité par des virgules :

oci iam compartment list --all --query "data[].[name, \"lifecycle-state\"]"

[ 
  [
    "ATestCompartment",
    "ACTIVE"
  ],
  
  [
    "blocktest",
    "ACTIVE"
  ],
  [
    "ZestyTest",
    "ACTIVE"
  ]
]

<name of the array>[].{<your custom name>:<the name of the field>}

oci iam compartment list --all --query "data[].{Name:name, \"LifecycleState\":\"lifecycle-state\"}"

[
  {
    "LifecycleState": "ACTIVE",
    "Name": "ATestCompartment"
  },
  {
    "LifecycleState": "ACTIVE",
    "Name": "blocktest"
  },
  {
    "LifecycleState": "ACTIVE",
    "Name": "ZestyTest"
  }
]

Spécification de conditions de recherche

oci iam compartment list --all --query "data[?name=='blocktest']"

[
  {
    "compartment-id": "ocid1.tenancy.oc1..<example_value>",
    "defined-tags": {
      "MySpecialTag": {
        "Phonebook": "software-development-kit"
      }
    },
    "description": "Compartment used by integration tests. 10000",
    "freeform-tags": {},
    "id": "ocid1.compartment.oc1..<example>",
    "inactive-status": null,
    "is-accessible": null,
    "lifecycle-state": "ACTIVE",
    "name": "blocktest",
    "time-created": "2018-06-19T17:08:46.059000+00:00"
  }
]

oci iam compartment list --all --query "data[?\"time-created\"<'2019'&&\"defined-tags\".MySpecialTag!=null].[name, \"lifecycle-state\"]"

[
  [
    "blocktest",
    "ACTIVE"
  ]
]

Pour plus d'informations sur le langage de requête JMESPath pour JSON, reportez-vous à JMESPath.

Ordre de priorité pour l'entrée JSON

L'interface de ligne de commande prend en charge la combinaison d'arguments sur la ligne de commande avec l'entrée de fichier. Toutefois, si les mêmes valeurs sont fournies dans un fichier et sur la ligne de commande, celle-ci est prioritaire.

Utilisation d'un fichier JSON pour les entrées complexes

Vous pouvez transmettre les entrées complexes d'un fichier en le référençant à partir de la ligne de commande. Pour les utilisateurs Windows, cela signifie que le texte JSON n'a plus besoin de faire l'objet d'un échappement. Indiquez le chemin du fichier à l'aide du préfixe file://.

Types de chemin

En prenant pour exemple testfile.json, les types de chemin suivants sont pris en charge.

• Chemins relatifs d'un même répertoire, par exemple : file://testfile.json et file://relative/path/to/testfile.json
• Chemins absolus sous Linux, MacOS ou Unix, par exemple : file:///absolute/path/to/testfile.json
• Chemins de fichier complets sous Windows, par exemple : file://C:\path\to\testfile.json

Emplacements de fichier

Les emplacements de fichier suivants sont pris en charge.

• Répertoire de base.

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://~/testfile.json

• Répertoire en cours.

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://testfile.json

• Répertoire /tmp (Linux, Unix ou MacOS).

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file:///tmp/testfile.json

• Répertoire C:\temp (Windows).

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://C:\temp\testfile.json

Exemples d'utilisation d'un fichier JSON en tant qu'entrée

Les exemples de cette section utilisent un fichier JSON généré pour une option de commande et pour une commande complète. Le fichier JSON est enregistré dans un fichier, modifié, puis utilisé comme entrée de ligne de commande.

Utilisation de l'entrée de fichier pour une option de commande

L'exemple complet montre comment générer le fichier JSON pour une option d'ID de liste de sécurité utilisée afin de créer un sous-réseau. Le fichier JSON est enregistré dans un fichier, modifié, puis utilisé comme entrée de ligne de commande.

Utilisation d'Object Storage

Vous pouvez utiliser l'interface de ligne de commande pour plusieurs opérations d'objet avec le service Object Storage.

Téléchargement vers le serveur et en local de fichiers

Les objets peuvent être téléchargés vers le serveur à partir d'un fichier ou de la ligne de commande (STDIN), ainsi que téléchargés en local dans un fichier ou la ligne de commande (STDOUT).

Pour télécharger un objet vers le serveur, utilisez la commande suivante :

oci os object put -ns mynamespace -bn mybucket --name myfile.txt --file /Users/me/myfile.txt --metadata '{"key1":"value1","key2":"value2"}'

Pour télécharger le contenu d'un objet vers le serveur à partir de la ligne de commande (STDIN), utilisez la commande suivante :

oci os object put -ns mynamespace -bn mybucket --name myfile.txt --file <--'object content'

Pour télécharger un objet en local, utilisez la commande suivante :

oci os object get -ns mynamespace -bn mybucket --name myfile.txt --file /Users/me/myfile.txt

Pour imprimer le contenu d'un objet dans la ligne de commande (STDOUT), utilisez la commande suivante :

oci os object get -ns mynamespace -bn mybucket --name myfile.txt --file -

Opérations en masse dans Object Storage

L'interface de ligne de commande prend en charge les opérations en masse suivantes dans Object Storage :

• Téléchargement des fichiers d'un répertoire et de tous ses sous-répertoires vers un bucket

  # Upload all the files in a directory.
  oci os object bulk-upload -ns mynamespace -bn mybucket --src-dir path/to/upload/directory

• Téléchargement de tous les objets, ou de tous les objets correspondant à un préfixe donné, dans un bucket

  # Download all the objects.
  oci os object bulk-download -ns mynamespace -bn mybucket --download-dir path/to/download/directory
  						
  # Download all the objects that match the specified prefix.
  oci os object bulk-download -ns mynamespace -bn mybucket --download-dir path/to/download/directory --prefix myprefix

• Suppression de tous les objets, ou de tous les objets correspondant à un préfixe donné, dans un bucket

  # Delete all the objects.
  oci os object bulk-delete -ns mynamespace -bn mybucket
  			
  # Delete objects that match the specified prefix.
  oci os object bulk-delete -ns mynamespace -bn mybucket --prefix myprefix

Les opérations en masse prennent en charge plusieurs options qui vous permettent d'effectuer les actions suivantes :

• Ecraser ou ignorer des fichiers/objets avec --overwrite ou --no-overwrite. (Remarque : si vous ne transmettez aucune de ces options, vous êtes invité à confirmer l'opération chaque fois qu'un élément doit être écrasé.)
• Limiter les opérations de suppression, de téléchargement vers le serveur ou de téléchargement en local avec --prefix et/ou --delimiter.
• Prévisualiser une suppression en masse avec --dry-run.

Pour obtenir plus d'informations sur les commandes des opérations en masse, exécutez les commandes d'aide suivantes :

# bulk-upload
oci os object bulk-upload -h
				
# bulk-download
oci os object bulk-download -h
				
# bulk-delete
oci os object bulk-delete -h

Opérations multipart dans Object Storage

Les opérations multipart pour Object Storage incluent les téléchargements d'objets vers le serveur et en local.

Téléchargements multipart vers le serveur

Les fichiers volumineux peuvent être téléchargés vers Object Storage en plusieurs parties pour accélérer le processus. Par défaut, les fichiers dépassant 128 Mio sont téléchargés vers le serveur à l'aide d'opérations multipart. Vous pouvez remplacer ce paramètre par défaut à l'aide de l'option --no-multipart.

Vous pouvez configurer les options suivantes pour la commande oci os object put :

• --no-multipart remplace un téléchargement multipart automatique vers le serveur si la taille de l'objet est supérieure à 128 Mio. L'objet est téléchargé vers le serveur en une seule partie, quelle que soit sa taille.
• --part-size en Mio, à utiliser dans une opération multipart. La taille par défaut d'une partie est de 128 Mio et la taille indiquée doit être supérieure à 10 Mio. Si la taille de l'objet est supérieure à --part-size, il est téléchargé vers le serveur en plusieurs parties.
• --parallel-upload-count, pour indiquer le nombre d'opérations parallèles à effectuer. Vous pouvez utiliser cette valeur pour équilibrer les ressources et le temps de téléchargement vers le serveur. Une valeur plus élevée peut optimiser le temps, mais utilise davantage de ressources système et de bande passante réseau. La valeur par défaut est 10.

La commande --resume-put permet de reprendre un téléchargement de fichiers volumineux vers le serveur dans le cas où celui-ci a été interrompu.

L'exemple ci-dessous présente la commande pour un téléchargement multipart vers le serveur si la taille de l'objet est supérieure à 200 Mio.

oci os object put -ns my-namespace -bn my-bucket --file path/to/large/file --part-size 200

Pour plus d'informations sur les téléchargements multipart vers le serveur, reportez-vous à Utilisation des téléchargements multipart vers le serveur.

Téléchargements multipart en local

Les fichiers volumineux peuvent être téléchargés en local à partir d'Object Storage en plusieurs parties pour accélérer le processus.

Vous pouvez configurer les options suivantes pour la commande oci os object get :

• --multipart-download-threshold vous permet de spécifier la taille en Mio à partir de laquelle un objet doit être téléchargé en local en plusieurs parties. Cette taille doit être d'au moins 128 Mio.
• --part-size, en Mio, à utiliser pour une partie téléchargée en local. Ainsi, vous pouvez utiliser plus (petite taille) ou moins (grande taille) de parties selon vos besoins. Par exemple, en fonction de la puissance de calcul et de la bande passante réseau. La taille minimale par défaut d'une partie est de 120 Mio.
• --parallel-download-count vous permet de spécifier le nombre de parties téléchargées en local en même temps. Une valeur plus élevée peut optimiser le temps, mais utilise davantage de ressources système et de bande passante réseau. La valeur par défaut est 10.

L'exemple suivant présente la commande permettant de télécharger en local tout objet dont la taille est supérieure à 500 Mio. L'objet est téléchargé en local avec des parties de 128 Mio.

oci os object get -ns my-namespace -bn my-bucket --name my-large-object --multipart-download-threshold 500 --part-size 128