OpenStack command line clients/fr: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Created page with "===Commandes <code>volume</code>=== {|- |<code>create</code>||<code>set</code> |- |<code>delete</code>||<code>show</code> |- |<code>list</code>||<code>unset</code> |}")
No edit summary
 
(51 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>


''Parent page: [[OpenStack]]''
''Page enfant de [[Managing your cloud resources with OpenStack]]''


The [http://docs.openstack.org/developer/python-openstackclient/ OpenStack command line tool] allows you to perform many of the actions provided by the OpenStack dashboard GUI, as well as providing some functionality which the dashboard does not. The command line client can be used from any machine, virtual or otherwise, and only requires having an internet connection and the client installed. The discussion below assumes that it is being used on a Linux machine.
[http://docs.openstack.org/developer/python-openstackclient/ OpenStackClient] permet d'utiliser plusieurs fonctions du tableau de bord OpenStack, ainsi que d'autres fonctions qui ne sont pas disponibles par l'interface graphique. Pour l'utiliser sur tout genre de machine, virtuelle ou autre, il suffit d'installer le client et de disposer d'une connexion Internet. Les exemples de cette page sont sous Linux.


==Installation==
==Installation==
The OpenStack command lines tools are Python-based. You can install and run them on your personal computer or on a cloud VM. Different Linux distributions may have pre-built packages for the client, see the OpenStack [http://docs.openstack.org/cli-reference/common/cli_install_openstack_command_line_clients.html installation documentation] for more details. You can quickly install both Python and the OpenStack command line tools, if you have administrative privileges on your machine.
Les outils ligne de commande OpenStack sont pour Python et fonctionnent sur un ordinateur personnel ou sur une instance infonuagique. Les différentes distributions  de Linux peuvent offrir des paquets précompilés; pour les détails, consultez la [https://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html documentation d'installation]. Si vous avez les permissions d'administrateur, vous pouvez rapidement installer Python et les outils ligne de commande OpenStack.


; Ubuntu
; Ubuntu
Line 14: Line 14:
</pre>
</pre>
; CentOS 7
; CentOS 7
Run as root
Exécuter en tant que root.
<pre>
<pre>
yum install epel-release
yum install epel-release
Line 24: Line 24:
sudo dnf install python-openstackclient
sudo dnf install python-openstackclient
</pre>
</pre>
; Note: If you do not have administrative privileges and cannot use the OS package manager, then you will need to install Python and [https://pip.pypa.io/en/latest/installing/ pip] by other means. Once installed, you can get the command line tools installed into your home space like so:
; Note: Si vous ne possédez pas les permissions d'administrateur, vous devez installer Python et [https://pip.pypa.io/en/latest/installing/ pip] autrement. Une fois l'installation complétée, vous pouvez installer les outils ligne de commande dans votre espace ''home'' comme suit&nbsp;:
<pre>
<pre>
pip install --user python-openstackclient
pip install --user python-openstackclient
</pre>
</pre>
: The install location is probably already included in your <code>$PATH</code>, but you can double check whether <code>~/.bashrc</code> or <code>~/.bash_profile</code> contains the following line <code>PATH=$PATH:$HOME/.local/bin:$HOME/bin</code>
: La destination de l'installation est probablement incluse dans le <code>$PATH</code>; vous pouvez cependant vérifier si <code>~/.bashrc</code> ou <code>~/.bash_profile</code> inclut la ligne <code>PATH=$PATH:$HOME/.local/bin:$HOME/bin</code>.


; SDK
; SDK
If you wish to explore the [http://docs.openstack.org/user-guide/sdk.html OpenStack API for Python], add <code>export PYTHONPATH=${HOME}/.local/lib/python2.7/site-packages/:${PYTHONPATH}</code> to your <code>.bashrc</code> file. Adjust the <code>python2.7</code> phrase to match the Python version you have installed.
Pour explorer les [http://docs.openstack.org/user-guide/sdk.html APIs pour Python], ajoutez <code>export PYTHONPATH=${HOME}/.local/lib/python2.7/site-packages/:${PYTHONPATH}</code> et modifiez  <code>python2.7</code> en fonction de la version de Python installée.


==Connecting CLI to OpenStack==
==Connecter le client ligne de commande à OpenStack==
Your command line client must now be told how to find your OpenStack project on the CC-Cloud.  
Vous devez indiquer au client où trouver le projet OpenStack dans notre environnement infonuagique.  
The most convenient way to do this is to download an OpenStack environment setup file. On the OpenStack dashboard go to Compute-> Access & Security-> API Access-> Download OpenStack RC File.  
Le moyen le plus simple est de télécharger un fichier de configuration via le tableau de bord OpenStack, ainsi&nbsp;: ''Projet -> Accès API -> Télécharger le fichier RC d’OpenStack''.  


On East-cloud there are two RC files to choose from, a v2.0 and a v3 file. Unless you have a specific reason to choose v2.0, choose v3. If your OpenStack client version is version 2.5.0 or later, you will have to add the line <code>export OS_IDENTITY_API_VERSION=3</code> to the East-cloud v3 file.  
Exécutez ensuite la commande {{Commande |source <project name>-openrc.sh}}. Lorsque vous devez entrer le mot de passe OpenStack, entrez votre mot de passe pour notre base de données CCDB. Pour tester la configuration, entrez {{Commande |openstack image list}}.


Then source the file with something like {{Command |source <project name>-openrc.sh}} It will ask you for your OpenStack password, which is simply your CC-Cloud password. Test your setup by typing {{Command |openstack image list}}
Si vous utilisez plusieurs fichiers RC, méfiez-vous des variables d'environnement qui subsisteraient du dernier fichier RC utilisé car elles pourraient empêcher l'exécution des commandes client OpenStack. Vous pouvez contourner ce problème de deux manières&nbsp;: en détruisant les variables avec <code>unset <variable-name></code> ou en démarrant une nouvelle session sans variables définies.


If you switch between different RC files (e.g. east and west cloud RC files) you should be careful of environment variables which may still be set from the previous RC file, these may cause your OpenStack client commands to fail. Either ensure that all environment variables set in the RC file are unset with <code>unset <variable-name></code>, or start a fresh new session without any of the RC environment variables set.
==Exécuter les commandes==
Le client ligne de commande peut être utilisé interactivement en entrant
{{Commande|openstack}}


==Executing commands==
Entrez ensuite les commandes à l'invite. Chaque commande peut être entrée individuellement en la faisant précéder de <code>openstack</code>, par exemple
The CLI tool can be used interactively by typing
{{Commande|openstack server list}}
{{Command|openstack}}
En mode interactif, faites afficher la liste des commandes disponibles en entrant <code>help</code> à l'invite OpenStack. Les commandes disponibles sont classées en groupes; les plus communes sont présentées plus loin. Pour obtenir la liste des commandes appartenant à un groupe particulier, entrez <code>help <command group></code>. Pour obtenir les options et arguments liés à une commande, entrez <code>help <command group> <command></code>. Sachez que plusieurs commandes ne sont disponibles qu'aux utilisateurs ayant les permissions d'administrateur et que dans le cas contraire, un message d'erreur sera affiché. Les commandes qui suivent sont disponibles pour tous les utilisateurs.
and then issuing commands at the prompt. Alternatively the commands can be issued as one-offs by preceding the command with <code>openstack</code>, for example
{{Command|openstack server list}}
When running in interactive mode a list of available commands can be seen by typing <code>help</code> at the OpenStack prompt. The available commands are categorized by groups; many of the most commonly used groups are listed below. A list of commands belonging to a command group can be obtained by typing <code>help <command group></code>. To get help on a particular command (e.g. options and arguments of the command) one can type <code>help <command group> <command></code>. Note that many commands are available only to OpenStack administrators and will return an error message if a non-administrator tries using it. For this reason a list of available commands grouped by command groups is provided below to allow one to easily identify commands available to the average user.


==Groupes de commandes==
==Groupes de commandes==
Line 79: Line 78:
|}
|}


===<code>console</code> command group===
===Commandes <code>console</code>===
{|-
{|-
|<code>log show</code>||<code>url show</code>
|<code>log show</code>||<code>url show</code>
|}
|}
===<code>flavor</code> command group===
===Commandes <code>flavor</code>===
{|-
{|-
|<code>list</code>||<code>show</code>
|<code>list</code>||<code>show</code>
|}
|}
===<code>image</code> command group===
===Commandes <code>image</code>===
{|-
{|-
|<code>create</code>
|<code>create</code>
Line 99: Line 98:
|}
|}


===<code>ip</code> command group===
===Commandes <code>ip</code>===
{|-
{|-
|<code>fixed add</code>||<code>floating list</code>
|<code>fixed add</code>||<code>floating list</code>
Line 111: Line 110:
|<code>floating delete</code>
|<code>floating delete</code>
|}
|}
===<code>keypair</code> command group===
===Commandes <code>keypair</code>===
{|-
{|-
|<code>create</code>||<code>list</code>
|<code>create</code>||<code>list</code>
Line 118: Line 117:
|}
|}


===<code>network</code> command group===
===Commandes <code>network</code>===
{|-
{|-
|<code>create</code>||<code>set</code>
|<code>create</code>||<code>set</code>
Line 127: Line 126:
|}
|}


===<code>snapshot</code> command group===
===Commandes <code>snapshot</code>===
{|-
{|-
|<code>create</code>||<code>set</code>
|<code>create</code>||<code>set</code>
Line 136: Line 135:
|}
|}


===<code>security group</code> command group===
===Commandes <code>security group</code>===
{|-
{|-
|<code>create</code>||<code>rule list</code>
|<code>create</code>||<code>rule list</code>
Line 148: Line 147:
|<code>rule delete</code>||
|<code>rule delete</code>||
|}
|}
===<code>limits show</code>===
 
===Commandes <code>limits</code>===
{|-
|<code>show</code>||
|}
<!--These two (container and object) are not widely publicized
<!--These two (container and object) are not widely publicized
===container===
===container===
Line 174: Line 177:
-->
-->


[[Category:CC-Cloud]]
==Autres interfaces==
En plus de la commande <code>openstack</code> (décrite ci-dessus) qui incorpore dans une même commande la plupart des fonctionnalités, il existe aussi des commandes distinctes pour les divers composants OpenStack qui ajoutent d'autres fonctionnalités. Ces commandes sont installées en même temps que la commande <code>openstack</code> et aucune autre installation n'est nécessaire. Ces commandes sont :
* [https://docs.openstack.org/python-novaclient/latest/cli/nova.html <code>nova</code>] pour travailler avec des serveurs;
* [https://docs.openstack.org/python-glanceclient/latest/cli/glance.html <code>glance</code>] pour travailler avec des images;
* [https://docs.openstack.org/python-cinderclient/latest/user/shell.html <code>cinder</code>] pour travailler avec des volumes;
* [https://docs.openstack.org/python-heatclient/latest/man/heat.html <code>heat</code>] pour travailler avec l'orchestration.
 
[[Category: Cloud]]

Latest revision as of 19:01, 16 October 2024

Other languages:

Page enfant de Managing your cloud resources with OpenStack

OpenStackClient permet d'utiliser plusieurs fonctions du tableau de bord OpenStack, ainsi que d'autres fonctions qui ne sont pas disponibles par l'interface graphique. Pour l'utiliser sur tout genre de machine, virtuelle ou autre, il suffit d'installer le client et de disposer d'une connexion Internet. Les exemples de cette page sont sous Linux.

Installation

Les outils ligne de commande OpenStack sont pour Python et fonctionnent sur un ordinateur personnel ou sur une instance infonuagique. Les différentes distributions de Linux peuvent offrir des paquets précompilés; pour les détails, consultez la documentation d'installation. Si vous avez les permissions d'administrateur, vous pouvez rapidement installer Python et les outils ligne de commande OpenStack.

Ubuntu
sudo apt-get install python python-dev python-pip
sudo pip install python-openstackclient
CentOS 7

Exécuter en tant que root.

yum install epel-release
yum install gcc python python-dev python2-pip
pip install python-openstackclient
Fedora
sudo dnf install python-openstackclient
Note
Si vous ne possédez pas les permissions d'administrateur, vous devez installer Python et pip autrement. Une fois l'installation complétée, vous pouvez installer les outils ligne de commande dans votre espace home comme suit :
pip install --user python-openstackclient
La destination de l'installation est probablement incluse dans le $PATH; vous pouvez cependant vérifier si ~/.bashrc ou ~/.bash_profile inclut la ligne PATH=$PATH:$HOME/.local/bin:$HOME/bin.
SDK

Pour explorer les APIs pour Python, ajoutez export PYTHONPATH=${HOME}/.local/lib/python2.7/site-packages/:${PYTHONPATH} et modifiez python2.7 en fonction de la version de Python installée.

Connecter le client ligne de commande à OpenStack

Vous devez indiquer au client où trouver le projet OpenStack dans notre environnement infonuagique. Le moyen le plus simple est de télécharger un fichier de configuration via le tableau de bord OpenStack, ainsi : Projet -> Accès API -> Télécharger le fichier RC d’OpenStack.

Exécutez ensuite la commande

Question.png
[nom@serveur ~]$ source <project name>-openrc.sh

. Lorsque vous devez entrer le mot de passe OpenStack, entrez votre mot de passe pour notre base de données CCDB. Pour tester la configuration, entrez

Question.png
[nom@serveur ~]$ openstack image list

.

Si vous utilisez plusieurs fichiers RC, méfiez-vous des variables d'environnement qui subsisteraient du dernier fichier RC utilisé car elles pourraient empêcher l'exécution des commandes client OpenStack. Vous pouvez contourner ce problème de deux manières : en détruisant les variables avec unset <variable-name> ou en démarrant une nouvelle session sans variables définies.

Exécuter les commandes

Le client ligne de commande peut être utilisé interactivement en entrant

Question.png
[nom@serveur ~]$ openstack

Entrez ensuite les commandes à l'invite. Chaque commande peut être entrée individuellement en la faisant précéder de openstack, par exemple

Question.png
[nom@serveur ~]$ openstack server list

En mode interactif, faites afficher la liste des commandes disponibles en entrant help à l'invite OpenStack. Les commandes disponibles sont classées en groupes; les plus communes sont présentées plus loin. Pour obtenir la liste des commandes appartenant à un groupe particulier, entrez help <command group>. Pour obtenir les options et arguments liés à une commande, entrez help <command group> <command>. Sachez que plusieurs commandes ne sont disponibles qu'aux utilisateurs ayant les permissions d'administrateur et que dans le cas contraire, un message d'erreur sera affiché. Les commandes qui suivent sont disponibles pour tous les utilisateurs.

Groupes de commandes

Commandes server

add security group migrate resume unlock
add volume pause set unpause
create reboot shelve unrescue
delete rebuild show unset
dump create remove security group ssh unshelve
image create remove volume start
list rescue stop
lock resize suspend

Commandes volume

create set
delete show
list unset

Commandes console

log show url show

Commandes flavor

list show

Commandes image

create save
delete set
list show

Commandes ip

fixed add floating list
fixed remove floating pool list
floating add floating remove
floating create floating show
floating delete

Commandes keypair

create list
delete show

Commandes network

create set
delete show
list

Commandes snapshot

create set
delete show
list unset

Commandes security group

create rule list
delete rule show
list set
rule create show
rule delete

Commandes limits

show

Autres interfaces

En plus de la commande openstack (décrite ci-dessus) qui incorpore dans une même commande la plupart des fonctionnalités, il existe aussi des commandes distinctes pour les divers composants OpenStack qui ajoutent d'autres fonctionnalités. Ces commandes sont installées en même temps que la commande openstack et aucune autre installation n'est nécessaire. Ces commandes sont :

  • nova pour travailler avec des serveurs;
  • glance pour travailler avec des images;
  • cinder pour travailler avec des volumes;
  • heat pour travailler avec l'orchestration.