Citrix Hypervisor

Interface de ligne de commande

La CLI xe vous permet de créer des scripts et d’automatiser les tâches d’administration système. Utilisez l’interface de ligne de commande pour intégrer Citrix Hypervisor à une infrastructure informatique existante.

Installation de la CLI xe

L’interface de ligne de commande xe est installée par défaut sur tous les serveurs Citrix Hypervisor et est incluse avec XenCenter. Une CLI distante autonome est également disponible pour Linux.

Sous Windows

Sous Windows, la commande xe.exe est installée avec XenCenter.

Pour utiliser la commande xe.exe, ouvrez une invite de commande Windows et remplacez les répertoires par le répertoire dans lequel se trouve le fichier xe.exe (généralement C:\Program Files\Citrix\XenCenter). Si vous ajoutez l’emplacement d’installation xe.exe à votre chemin système, vous pouvez utiliser la commande sans avoir à vous déplacer dans le répertoire.

Sous Linux

Sur les distributions basées sur RPM (telles que Red Hat), vous pouvez installer la commande xe autonome à partir du RPM nommé client_install/xapi-xe-BUILD.x86_64.rpm sur l’ISO d’installation principale de Citrix Hypervisor.

Pour effectuer l’installation à partir du RPM, utilisez la commande suivante :

rpm -ivh xapi-xe-BUILD.x86_64.rpm
<!--NeedCopy-->

Vous pouvez utiliser les paramètres de la ligne de commande pour définir le serveur Citrix Hypervisor, le nom d’utilisateur et le mot de passe à utiliser lors de l’exécution des commandes xe. Toutefois, vous avez également la possibilité de définir ces informations en tant que variable d’environnement. Par exemple :

export XE_EXTRA_ARGS="server=<host name>,username=<user name>,password=<password>"
<!--NeedCopy-->

Remarque :

L’interface de ligne de commande distante xe sous Linux peut se bloquer lors de la tentative d’exécution de commandes via une connexion sécurisée et ces commandes impliquent le transfert de fichiers. Si tel est le cas, vous pouvez utiliser le paramètre --no-ssl pour exécuter la commande sur une connexion non sécurisée au serveur Citrix Hypervisor.

Obtenir de l’aide sur les commandes xe

L’aide de base est disponible pour les commandes CLI sur l’hôte en tapant :

xe help command
<!--NeedCopy-->

Une liste des commandes xe les plus couramment utilisées s’affiche si vous tapez :

xe help
<!--NeedCopy-->

Ou une liste de toutes les commandes xe s’affiche si vous tapez :

xe help --all
<!--NeedCopy-->

Syntaxe xe de base

La syntaxe de base de toutes les commandes CLI Citrix Hypervisor xe est la suivante :

xe command-name argument=value argument=value
<!--NeedCopy-->

Chaque commande spécifique contient son propre ensemble d’arguments de la forme argument=value. Certaines commandes ont des arguments obligatoires, et la plupart ont un ensemble d’arguments optionnels. En règle générale, une commande suppose des valeurs par défaut pour certains des arguments optionnels lorsqu’elle est invoquée sans eux.

Si la commande xe s’exécute à distance, des arguments supplémentaires sont utilisés pour se connecter et s’authentifier. Ces arguments prennent également la forme argument=argument_value.

L’argument server est utilisé pour spécifier le nom d’hôte ou l’adresse IP. Les arguments username et password sont utilisés pour spécifier les informations d’identification.

Un argument password-file peut être spécifié à la place du mot de passe directement. Dans ce cas, la commande xe tente de lire le mot de passe du fichier spécifié et utilise ce mot de passe pour se connecter. (Tous les CR et LF de fin à la fin du fichier sont supprimés.) Cette méthode est plus sûre que la spécification du mot de passe directement sur la ligne de commande.

L’argument port facultatif peut être utilisé pour spécifier le port de l’agent sur le serveur Citrix Hypervisor distant (par défaut 443).

Exemple : Sur le serveur de Citrix Hypervisor local :**

xe vm-list
<!--NeedCopy-->

Exemple : Sur un serveur Citrix Hypervisor distant :

xe vm-list username=username password=password server=hostname
<!--NeedCopy-->

La syntaxe abrégée est également disponible pour les arguments de connexion distante :

  • -u nom d’utilisateur
  • -pw mot de passe
  • -pwf fichier mot de passe
  • -p port
  • -s serveur

Exemple : Sur un serveur Citrix Hypervisor distant :

xe vm-list -u myuser -pw mypassword -s hostname
<!--NeedCopy-->

Les arguments sont également extraits de la variable d’environnement XE_EXTRA_ARGS, sous la forme de paires clé/valeur séparées par des virgules. Par exemple, pour entrer des commandes qui sont exécutées sur un serveur Citrix Hypervisor distant, exécutez d’abord la commande suivante :

export XE_EXTRA_ARGS="server=jeffbeck,port=443,username=root,password=pass"
<!--NeedCopy-->

Après avoir exécuté cette commande, vous n’avez plus à spécifier les paramètres du serveur Citrix Hypervisor distant dans chaque commande xe que vous exécutez.

L’utilisation de la variable d’environnement XE_EXTRA_ARGS permet également la saisie automatique par tabulation des commandes xe lorsqu’elles sont émises sur un serveur Citrix Hypervisor distant, qui est désactivé par défaut.

Caractères spéciaux et syntaxe

Pour spécifier des paires argument/valeur sur la ligne de commande xe, écrivez : argument=value

Sauf si la valeur inclut des espaces, n’utilisez pas de guillemets. Il ne doit pas y avoir d’espace entre le nom de l’argument, le signe égal (=) et la valeur. Tout argument non conforme à ce format est ignoré.

Pour les valeurs contenant des espaces, écrivez : argument="value with spaces"

Lorsque vous utilisez l’interface de ligne de commande sur votre serveur Citrix Hypervisor, les commandes disposent d’une fonctionnalité de saisie automatique par tabulation similaire à celle du shell bash Linux standard. Par exemple, si vous tapez xe vm-l puis appuyez sur la touche TAB, le reste de la commande s’affiche. Si plusieurs commandes commencent par vm-l, appuyer une deuxième fois sur TAB répertorie les possibilités. Cette fonctionnalité est utile lorsque vous spécifiez des UUID d’objets dans les commandes.

Remarque :

La saisie automatique par tabulation ne fonctionne normalement pas lors de l’exécution de commandes sur un serveur Citrix Hypervisor distant. Toutefois, si vous définissez la variable XE_EXTRA_ARGS sur l’ordinateur où vous entrez les commandes, l’achèvement des tabulations est activé. Pour plus d’informations, consultez Syntaxe xe de base.

Types de commandes

Les commandes CLI peuvent être divisées en deux parties. Les commandes de bas niveau concernent la liste et la manipulation des paramètres des objets API. Les commandes de niveau supérieur sont utilisées pour interagir avec les machines virtuelles ou les hôtes de manière plus abstraite.

Les commandes de bas niveau sont les suivantes :

  • class-list

  • classe-param-get

  • classe-param-set

  • class-param-list

  • classe-param-add

  • class-param-remove

  • class-param-clear

class est l’un des suivants :

  • bond

  • console

  • host

  • host-crashdump

  • host-cpu

  • network

  • patch

  • pbd

  • pif

  • pool

  • sm

  • sr

  • task

  • template

  • vbd

  • vdi

  • vif

  • vlan

  • vm

Toutes les valeurs de class ne possèdent pas l’ensemble complet des commandes class-param-action . Certaines valeurs de class ont un jeu de commandes plus restreint.

Types de paramètres

Les objets adressés par les commandes xe ont des ensembles de paramètres qui les identifient et définissent leurs états.

La plupart des paramètres prennent une seule valeur. Par exemple, le paramètre name-label d’une machine virtuelle contient une seule valeur de chaîne. Dans la sortie des commandes de liste de paramètres, par exemple xe vm-param-list, une valeur entre parenthèses indique si les paramètres sont en lecture-écriture (RW) ou en lecture seule (RO). La sortie de xe vm-param-list sur une machine virtuelle spécifiée peut avoir les lignes suivantes :

user-version ( RW): 1
 is-control-domain ( RO): false

Le premier paramètre, user-version, est inscriptible et a la valeur 1. Le second, is-control-domain, est en lecture seule et a la valeur false.

Les deux autres types de paramètres sont multi-valeurs. Un paramètre set contient une liste de valeurs. Un paramètre de carte est un ensemble de paires clé/valeur. À titre d’exemple, regardez l’échantillon de sortie suivant de xe vm-param-list sur une machine virtuelle spécifiée :

platform (MRW): acpi: true; apic: true; pae: true; nx: false
allowed-operations (SRO): pause; clean_shutdown; clean_reboot; \
hard_shutdown; hard_reboot; suspend

Le paramètre platform a une liste d’éléments qui représentent des paires clé/valeur. Les noms des clés sont suivis d’un deux-points (:). Chaque paire clé/valeur est séparée de la suivante par un point-virgule (;). Le M qui précède le RW indique que ce paramètre est un paramètre de carte et qu’il est lisible et inscriptible. Le paramètre allowed-operations a une liste qui constitue un ensemble d’éléments. Le S qui précède le RO indique qu’il s’agit d’un paramètre défini et qu’il est lisible mais non inscriptible.

Pour filtrer sur un paramètre de carte ou définir un paramètre de carte, utilisez deux points (:) pour séparer le nom du paramètre de carte et la paire clé/valeur. Par exemple, pour définir la valeur de la clé foo du paramètre other-config d’une machine virtuelle sur baa, la commande sera

xe vm-param-set uuid=VM uuid other-config:foo=baa
<!--NeedCopy-->

Remarque :

Dans les versions précédentes, le trait d’union (-) était utilisé pour spécifier les paramètres de la carte. Cette syntaxe fonctionne toujours, mais elle est obsolète.

Commandes de paramètres de bas niveau

Il existe plusieurs commandes pour opérer sur les paramètres des objets : class-param-get, class-param-set, class-param-add, class-param-remove, class-param-clear et class-param-list. Chacune de ces commandes prend un paramètre uuid pour spécifier l’objet particulier. Comme ces commandes sont considérées comme des commandes de bas niveau, elles doivent utiliser l’UUID et non l’étiquette du nom de la machine virtuelle.

  • xe class-param-list uuid=uuid

    Répertorie tous les paramètres et leurs valeurs associées. Contrairement à la commande class-list, cette commande répertorie les valeurs des champs « chers ».

  • xe class-param-get uuid=uuid param-name=parameter param-key=key

    Renvoie la valeur d’un paramètre particulier. Pour un paramètre de carte, la spécification de la clé de paramètre permet d’obtenir la valeur associée à cette clé dans la carte. Si param-key n’est pas spécifié ou si le paramètre est un ensemble, la commande renvoie une représentation sous forme de chaîne de l’ensemble ou de la carte.

  • xe class-param-set uuid=uuid param=value

    Définit la valeur d’un ou de plusieurs paramètres.

  • xe class-param-add uuid=uuid param-name=parameter key=value param-key=key

    Ajoute à une carte ou à un paramètre défini. Pour un paramètre de carte, ajoutez des paires clé/valeur en utilisant la syntaxe clé=valeur. Si le paramètre est un ensemble, ajoutez des clés avec la syntaxe param-key=key.

  • xe class-param-remove uuid=uuid param-name=parameter param-key=key

    Supprime soit une paire clé/valeur d’une carte, soit une clé d’un ensemble.

  • xe class-param-clear uuid=uuid param-name=parameter

    Efface complètement un ensemble ou une carte.

Commandes de liste de bas niveau

La commande class-list répertorie les objets de type class. Par défaut, ce type de commande répertorie tous les objets, en imprimant un sous-ensemble des paramètres. Ce comportement peut être modifié des manières suivantes :

  • Il peut filtrer les objets de sorte qu’il ne génère qu’un sous-ensemble
  • Les paramètres imprimés peuvent être modifiés.

Pour modifier les paramètres qui sont imprimés, spécifiez les paramètres d’argument sous la forme d’une liste séparée par des virgules des paramètres requis. Par exemple :

xe vm-list params=name-label,other-config
<!--NeedCopy-->

Vous pouvez également utiliser la syntaxe suivante pour répertorier tous les paramètres :

xe vm-list params=all
<!--NeedCopy-->

La commande list n’affiche pas certains paramètres coûteux à calculer. Ces paramètres sont présentés comme suit, par exemple :

allowed-VBD-devices (SRO): <expensive field>
<!--NeedCopy-->

Pour obtenir ces champs, utilisez la commande class-param-list ou class-param-get

Pour filtrer la liste, l’interface de ligne de commande fait correspondre les valeurs des paramètres aux valeurs spécifiées sur la ligne de commande, en imprimant uniquement les objets qui correspondent à toutes les contraintes spécifiées. Par exemple :

xe vm-list HVM-boot-policy="BIOS order" power-state=halted
<!--NeedCopy-->

Cette commande répertorie uniquement les machines virtuelles pour lesquelles la valeur du champ power-state est arrêtée et le champ HVM-boot-policy a l’ordre du BIOS de valeur.

Vous pouvez également filtrer la liste en fonction de la valeur des clés dans les cartes ou de l’existence de valeurs dans un ensemble. La syntaxe pour le filtrage basé sur les clés dans les cartes est map-name:key=value. La syntaxe pour le filtrage basé sur les valeurs existant dans un ensemble est set-name:contains=value.

Lors de l’écriture de scripts, une technique utile est de passer --minimal sur la ligne de commande, provoquant l’impression de xe uniquement du premier champ d’une liste séparée par des virgules. Par exemple, la commande xe vm-list --minimal sur un hôte sur lequel trois machines virtuelles sont installées donne les trois UUID des machines virtuelles :

    a85d6717-7264-d00e-069b-3b1d19d56ad9,aaa3eec5-9499-bcf3-4c03-af10baea96b7, \
    42c044de-df69-4b30-89d9-2c199564581d
<!--NeedCopy-->

Secrets

Citrix Hypervisor fournit un mécanisme secret pour éviter que les mots de passe ne soient stockés en texte brut dans l’historique de la ligne de commande ou sur des objets API. XenCenter utilise cette fonctionnalité automatiquement et elle peut également être utilisée à partir de l’interface de ligne de commande xe pour toute commande nécessitant un mot de passe.

Remarque

Les secrets de mot de passe ne peuvent pas être utilisés pour s’authentifier auprès d’un hôte Citrix Hypervisor à partir d’une instance distante de la xe CLI.

Pour créer un objet secret, exécutez la commande suivante sur votre hôte Citrix Hypervisor.

xe secret-create value=my-password
<!--NeedCopy-->

Un secret est créé et stocké sur l’hôte Citrix Hypervisor. La commande génère l’UUID de l’objet secret. Par exemple, 99945d96-5890-de2a-3899-8c04ef2521db. Ajoutez _secret au nom de l’argument mot de passe pour passer cet UUID à n’importe quelle commande nécessitant un mot de passe.

Exemple : Sur l’hôte Citrix Hypervisor sur lequel vous avez créé le secret, vous pouvez exécuter la commande suivante :

    xe sr-create device-config:location=sr_address device-config:type=cifs device-config:username=cifs_username  \
    device-config:cifspassword_secret=secret_uuid name-label="CIFS ISO SR" type="iso" content-type="iso" shared="true"
<!--NeedCopy-->

Historique des commandes

Certaines commandes xe, par exemple, xe vm-migrate ou xe pool-enable-external-auth, prennent des secrets tels que des mots de passe comme paramètres. Ceux-ci peuvent se retrouver dans l’historique du shell et, lors de l’exécution de la commande, sont visibles dans la table de processus. Il est donc important d’exécuter ces commandes uniquement dans des environnements fiables.

Pour le shell bash, vous pouvez utiliser la variable HISTCONTROL pour contrôler les commandes qui sont stockées dans l’historique du shell.

référence de la commande xe

Cette section regroupe les commandes en fonction des objets auxquels la commande s’adresse. Ces objets sont classés par ordre alphabétique.

Commandes de l’appliance

Commandes permettant de créer et de modifier des appliances VM (également appelées vApp). Pour plus d’informations, consultez vApp.

Paramètres de l’appliance

Les commandes de l’appliance ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’UUID de l’appliance Requis
name-description Description de l’appliance Facultatif
paused   Facultatif
force Forcer l’arrêt Facultatif

appliance-assert-can-be-recovered

xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

Teste si le stockage est disponible pour récupérer cette machine virtuelle/vApp.

appliance-create

xe appliance-create name-label=name-label [name-description=name-description]
<!--NeedCopy-->

Crée une Appliance/vApp. Par exemple :

xe appliance-create name-label=my_appliance
<!--NeedCopy-->

Ajoutez des machines virtuelles à l’appliance :

xe vm-param-set uuid=VM-UUID appliance=appliance-uuid
<!--NeedCopy-->

appliance-destroy

xe appliance-destroy uuid=appliance-uuid
<!--NeedCopy-->

Détruit une Appliance/vApp. Par exemple :

xe appliance-destroy uuid=appliance-uuid
<!--NeedCopy-->

appliance-recover

xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [paused=true|false]
<!--NeedCopy-->

Récupérez une machine virtuelle/un vApp à partir de la base de données contenue dans le VDI fourni.

appliance-shutdown

xe appliance-shutdown uuid=appliance-uuid [force=true|false]
<!--NeedCopy-->

Arrête toutes les machines virtuelles d’une Appliance/vApp. Par exemple :

xe appliance-shutdown uuid=appliance-uuid
<!--NeedCopy-->

appliance-start

xe appliance-start uuid=appliance-uuid [paused=true|false]
<!--NeedCopy-->

Démarre une Appliance/vApp. Par exemple :

xe appliance-start uuid=appliance-uuid
<!--NeedCopy-->

Commandes d’audit

Les commandes d’audit téléchargent tous les enregistrements disponibles du fichier d’audit RBAC dans le pool. Si le paramètre facultatif since est présent, il télécharge uniquement les enregistrements à partir de ce moment précis.

audit-log-get paramètres

audit-log-get possède les paramètres suivants

Nom du paramètre Description Type
filename Écrire le journal d’audit du pool dans le nom de fichier Requis
since Date/heure spécifique Facultatif

audit-log-get

xe audit-log-get [since=timestamp] filename=filename
<!--NeedCopy-->

Par exemple, pour obtenir des enregistrements d’audit du pool depuis un horodatage précis en millisecondes, exécutez la commande suivante :

Exécutez la commande suivante :

xe audit-log-get since=2009-09-24T17:56:20.530Z filename=/tmp/auditlog-pool-actions.out
<!--NeedCopy-->

Commandes de liaison

Commandes pour travailler avec des liaisons réseau, pour la résilience avec basculement de l’interface physique. Pour plus d’informations, reportez-vous à la section Mise en réseau.

L’objet bond est un objet de référence qui colle les PIF maîtres et membres . Le PIF principal est l’interface de liaison qui doit être utilisée comme PIF global pour faire référence à la liaison. Les PIF membres sont un ensemble de deux interfaces physiques ou plus qui ont été combinées dans l’interface liée de haut niveau.

Paramètres de liaison

Les obligations ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour la liaison Lecture seule
master UUID pour le PIF de l’obligation principale Lecture seule
members Ensemble d’UUID pour les PIF liés sous-jacents Lecture seule

bond-create

xe bond-create network-uuid=network_uuid pif-uuids=pif_uuid_1,pif_uuid_2,...
<!--NeedCopy-->

Créez une interface réseau liée sur le réseau spécifié à partir d’une liste d’objets PIF existants. La commande échoue dans l’un des cas suivants :

  • Si les PIF sont déjà dans une autre obligation
  • Si un membre possède un jeu de balises VLAN
  • Si les PIF référencés ne se trouvent pas sur le même serveur Citrix Hypervisor
  • Si moins de 2 PIF sont fournis

bond-destroy

xe bond-destroy uuid=bond_uuid
<!--NeedCopy-->

Supprime une interface liée spécifiée par son UUID d’un hôte.

bond-set-mode

xe bond-set-mode uuid=bond_uuid mode=bond_mode
<!--NeedCopy-->

Changez le mode de liaison.

Commandes CD

Commandes pour travailler avec des lecteurs de CD/DVD physiques sur des serveurs Citrix Hypervisor.

Paramètres du CD

Les paramètres des CD sont les suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le CD Lecture seule
name-label Nom du CD Lecture/Écriture
name-description Texte de description pour le CD Lecture/Écriture
allowed-operations Une liste des opérations pouvant être effectuées sur ce CD Paramètre en lecture seule
current-operations Une liste des opérations en cours sur ce CD Paramètre en lecture seule
sr-uuid L’identificateur/référence d’objet unique pour la demande de service dont ce CD fait partie Lecture seule
sr-name-label Le nom de la SR dont ce CD fait partie Lecture seule
vbd-uuids Une liste des identifiants uniques pour les VBD sur les machines virtuelles qui se connectent à ce CD Paramètre en lecture seule
crashdump-uuids Non utilisé sur les CD. Parce que les crashdumps ne peuvent pas être écrits sur des CD Paramètre en lecture seule
virtual-size Taille du CD telle qu’elle apparaît aux machines virtuelles (en octets) Lecture seule
physical-utilisation Espace physique occupé par l’image du CD sur le SR (en octets) Lecture seule
type Définir sur l’utilisateur pour les CD Lecture seule
sharable Indique si le lecteur de CD est partageable ou non. La valeur par défaut est false. Lecture seule
read-only Indique si le CD est en lecture seule false, si le périphérique est inscriptible. C’est toujours vrai pour les CD. Lecture seule
storage-lock La valeur est true si ce disque est verrouillé au niveau du stockage. Lecture seule
parent Référence au disque parent, si ce CD fait partie d’une chaîne. Lecture seule
missing La valeur est true si l’opération d’analyse SR a signalé que ce CD n’était pas présent sur le disque Lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le CD Paramètre de mappage en lecture/écriture
location Le chemin sur lequel l’appareil est monté Lecture seule
managed La valeur est true si l’appareil est géré Lecture seule
xenstore-data Données à insérer dans l’arborescence xenstore Paramètre de mappage en lecture seule
sm-config Noms et descriptions des clés de configuration des périphériques du gestionnaire de stockage Paramètre de mappage en lecture seule
is-a-snapshot La valeur est true si ce modèle est un instantané de CD Lecture seule
snapshot_of L’UUID du CD dont ce modèle est un instantané Lecture seule
snapshots Les UUID de tous les instantanés qui ont été pris sur ce CD Lecture seule
snapshot_time Horodatage de l’opération d’instantané Lecture seule

cd-list

xe cd-list [params=param1,param2,...] [parameter=parameter_value]
<!--NeedCopy-->

Répertoriez les CD et ISO (fichiers image de CD) sur le serveur ou le pool Citrix Hypervisor, en filtrant sur l’argument facultatif params.

Si l’argument optionnel params est utilisé, la valeur de params est une chaîne contenant une liste de paramètres de cet objet que vous souhaitez afficher. Vous pouvez également utiliser le mot-clé all pour afficher tous les paramètres. Lorsque params n’est pas utilisé, la liste renvoyée affiche un sous-ensemble par défaut de tous les paramètres disponibles.

Les arguments facultatifs peuvent être n’importe quel nombre des paramètres du CD répertoriés au début de cette section.

Commandes du cluster

Commandes pour travailler avec des pools en cluster.

Les pools en cluster sont des pools de ressources pour lesquels la fonctionnalité de clustering est activée. Utilisez ces pools avec les SR GFS2. Pour plus d’informations, voir Pools en cluster

Les objets cluster et cluster-host peuvent être répertoriés avec les commandes de listage d’objets standard (xe cluster-list et xe cluster-host-list), et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, consultez Commandes de paramètres de bas niveau. Commandes pour travailler avec des pools en cluster.

Paramètres du cluster

Les clusters ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le cluster Lecture seule
cluster-hosts Une liste d’identificateurs uniques/références d’objets pour les hôtes du cluster Paramètre en lecture seule
cluster-token La clé secrète utilisée par xapi-clusterd lorsqu’il parle à lui-même sur d’autres hôtes Lecture seule
cluster-stack La pile technologique fournissant les fonctionnalités de clustering. Les valeurs possibles sont corosync. Lecture seule
allowed-operations Répertorie les opérations autorisées dans cet état. Cette liste est uniquement consultative et l’état du cluster peut avoir changé au moment où un client lit ce champ. Paramètre en lecture seule
current-operations Répertorie les opérations en cours. Cette liste est uniquement consultative et l’état du cluster peut avoir changé au moment où un client lit ce champ. Paramètre en lecture seule
token-timeout Le délai d’expiration du jeton corosync en secondes Lecture seule
token-timeout-coefficient Le coefficient de délai d’expiration du jeton corosync en secondes Lecture seule
pool-auto-join True si vous joignez automatiquement de nouveaux membres du pool au cluster. Ce paramètre est défini sur true. Lecture seule
cluster-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le cluster. Paramètre de mappage en lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le cluster. Paramètre de mappage en lecture/écriture

cluster-host-create

xe cluster-host-create cluster-uuid=cluster_uuid host-uuid=host_uuid pif-uuid=pif_uuid
<!--NeedCopy-->

Ajoutez un hôte à un cluster existant.

cluster-host-destroy

xe cluster-host-destroy uuid=host_uuid
<!--NeedCopy-->

Détruisez un hôte de cluster, en quittant effectivement le cluster.

cluster-host-disable

xe cluster-host-disable uuid=cluster_uuid
<!--NeedCopy-->

Désactivez l’appartenance au cluster pour un hôte de cluster activé.

cluster-host-enable

xe cluster-host-enable uuid=cluster_uuid
<!--NeedCopy-->

Activez l’adhésion au cluster pour un hôte de cluster désactivé.

cluster-host-force-destroy

xe cluster-host-force-destroy uuid=cluster_host
<!--NeedCopy-->

Détruisez de force un objet hôte de cluster, en quittant effectivement le cluster.

cluster-pool-create

xe cluster-pool-create network-uuid=network_uuid [cluster-stack=cluster_stack] [token-timeout=token_timeout] [token-timeout-coefficient=token_timeout_coefficient]
<!--NeedCopy-->

Créez un cluster à l’échelle du pool.

cluster-pool-destroy

xe cluster-pool-destroy cluster-uuid=cluster_uuid
<!--NeedCopy-->

Détruisez le cluster au niveau du pool. Le pool continue d’exister, mais il n’est plus clusterisé et ne peut plus utiliser les SR GFS2.

cluster-pool-force-destroy

xe cluster-pool-force-destroy cluster-uuid=cluster_uuid
<!--NeedCopy-->

Forcer la destruction de la grappe à l’échelle du pool.

cluster-pool-resync

xe cluster-pool-resync cluster-uuid=cluster_uuid
<!--NeedCopy-->

Resynchronisez un cluster sur un pool.

Commandes de la console

Commandes permettant de travailler avec les consoles.

Les objets de console peuvent être répertoriés avec la commande de liste d’objets standard (xe console-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, consultez Commandes de paramètres de bas niveau.

Paramètres de la console

Les paramètres des consoles sont les suivants :

Nom du paramètre Description Type
uuid L’identificateur unique/la référence de l’objet pour la console Lecture seule
vm-uuid Identifiant unique/référence d’objet de la machine virtuelle sur laquelle cette console est ouverte Lecture seule
vm-name-label Le nom de la machine virtuelle sur laquelle cette console est ouverte Lecture seule
protocol Protocole utilisé par cette console. Les valeurs possibles sont vt100 : terminal VT100, rfbRemote Framebuffer Protocol (tel qu’utilisé dans VNC) ou rdp : Remote Desktop Protocol Lecture seule
location URI pour le service de console Lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour la console. Paramètre de mappage en lecture/écriture

console

xe console
<!--NeedCopy-->

Fixez-le à une console particulière.

Commandes de diagnostic

Commandes permettant de collecter des informations de diagnostic à partir de Citrix Hypervisor.

diagnostic-compact

xe diagnostic-compact
<!--NeedCopy-->

Effectuer une collecte de GC majeure et un compactage de tas.

OBSOLETE : diagnostic-db-log

xe diagnostic-db-log
<!--NeedCopy-->

Commencez à enregistrer les opérations de base de données. Attention : une fois démarré, cela ne peut pas être arrêté.

diagnostic-db-stats

xe diagnostic-db-stats
<!--NeedCopy-->

Imprime les statistiques de la base

diagnostic-gc-stats

xe diagnostic-gc-stats
<!--NeedCopy-->

Imprimer les statistiques du GC.

diagnostic-license-status

xe diagnostic-license-status
<!--NeedCopy-->

Permet de diagnostiquer les problèmes de licence à l’échelle du pool.

diagnostic-net-stats

xe diagnostic-net-stats [uri=uri] [method=method] [params=param1,param2...]
<!--NeedCopy-->

Imprimez les statistiques du réseau.

diagnostic-timing-stats

xe diagnostic-timing-stats
<!--NeedCopy-->

Statistiques de synchronisation d’impression.

diagnostic-vdi-status

xe diagnostic-vdi-status uuid=vdi_uuid
<!--NeedCopy-->

Interrogez l’état de verrouillage et de partage d’un VDI.

diagnostic-vm-status

xe diagnostic-vm-status uuid=vm_uuid
<!--NeedCopy-->

Interrogez les hôtes sur lesquels la machine virtuelle peut démarrer, vérifiez l’état de partage/verrouillage de tous les VBD.

Commandes de reprise après sinistre

Commandes de récupération des machines virtuelles après un sinistre

drtask-create

xe drtask-create type=type sr-whitelist=sr-white-list device-config=device-config
<!--NeedCopy-->

Crée une tâche de reprise après sinistre. Par exemple, pour vous connecter à une SR iSCSI en préparation à la reprise après sinistre :

xe drtask-create type=lvmoiscsi device-config:target=target-ip-address \
    device-config:targetIQN=targetIQN device-config:SCSIid=SCSIid \
    sr-whitelist=sr-uuid-list
<!--NeedCopy-->

Remarque :

La commande sr-whitelist répertorie les UUID SR autorisés. La commande drtask-create introduit et se connecte uniquement à un SR qui a l’un des UUID autorisés

drtask-destroy

xe drtask-destroy uuid=dr-task-uuid
<!--NeedCopy-->

Détruit une tâche de reprise après sinistre et oublie le SR introduit.

vm-assert-can-be-recovered

xe vm-assert-can-be-recovered uuid=vm-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

Teste si le stockage est disponible pour récupérer cette machine virtuelle.

appliance-assert-can-be-recovered

xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

Vérifie si le stockage (contenant le disque vApp de l’appliance) est visible.

appliance-recover

xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [force=true|false]
<!--NeedCopy-->

Récupérez une Appliance/vApp à partir de la base de données contenue dans le VDI fourni.

vm-recover

xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid [force=true|false]
<!--NeedCopy-->

Récupère une machine virtuelle à partir de la base de données contenue dans le VDI fourni.

sr-enable-database-replication

xe sr-enable-database-replication uuid=sr_uuid
<!--NeedCopy-->

Active la réplication de la base de données XAPI vers le SR (partagé) spécifié.

sr-disable-database-replication

xe sr-disable-database-replication uuid=sr_uuid
<!--NeedCopy-->

Désactive la réplication de la base de données XAPI vers le SR spécifié.

Exemple d’utilisation

L’exemple ci-dessous montre les commandes CLI DR en contexte :

Sur le site principal, activez la réplication de base de données :

xe sr-database-replication uuid=sr=uuid
<!--NeedCopy-->

Après un sinistre, sur le site secondaire, connectez-vous au SR. La commande device-config a les mêmes champs que sr-probe.

xe drtask-create type=lvmoiscsi \
    device-config:target=target ip address \
    device-config:targetIQN=target-iqn \
    device-config:SCSIid=scsi-id \
    sr-whitelist=sr-uuid
<!--NeedCopy-->

Recherchez les VDI de base de données sur le SR :

xe vdi-list sr-uuid=sr-uuid type=Metadata
<!--NeedCopy-->

Interrogez un VDI de base de données pour les machines virtuelles présentes :

xe vm-list database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

Récupérer une machine virtuelle :

xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

Détruisez la tâche DR. Tous les SR introduits par la tâche de reprise après sinistre et non requis par les machines virtuelles sont détruits :

xe drtask-destroy uuid=drtask-uuid
<!--NeedCopy-->

Commandes d’événement

Commandes permettant de travailler avec les événements.

Classes d’événements

Les classes d’événements sont répertoriées dans le tableau suivant :

Nom de la classe Description
pool Un pool d’hôtes physiques
vm Une machine virtuelle
host Un hôte physique
network Un réseau virtuel
vif Une interface réseau virtuelle
pif Une interface réseau physique (les VLAN séparés sont représentés par plusieurs PIF)
sr Un référentiel de stockage
vdi Une image de disque virtuel
vbd Un périphérique de bloc virtuel
pbd Périphériques physiques en mode bloc via lesquels les hôtes accèdent aux SR

event-wait

xe event-wait class=class_name [param-name=param_value] [param-name=/=param_value]
<!--NeedCopy-->

Empêche l’exécution d’autres commandes jusqu’à ce qu’il existe un objet satisfaisant aux conditions données sur la ligne de commande. L’argument x=y signifie « attendre que le champ x prenne la valeur y » et x=/=y signifie « attendre que le champ x prenne toute valeur autre que y ».

Exemple : attendez qu’une machine virtuelle spécifique soit en cours d’exécution.

xe event-wait class=vm name-label=myvm power-state=running
<!--NeedCopy-->

Bloque les autres commandes jusqu’à ce qu’une machine virtuelle appelée myvm soit dans le power-state « running ».

Exemple : attendez le redémarrage d’une machine virtuelle spécifique :

xe event-wait class=vm uuid=$VM start-time=/=$(xe vm-list uuid=$VM params=start-time --minimal)
<!--NeedCopy-->

Bloque les autres commandes jusqu’à ce qu’une machine virtuelle avec UUID $VM redémarre. La commande utilise la valeur de start-time pour décider quand la machine virtuelle redémarre.

Le nom de la classe peut être l’une des classes d’événements répertoriées au début de cette section. Les paramètres peuvent être l’un des paramètres répertoriés dans la classede commande CLI -param-list.

Commandes GPU

Commandes permettant de travailler avec des GPU physiques, des groupes de GPU et des GPU virtuels.

Les objets GPU peuvent être répertoriés avec les commandes standard de listage d’objets : xe pgpu-list, xe gpu-group-list et xe vgpu-list. Les paramètres peuvent être manipulés avec les commandes de paramètres standard. Pour plus d’informations, consultez Commandes de paramètres de bas niveau.

Paramètres physiques du GPU

Les GPU physiques (pGPU) ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le pGPU Lecture seule
vendor-name Le nom du vendeur du pGPU Lecture seule
device-name Le nom attribué par le vendeur à ce modèle pGPU Lecture seule
gpu-group-uuid Identifiant unique/référence d’objet pour le groupe de GPU auquel ce pGPU a été automatiquement affecté par Citrix Hypervisor. Les pGPU identiques sur les hôtes d’un pool sont regroupés Lecture seule
gpu-group-name-label Le nom du groupe de GPU auquel le pGPU est affecté Lecture seule
host-uuid L’identificateur/la référence d’objet unique pour le serveur Citrix Hypervisor auquel le pGPU est connecté Lecture seule
host-name-label Le nom du serveur Citrix Hypervisor auquel le pGPU est connecté Lecture seule
pci-id Identifiant PCI Lecture seule
dependencies Répertorie les périphériques PCI dépendants transmis à la même machine virtuelle Paramètre de mappage en lecture/écriture
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le pGPU Paramètre de mappage en lecture/écriture
supported-VGPU-types Liste des types de GPU virtuels pris en charge par le matériel sous-jacent Lecture seule
enabled-VGPU-types Liste des types de GPU virtuels qui ont été activés pour ce pGPU Lecture/écriture
resident-VGPUs Liste des vGPU exécutés sur ce pGPU Lecture seule

pgpu-disable-dom0-access

xe pgpu-disable-dom0-access uuid=uuid
<!--NeedCopy-->

Désactive l’accès pGPU à dom0.

pgpu-enable-dom0-access

xe pgpu-enable-dom0-access uuid=uuid
<!--NeedCopy-->

Activez l’accès pGPU à dom0.

Paramètres du groupe GPU

Les groupes de GPU ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le groupe de GPU Lecture seule
name-label Le nom du groupe de GPU Lecture/Écriture
name-description Le texte descriptif du groupe GPU Lecture/Écriture
VGPU-uuids Répertorie les références d’identificateur/objet uniques pour les GPU virtuels du groupe GPU Paramètre en lecture seule
PGPU-uuids Répertorie les références d’identificateur/objet uniques pour les pGPU du groupe GPU Paramètre en lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le groupe de GPU Paramètre de mappage en lecture/écriture
supported-VGPU-types Union de tous les types de GPU virtuels pris en charge par le matériel sous-jacent Lecture seule
enabled-VGPU-types Union de tous les types de GPU virtuels qui ont été activés sur les pGPU sous-jacents Lecture seule
allocation-algorithm Paramètre de profondeur d’abord et largeur d’abord pour les GPU virtuels d’allocation sur les pGPU au sein du groupe Paramètre enum en lecture/écriture

Opérations du groupe GPU

Commandes pour travailler avec des groupes de GPU

gpu-group-create
xe gpu-group-create name-label=name_for_group [name-description=description]
<!--NeedCopy-->

Crée un nouveau groupe de GPU (vide) dans lequel les pGPU peuvent être déplacés.

gpu-group-destroy
xe gpu-group-destroy uuid=uuid_of_group
<!--NeedCopy-->

Détruit le groupe GPU ; autorisé uniquement pour les groupes vides.

gpu-group-get-remaining-capacity
xe gpu-group-get-remaining-capacity uuid=uuid_of_group vgpu-type-uuid=uuid_of_vgpu_type
<!--NeedCopy-->

Renvoie le nombre de GPU virtuels supplémentaires du type spécifié qui peuvent être instanciés dans ce groupe de GPU.

gpu-group-param-set
xe gpu-group-param-set uuid=uuid_of_group allocation-algorithm=breadth-first|depth-first
<!--NeedCopy-->

Modifie l’algorithme utilisé par le groupe de GPU pour allouer des GPU virtuels aux GPU.

gpu-group-param-get-uuid
xe gpu-group-param-get-uuid uuid=uuid_of_group param-name=supported-vGPU-types|enabled-vGPU-types
<!--NeedCopy-->

Renvoie les types pris en charge ou activés pour ce groupe de GPU.

Paramètres du GPU virtuel

Les GPU virtuels ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le GPU virtuel Lecture seule
vm-uuid Identifiant unique/référence d’objet pour la machine virtuelle à laquelle le GPU virtuel est affecté Lecture seule
vm-name-label Le nom de la machine virtuelle à laquelle le GPU virtuel est affecté Lecture seule
gpu-group-uuid Identifiant unique/référence d’objet pour le groupe de GPU dans lequel se trouve le GPU virtuel Lecture seule
gpu-group-name-label Nom du groupe de GPU dans lequel se trouve le GPU virtuel Lecture seule
currently-attached True si une machine virtuelle avec passerelle GPU est en cours d’exécution, false dans le cas contraire Lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le GPU virtuel Paramètre de mappage en lecture/écriture
type-uuid Identifiant unique/référence d’objet pour le type de GPU virtuel de ce GPU virtuel Paramètre de mappage en lecture/écriture
type-model-name Nom du modèle associé au type de GPU virtuel Lecture seule

Paramètres du type de GPU virtuel

Remarque :

Le relais GPU et les GPU virtuels ne sont pas compatibles avec la migration en direct, la migration en direct du stockage ou la suspension des machines virtuelles, sauf si les logiciels et les cartes graphiques pris en charge par les fournisseurs de GPU sont présents. Les machines virtuelles sans cette prise en charge ne peuvent pas être migrées pour éviter les temps d’arrêt. Pour plus d’informations sur la compatibilité du vGPU NVIDIA avec la migration en direct, la migration en direct du stockage et la suspension des machines virtuelles, reportez-vous à la section Graphiques.

Les types de GPU virtuels ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le type de GPU virtuel Lecture seule
vendor-name Nom du fournisseur de GPU virtuel Lecture seule
model-name Nom du modèle associé au type de GPU virtuel Lecture seule
freeze-frame Taille du tampon de trame du type de GPU virtuel, en octets Lecture seule
max-heads Nombre maximal d’écrans pris en charge par le type de GPU virtuel Lecture seule
supported-on-PGPUs Liste des pGPU prenant en charge ce type de GPU virtuel Lecture seule
enabled-on-PGPUs Liste des pGPU pour lesquels ce type de GPU virtuel est activé Lecture seule
VGPU-uuids Liste des GPU virtuels de ce type Lecture seule

Opérations sur GPU virtuels

vgpu-create

xe vgpu-create vm-uuid=uuid_of_vm gpu_group_uuid=uuid_of_gpu_group [vgpu-type-uuid=uuid_of_vgpu-type]
<!--NeedCopy-->

Crée un GPU virtuel. Cette commande attache la machine virtuelle au groupe de GPU spécifié et spécifie éventuellement le type de GPU virtuel. Si aucun type de GPU virtuel n’est spécifié, le type « pass-through » est supposé.

vgpu-destroy

xe vgpu-destroy uuid=uuid_of_vgpu
<!--NeedCopy-->

Détruisez le GPU virtuel spécifié.

Désactivation de VNC pour les machines virtuelles avec GPU virtuel

xe vm-param-add uuid=uuid_of_vmparam-name=platform vgpu_vnc_enabled=true|false
<!--NeedCopy-->

L’utilisation de false désactive la console VNC d’une machine virtuelle lorsqu’elle transmet disablevnc=1 à l’émulateur d’affichage. Par défaut, VNC est activé.

Commandes de l’hôte

Commandes pour interagir avec le serveur Citrix Hypervisor.

Les serveurs Citrix Hypervisor sont les serveurs physiques exécutant le logiciel Citrix Hypervisor. Des machines virtuelles s’exécutent sur eux sous le contrôle d’une machine virtuelle privilégiée spéciale, connue sous le nom de domaine de contrôle ou domaine 0.

Les objets serveur Citrix Hypervisor peuvent être répertoriés avec les commandes de liste d’objets standard : xe host-list, xe host-cpu-list et xe host-crashdump-list). Les paramètres peuvent être manipulés avec les commandes de paramètres standard. Pour plus d’informations, consultez Commandes de paramètres de bas niveau.

Sélecteurs d’hôte

Plusieurs des commandes répertoriées ici ont un mécanisme commun pour sélectionner un ou plusieurs serveurs Citrix Hypervisor sur lesquels effectuer l’opération. Le plus simple est de fournir l’argument host=uuid_or_name_label. Vous pouvez également spécifier Citrix Hypervisor en filtrant la liste complète des hôtes sur les valeurs des champs. Par exemple, la spécification enabled=true sélectionne tous les serveurs Citrix Hypervisor dont le champ enabled est égal à true. Lorsque plusieurs serveurs Citrix Hypervisor correspondent et que l’opération peut être effectuée sur plusieurs serveurs Citrix Hypervisor, vous devez spécifier --multiple d’effectuer l’opération. La liste complète des paramètres pouvant être mis en correspondance est décrite au début de cette section. Vous pouvez obtenir cette liste de commandes en exécutant la commande xe host-list params=all. Si aucun paramètre de sélection des serveurs Citrix Hypervisor n’est fourni, l’opération est effectuée sur tous les serveurs Citrix Hypervisor.

Paramètres de l’hôte

Les serveurs Citrix Hypervisor possèdent les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le serveur Citrix Hypervisor Lecture seule
name-label Le nom du serveur Citrix Hypervisor Lecture/Écriture
name-description La chaîne de description du serveur Citrix Hypervisor Lecture seule
enabled La valeur est false si désactivée. Cela empêche toute nouvelle machine virtuelle de démarrer sur les hôtes et prépare les hôtes à être arrêtés ou redémarrés. La valeur est true si l’hôte est activé Lecture seule
API-version-major Numéro de version principal Lecture seule
API-version-minor Numéro de version mineure Lecture seule
API-version-vendor Identification du fournisseur d’API Lecture seule
API-version-vendor-implementation Détails de la mise en œuvre du fournisseur Paramètre de mappage en lecture seule
logging Journalisation de la configuration Paramètre de mappage en lecture/écriture
suspend-image-sr-uuid L’identificateur/référence d’objet unique pour le SR où les images suspendues sont placées Lecture/Écriture
crash-dump-sr-uuid L’identificateur/référence d’objet unique pour le SR où les vidages sur incident sont placés Lecture/Écriture
software-version Liste des paramètres de versionnement et de leurs valeurs Paramètre de mappage en lecture seule
capabilities Liste des versions Xen que le serveur Citrix Hypervisor peut exécuter Paramètre en lecture seule
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le serveur Citrix Hypervisor Paramètre de mappage en lecture/écriture
chipset-info Une liste de paires clé/valeur qui spécifient des informations sur le chipset Paramètre de mappage en lecture seule
hostname Nom d’hôte du serveur Citrix Hypervisor Lecture seule
address Adresse IP du serveur Citrix Hypervisor Lecture seule
license-server Une liste de paires clé/valeur qui spécifient des informations sur le serveur de licences. Le port par défaut pour les communications avec les produits Citrix est 27000. Pour plus d’informations sur la modification des numéros de port en raison de conflits, voir Modifier les numéros de port Paramètre de mappage en lecture seule
supported-bootloaders Liste des chargeurs de démarrage pris en charge par le serveur Citrix Hypervisor, par exemple pygrub, eliloader Paramètre en lecture seule
memory-total Quantité totale de RAM physique sur le serveur Citrix Hypervisor, en octets Lecture seule
memory-free Quantité totale de RAM physique restante pouvant être allouée aux machines virtuelles, en octets Lecture seule
host-metrics-live Vrai si l’hôte est opérationnel Lecture seule
logging La clé syslog_destination peut être définie sur le nom d’hôte d’un service Syslog d’écoute à distance. Paramètre de mappage en lecture/écriture
allowed-operations Répertorie les opérations autorisées dans cet état. Cette liste est uniquement consultative et l’état du serveur peut avoir changé au moment où un client lit ce champ. Paramètre en lecture seule
current-operations Répertorie les opérations en cours. Cette liste est uniquement consultative et l’état du serveur peut avoir changé au moment où un client lit ce champ. Paramètre en lecture seule
patches Ensemble de patchs hôtes Paramètre en lecture seule
blobs Magasin de données binaires Lecture seule
memory-free-computed Estimation prudente de la quantité maximale de mémoire libre sur un hôte Lecture seule
ha-statefiles Les UUID de tous les fichiers d’état HA Lecture seule
ha-network-peers Les UUID de tous les hôtes pouvant héberger les machines virtuelles sur cet hôte en cas de défaillance Lecture seule
external-auth-type Type d’authentification externe, par exemple Active Directory. Lecture seule
external-auth-service-name Le nom du service d’authentification externe Lecture seule
external-auth-configuration Informations de configuration pour le service d’authentification externe. Paramètre de mappage en lecture seule

Les serveurs Citrix Hypervisor contiennent d’autres objets qui possèdent également des listes de paramètres.

Les processeurs sur les serveurs Citrix Hypervisor ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le processeur Lecture seule
number Le nombre de cœurs de processeur physiques au sein du serveur Citrix Hypervisor Lecture seule
vendor La chaîne du fournisseur pour le nom de la CPU Lecture seule
speed La vitesse d’horloge du processeur, en Hz Lecture seule
modelname La chaîne du fournisseur pour le modèle de processeur, par exemple « Intel (R) Xeon (TM) CPU 3,00 GHz » Lecture seule
stepping Le numéro de révision du processeur Lecture seule
flags Les indicateurs de la CPU physique (une version décodée du champ des fonctionnalités) Lecture seule
Utilisation L’utilisation actuelle du processeur Lecture seule
host-uuid L’UUID de l’hôte dans lequel se trouve le processeur Lecture seule
model Le numéro de modèle du processeur physique Lecture seule
family Le numéro de famille du processeur physique Lecture seule

Les vidages sur incident sur les serveurs Citrix Hypervisor ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le vidage sur incident Lecture seule
host Serveur Citrix Hypervisor auquel le vidage sur incident correspond Lecture seule
timestamp Horodatage de la date et de l’heure auxquelles le vidage sur incident s’est produit yyyymmdd-hhmmss-ABC, sous la forme, où ABC est l’indicateur de fuseau horaire, par exemple GMT Lecture seule
size Taille du vidage sur incident, en octets Lecture seule

host-all-editions

xe host-all-editions
<!--NeedCopy-->

Obtenez la liste de toutes les éditions disponibles

host-apply-edition

xe host-apply-edition [host-uuid=host_uuid] [edition=xenserver_edition="free" "per-socket" "xendesktop"]
<!--NeedCopy-->

Affecte la licence Citrix Hypervisor à un serveur hôte. Lorsque vous attribuez une licence, Citrix Hypervisor contacte le serveur de licences et demande le type de licence spécifié. Si une licence est disponible, elle est retirée du serveur de licences.

Pour Citrix Hypervisor pour Citrix Virtual Desktops et les éditions DaaS, utilisez "xendesktop".

Pour la configuration initiale des licences, reportez-vous également à license-server-address et license-server-port.

host-backup

xe host-backup file-name=backup_filename host=host_name
<!--NeedCopy-->

Téléchargez une sauvegarde du domaine de contrôle du serveur Citrix Hypervisor spécifié sur la machine à partir de laquelle la commande est appelée. Enregistrez-le dans un fichier portant le nom file-name.

Important :

Bien que la commande xe host-backup fonctionne si elle est exécutée sur l’hôte local (c’est-à-dire sans nom d’hôte spécifique spécifié), ne l’utilisez pas de cette façon. Cela remplirait la partition du domaine de contrôle avec le fichier de sauvegarde. N’utilisez la commande qu’à partir d’une machine distante hors hôte sur laquelle vous disposez d’espace pour stocker le fichier de sauvegarde.

host-bugreport-upload

xe host-bugreport-upload [host-selector=host_selector_value...] [url=destination_url http-proxy=http_proxy_name]
<!--NeedCopy-->

Générez un nouveau rapport de bogue (en utilisant xen-bugtool, avec tous les fichiers facultatifs inclus) et téléchargez-le sur le site FTP de support ou un autre emplacement.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

Les paramètres facultatifs sont http-proxy : utiliser le proxy HTTP spécifié, et url : charger vers cette URL de destination. Si les paramètres facultatifs ne sont pas utilisés, aucun serveur proxy n’est identifié et la destination est le site FTP de support par défaut.

host-call-plugin

xe host-call-plugin host-uuid=host_uuid plugin=plugin fn=function [args=args]
<!--NeedCopy-->

Appelle la fonction dans le plug-in sur l’hôte donné avec des arguments optionnels.

host-compute-free-memory

xe host-compute-free-memory
<!--NeedCopy-->

Calcule la quantité de mémoire libre sur l’hôte.

host-compute-memory-overhead

xe host-compute-memory-overhead
<!--NeedCopy-->

Calcule la surcharge mémoire de virtualisation d’un hôte.

host-cpu-info

xe host-cpu-info [uuid=uuid]
<!--NeedCopy-->

Répertorie des informations sur les processeurs physiques de l’hôte.

host-crashdump-destroy

xe host-crashdump-destroy uuid=crashdump_uuid
<!--NeedCopy-->

Supprimez un vidage sur incident d’hôte spécifié par son UUID du serveur Citrix Hypervisor.

host-crashdump-upload

xe host-crashdump-upload uuid=crashdump_uuid [url=destination_url] [http-proxy=http_proxy_name]
<!--NeedCopy-->

Téléchargez un vidage sur incident sur le site FTP de support ou un autre emplacement. Si les paramètres facultatifs ne sont pas utilisés, aucun serveur proxy n’est identifié et la destination est le site FTP de support par défaut. Les paramètres facultatifs sont http-proxy : utiliser le proxy HTTP spécifié, et url : charger vers cette URL de destination.

host-declare-dead

xe host-declare-dead uuid=host_uuid
<!--NeedCopy-->

Déclarez que l’hôte est mort sans le contacter explicitement.

Avertissement :

Cet appel est dangereux et peut entraîner une perte de données si l’hôte n’est pas réellement mort.

host-disable

xe host-disable [host-selector=host_selector_value...]
<!--NeedCopy-->

Désactive les serveurs Citrix Hypervisor spécifiés, ce qui empêche toute nouvelle machine virtuelle de démarrer sur eux. Cette action prépare les serveurs Citrix Hypervisor à être arrêtés ou redémarrés.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir sélecteurs d’hôte). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-disable-display

xe host-disable-display uuid=host_uuid
<!--NeedCopy-->

Désactivez l’affichage de l’hôte.

host-disable-local-storage-caching

xe host-disable-local-storage-caching
<!--NeedCopy-->

Désactive la mise en cache du stockage local sur l’hôte spécifié.

host-dmesg

xe host-dmesg [host-selector=host_selector_value...]
<!--NeedCopy-->

Obtenez un Xen dmesg (la sortie du tampon circulaire du noyau) à partir de serveurs Citrix Hypervisor spécifiés.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-emergency-ha-disable

xe host-emergency-ha-disable  [--force]
<!--NeedCopy-->

Désactivez HA sur l’hôte local. À utiliser uniquement pour récupérer un pool avec une configuration HA défectueuse.

host-emergency-management-reconfigure

xe host-emergency-management-reconfigure interface=uuid_of_management_interface_pif
<!--NeedCopy-->

Reconfigurez l’interface de gestion de ce serveur Citrix Hypervisor. Utilisez cette commande uniquement si le serveur Citrix Hypervisor est en mode d’urgence. Le mode d’urgence signifie que l’hôte est membre d’un pool de ressources dont le maître a disparu du réseau et ne peut pas être contacté après plusieurs tentatives.

host-emergency-reset-server-certificate

xe host-emergency-reset-server-certificate
<!--NeedCopy-->

Installe un certificat auto-signé sur le serveur Citrix Hypervisor sur lequel la commande est exécutée.

host-enable

xe host-enable [host-selector=host_selector_value...]
<!--NeedCopy-->

Active les serveurs Citrix Hypervisor spécifiés, ce qui permet de démarrer de nouvelles machines virtuelles sur eux.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-enable-display

xe host-enable-display uuid=host_uuid
<!--NeedCopy-->

Activer l’affichage de l’hôte.

host-enable-local-storage-caching

xe host-enable-local-storage-caching  sr-uuid=sr_uuid
<!--NeedCopy-->

Activez la mise en cache du stockage local sur l’hôte spécifié.

host-evacuate

xe host-evacuate [host-selector=host_selector_value...]
<!--NeedCopy-->

Live migre toutes les machines virtuelles en cours d’exécution vers d’autres hôtes appropriés d’un pool. Tout d’abord, désactivez l’hôte à l’aide de la commande host-disable.

Si l’hôte évacué est le maître du pool, un autre hôte doit être sélectionné pour être le maître du pool. Pour modifier le maître de pool avec HA désactivé, utilisez la commande pool-designate-new-master. Pour plus d’informations, voir pool-designate-new-master.

Lorsque HA est activé, votre seule option est d’arrêter le serveur, ce qui oblige HA à élire un nouveau maître au hasard. Pour plus d’informations, consultez la section arrêt de l’hôte.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-forget

xe host-forget uuid=host_uuid
<!--NeedCopy-->

L’agent XAPI oublie le serveur Citrix Hypervisor spécifié sans le contacter explicitement.

Utilisez le paramètre --force pour éviter d’être invité à confirmer que vous souhaitez réellement effectuer cette opération.

Avertissement :

N’utilisez pas cette commande si HA est activé sur le pool. Désactivez d’abord HA, puis réactivez-le après avoir oublié l’hôte.

Cette commande est utile si le serveur Citrix Hypervisor à « oublier » est inactif. Toutefois, si le serveur Citrix Hypervisor est actif et fait partie du pool, utilisez plutôt xe pool-eject.

host-get-cpu-features

xe host-get-cpu-features {features=pool_master_cpu_features} [uuid=host_uuid]
<!--NeedCopy-->

Imprime une représentation hexadécimale des fonctionnalités du processeur physique de l’hôte.

host-get-server-certificate

xe host-get-server-certificate
<!--NeedCopy-->

Obtenez le certificat TLS du serveur installé.

host-get-sm-diagnostics

xe host-get-sm-diagnostics uuid=uuid
<!--NeedCopy-->

Affiche les informations de diagnostic SM par hôte.

host-get-system-status

xe host-get-system-status filename=name_for_status_file [entries=comma_separated_list] [output=tar.bz2|zip] [host-selector=host_selector_value...]
<!--NeedCopy-->

Téléchargez les informations sur l’état du système dans le fichier spécifié. Le paramètre facultatif entries est une liste séparée par des virgules d’entrées d’état système, tirée du fragment XML des capacités renvoyé par la commande host-get-system-status-capabilities. Pour plus d’informations, consultez host-get-system-status-capabilities. Si elle n’est pas spécifiée, toutes les informations sur l’état du système sont enregistrées dans le fichier. Le paramètre output peut être tar.bz2 (valeur par défaut) ou zip. Si ce paramètre n’est pas spécifié, le fichier est enregistré au format tar.bz2.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus).

host-get-system-status-capabilities

xe host-get-system-status-capabilities [host-selector=host_selector_value...]
<!--NeedCopy-->

Obtenez les capacités d’état du système pour les hôtes spécifiés. Les fonctionnalités sont renvoyées sous la forme d’un fragment XML similaire à l’exemple suivant :

<?xml version="1.0" ?>
<system-status-capabilities>
    <capability content-type="text/plain" default-checked="yes" key="xenserver-logs"  \
        max-size="150425200" max-time="-1" min-size="150425200" min-time="-1" \
        pii="maybe"/>
    <capability content-type="text/plain" default-checked="yes" \
        key="xenserver-install" max-size="51200" max-time="-1" min-size="10240" \
        min-time="-1" pii="maybe"/>
    ...
</system-status-capabilities>
<!--NeedCopy-->

Chaque entité de capacité peut avoir les attributs suivants.

  • key Un identifiant unique pour la capacité.
  • content-type Il peut s’agir de texte/brut ou d’application/de données. Indique si une interface utilisateur peut afficher les entrées pour la consommation humaine.
  • default-checked Cela peut être oui ou non. Indique si l’interface utilisateur doit sélectionner cette entrée par défaut.
  • min-size, max-size Indique une plage approximative de la taille, en octets, de cette entrée. -1 indique que la taille est sans importance.
  • min-time, max-time Indiquez une plage approximative pour le temps, en secondes, pris pour collecter cette entrée. -1 indique que l’heure n’est pas importante.
  • pii Informations personnellement identifiables. Indique si l’entrée contient des informations permettant d’identifier le propriétaire du système ou des détails sur la topologie de son réseau. L’attribut peut prendre l’une des valeurs suivantes :

    • no: aucune PII ne figure dans ces entrées
    • yes: les PII se trouvent probablement ou certainement dans ces entrées
    • maybe: vous souhaiterez peut-être auditer ces entrées pour les informations personnelles
    • if_customized si les fichiers ne sont pas modifiés, ils ne contiennent aucune PII. Cependant, étant donné que nous encourageons la modification de ces fichiers, les PII peuvent avoir été introduites par une telle personnalisation. Cette valeur est utilisée en particulier pour les scripts de mise en réseau du domaine de contrôle.

    Les mots de passe ne doivent jamais être inclus dans aucun rapport de bogue, quelle que soit la déclaration PII.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus).

host-get-thread-diagnostics

xe host-get-thread-diagnostics uuid=uuid
<!--NeedCopy-->

Afficher les informations de diagnostic de thread par hôte.

host-get-vms-which-prevent-evacuation

xe host-get-vms-which-prevent-evacuation uuid=uuid
<!--NeedCopy-->

Renvoie une liste des machines virtuelles qui empêchent l’évacuation d’un hôte spécifique et affiche les raisons pour chacune d’elles.

host-is-in-emergency-mode

xe host-is-in-emergency-mode
<!--NeedCopy-->

Renvoie true si l’hôte avec lequel la CLI parle est en mode d’urgence, sinon false. Cette commande CLI fonctionne directement sur les serveurs membres du pool, même en l’absence de serveur maître.

host-license-add

xe host-license-add [license-file=path/license_filename] [host-uuid=host_uuid]
<!--NeedCopy-->

Pour Citrix Hypervisor (édition gratuite), utilisez pour analyser un fichier de licence local et l’ajouter au serveur Citrix Hypervisor spécifié.

host-license-remove

xe host-license-remove [host-uuid=host_uuid]
<!--NeedCopy-->

Supprimez toute licence appliquée à un hôte.

host-license-view

xe host-license-view [host-uuid=host_uuid]
<!--NeedCopy-->

Affiche le contenu de la licence du serveur Citrix Hypervisor.

host-logs-download

xe host-logs-download [file-name=logfile_name] [host-selector=host_selector_value...]
<!--NeedCopy-->

Téléchargez une copie des journaux des serveurs Citrix Hypervisor spécifiés. La copie est enregistrée par défaut dans un fichier horodaté nommé hostname-yyyy-mm-dd T hh:mm:ssZ.tar.gz. Vous pouvez spécifier un autre nom de fichier à l’aide du paramètre optionnel nom_fichier.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

Important :

Bien que la commande xe host-logs-download fonctionne si elle est exécutée sur l’hôte local (c’est-à-dire sans un nom d’hôte spécifique spécifié), ne l’utilisez pas de cette façon. Cela encombre la partition du domaine de contrôle avec la copie des journaux. La commande ne doit être utilisée qu’à partir d’une machine hors hôte distante sur laquelle vous disposez d’un espace pour conserver la copie des journaux.

host-management-disable

xe host-management-disable
<!--NeedCopy-->

Désactive l’écoute de l’agent hôte sur une interface réseau de gestion externe et déconnecte tous les clients API connectés (tels que XenCenter). Cette commande fonctionne directement sur le serveur Citrix Hypervisor auquel l’interface de ligne de commande est connectée. La commande n’est pas transmise au maître de pool lorsqu’elle est appliquée à un serveur Citrix Hypervisor membre.

Avertissement :

Soyez prudent lorsque vous utilisez cette commande CLI hors hôte. Une fois cette commande exécutée, vous ne pouvez pas vous connecter au domaine de contrôle à distance via le réseau pour réactiver l’agent hôte.

host-management-reconfigure

xe host-management-reconfigure [interface=device] [pif-uuid=uuid]
<!--NeedCopy-->

Reconfigure le serveur Citrix Hypervisor pour utiliser l’interface réseau spécifiée comme interface de gestion, qui est l’interface utilisée pour se connecter à XenCenter. La commande réécrit la clé MANAGEMENT_INTERFACE dans /etc/xensource-inventory.

Si le nom de l’appareil d’une interface (qui doit avoir une adresse IP) est spécifié, le serveur Citrix Hypervisor se lie immédiatement. Cette commande fonctionne à la fois en mode normal et en mode urgence.

Si l’UUID d’un objet PIF est spécifié, le serveur Citrix Hypervisor détermine l’adresse IP à laquelle il doit se relier. Il ne doit pas être en mode d’urgence lorsque cette commande est exécutée.

Avertissement :

Soyez prudent lorsque vous utilisez cette commande CLI hors hôte et assurez-vous que vous disposez d’une connectivité réseau sur la nouvelle interface. Utilisez xe pif-reconfigure pour en configurer un en premier. Sinon, les commandes CLI suivantes ne peuvent pas atteindre le serveur Citrix Hypervisor.

host-power-on

xe host-power-on [host=host_uuid]
<!--NeedCopy-->

Met sous tension les serveurs Citrix Hypervisor lorsque la fonction Host Power On est activée. Avant d’utiliser cette commande, activez host-set-power-on sur l’hôte

host-reboot

xe host-reboot [host-selector=host_selector_value...]
<!--NeedCopy-->

Redémarrez les serveurs Citrix Hypervisor spécifiés. Les hôtes spécifiés doivent d’abord être désactivés à l’aide de la commande xe host-disable, sinon un message d’erreur HOST_IN_USE s’affiche.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

Si les serveurs Citrix Hypervisor spécifiés sont membres d’un pool, la perte de connectivité lors de l’arrêt est gérée et le pool se rétablit lorsque la connectivité aux serveurs Citrix Hypervisor est rétablit. Les autres membres et le maître continuent de fonctionner.

Si vous arrêtez le maître, le pool est hors service jusqu’à ce que l’une des actions suivantes se produise :

  • Vous faites de l’un des membres le maître
  • Le maître d’origine est redémarré et remis en ligne.

    Lorsque le maître est de nouveau en ligne, les membres se reconnectent et se synchronisent avec le maître.

host-restore

xe host-restore [file-name=backup_filename] [host-selector=host_selector_value...]
<!--NeedCopy-->

Restaurez une sauvegarde nommée file-name du logiciel de contrôle du serveur Citrix Hypervisor. L’utilisation du mot « restauration » ici ne signifie pas une restauration complète au sens habituel du terme, cela signifie simplement que le fichier de sauvegarde compressé a été décompressé et décompressé sur la partition secondaire. Après avoir fait un xe host-restore, vous devez démarrer le CD d’installation et utiliser son option Restaurer à partir de la sauvegarde.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-send-debug-keys

xe host-send-debug-keys  host-uuid=host_uuid keys=keys
<!--NeedCopy-->

Envoyer les clés de débogage d’hyperviseur spécifiées à l’hôte spécifié.

host-server-certificate-install

xe host-server-certificate-install certificate=path_to_certificate_file private-key=path_to_private_key [certificate-chain=path_to_chain_file] [host=host_name | uuid=host_uuid]
<!--NeedCopy-->

Installez un certificat TLS sur un serveur Citrix Hypervisor.

host-set-hostname-live

xe host-set-hostname-live host-uuid=uuid_of_host host-name=new_hostname
<!--NeedCopy-->

Modifiez le nom d’hôte du serveur Citrix Hypervisor spécifié par host-uuid. Cette commande définit de manière persistante à la fois le nom d’hôte dans la base de données du domaine de contrôle et le nom d’hôte Linux réel du serveur Citrix Hypervisor. La valeur de host-name n’est pas la même que la valeur du champ name_label.

host-set-power-on-mode

xe host-set-power-on-mode host=host_uuid power-on-mode={"" | "wake-on-lan" | "DRAC" | "custom"} \
    [ power-on-config:power_on_ip=ip-address power-on-config:power_on_user=user power-on-config:power_on_password_secret=secret-uuid ]
<!--NeedCopy-->

Permet d’activer la fonction Host Power On sur les hôtes Citrix Hypervisor compatibles avec les solutions d’alimentation à distance. Lorsque vous utilisez la commande host-set-power-on, vous devez spécifier le type de solution de gestion de l’alimentation sur l’hôte (c’est-à-dire le mode d’alimentation). Spécifiez ensuite les options de configuration à l’aide de l’argument power-on-config et de ses paires clé-valeur associées.

Pour utiliser la fonction Secrets pour stocker votre mot de passe, spécifiez la clé "power_on_password_secret". Pour plus d’informations, consultez Secrets.

host-shutdown

xe host-shutdown [host-selector=host_selector_value...]
<!--NeedCopy-->

Arrêtez les serveurs Citrix Hypervisor spécifiés. Les serveurs Citrix Hypervisor spécifiés doivent d’abord être désactivés à l’aide de la commande xe host-disable, sinon un message HOST_IN_USE d’erreur s’affiche.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

Si les serveurs Citrix Hypervisor spécifiés sont membres d’un pool, la perte de connectivité lors de l’arrêt est gérée et le pool se rétablit lorsque la connectivité aux serveurs Citrix Hypervisor est rétablit. Les autres membres et le maître continuent de fonctionner.

Si vous arrêtez le maître, le pool est hors service jusqu’à ce que l’une des actions suivantes se produise :

  • Vous faites de l’un des membres le maître
  • Le maître d’origine est redémarré et remis en ligne.

    Lorsque le maître est de nouveau en ligne, les membres se reconnectent et se synchronisent avec le maître.

Si HA est activé pour le pool, l’un des membres est automatiquement transformé en maître. Si HA est désactivée, vous devez désigner manuellement le serveur souhaité comme maître avec la commande pool-designate-new-master. Pour plus d’informations, voir pool-designate-new-master.

host-sm-dp-destroy

xe host-sm-dp-destroy uuid=uuid dp=dp [allow-leak=true|false]
<!--NeedCopy-->

Essayez de détruire et de nettoyer un chemin de données de stockage sur un hôte. Si allow-leak=true est fourni, il supprime tous les enregistrements du chemin de données même s’il n’est pas arrêté proprement.

host-sync-data

xe host-sync-data
<!--NeedCopy-->

Synchronisez les données stockées sur le maître de pool avec l’hôte nommé. Cela n’inclut pas les données de la base de données).

host-syslog-reconfigure

xe host-syslog-reconfigure [host-selector=host_selector_value...]
<!--NeedCopy-->

Reconfigurez le démon syslog sur les serveurs Citrix Hypervisor spécifiés. Cette commande applique les informations de configuration définies dans le paramètre hôte logging.

Les hôtes sur lesquels cette opération doit être effectuée sont sélectionnés à l’aide du mécanisme de sélection standard (voir les sélecteurs d’hôteci-dessus). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section.

host-data-source-list

xe host-data-source-list [host-selectors=host selector value...]
<!--NeedCopy-->

Répertorie les sources de données pouvant être enregistrées pour un hôte.

Sélectionnez les hôtes sur lesquels effectuer cette opération à l’aide du mécanisme de sélection standard (voir sélecteurs d’hôte). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section. Si aucun paramètre de sélection des hôtes n’est donné, l’opération est effectuée sur tous les hôtes.

Les sources de données ont deux paramètres : standard et enabled. Cette commande génère les valeurs des paramètres :

  • Si une source de données a enabled défini sur true, les mesures sont actuellement enregistrées dans la base de données de performances.
  • Si une source de données a standard défini sur true, les mesures sont enregistrées par défaut dans la base de données de performances. La valeur de enabled est également définie sur true pour cette source de données.
  • Si une source de données a standard défini sur false, les mesures ne sont pas enregistrées par défaut dans la base de données de performances. La valeur de enabled est également définie sur false pour cette source de données.

Pour commencer à enregistrer des mesures de source de données dans la base de données de performances, exécutez la commande host-data-source-record. Cette commande définit enabled sur true. Pour arrêter, lancez le host-data-source-forget. Cette commande définit enabled sur false.

host-data-source-record

xe host-data-source-record data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

Enregistrez la source de données spécifiée pour un hôte.

Cette opération écrit les informations de la source de données dans la base de données des mesures de performance persistantes des hôtes spécifiés. Pour des raisons de performances, cette base de données est distincte de la base de données de l’agent normal.

Sélectionnez les hôtes sur lesquels effectuer cette opération à l’aide du mécanisme de sélection standard (voir sélecteurs d’hôte). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section. Si aucun paramètre de sélection des hôtes n’est donné, l’opération est effectuée sur tous les hôtes.

host-data-source-forget

xe host-data-source-forget data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

Arrêtez d’enregistrer la source de données spécifiée pour un hôte et oubliez toutes les données enregistrées.

Sélectionnez les hôtes sur lesquels effectuer cette opération à l’aide du mécanisme de sélection standard (voir sélecteurs d’hôte). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section. Si aucun paramètre de sélection des hôtes n’est donné, l’opération est effectuée sur tous les hôtes.

host-data-source-query

xe host-data-source-query data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

Affiche la source de données spécifiée pour un hôte.

Sélectionnez les hôtes sur lesquels effectuer cette opération à l’aide du mécanisme de sélection standard (voir sélecteurs d’hôte). Les arguments facultatifs peuvent être n’importe quel nombre des paramètres d’hôte répertoriés au début de cette section. Si aucun paramètre de sélection des hôtes n’est donné, l’opération est effectuée sur tous les hôtes.

OBSOLETE : commandes de journal

Commandes permettant de travailler avec les journaux.

OBSOLETE : log-get

xe log-get
<!--NeedCopy-->

Retourne le journal actuellement stocké dans l’enregistreur de chaînes.

OBSOLETE : log-get-keys

xe log-get-keys
<!--NeedCopy-->

Répertorie les clés connues par l’enregistreur.

OBSOLETE : log-reopen

xe log-reopen
<!--NeedCopy-->

Rouvrez tous les enregistreurs (utilisez-le pour faire pivoter les fichiers).

OBSOLETE : log-set-output

xe log-set-output output=output [key=key] [level=level]
<!--NeedCopy-->

Définissez tous les journaux sur la sortie spécifiée (nil, stderr, string, file:nom de fichier, syslog:quelque chose).

Commandes de message

Commandes permettant de travailler avec les messages. Les messages sont créés pour informer les utilisateurs des événements importants et sont affichés dans XenCenter sous forme d’alertes.

Les objets de message peuvent être répertoriés avec la commande de listage d’objets standard (xe message-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres des messages

Nom du paramètre Description Type
uuid L’identificateur unique/la référence de l’objet pour le message Lecture seule
name Le nom unique du message Lecture seule
priority La priorité du message. Les chiffres élevés indiquent une plus grande priorité Lecture seule
class La classe de message, par exemple VM. Lecture seule
obj-uuid L’UUID de l’objet affecté. Lecture seule
timestamp Heure à laquelle le message a été généré. Lecture seule
body Le contenu du message. Lecture seule

message-create

xe message-create name=message_name body=message_text [[host-uuid=uuid_of_host] | [sr-uuid=uuid_of_sr] | [vm-uuid=uuid_of_vm] | [pool-uuid=uuid_of_pool]]
<!--NeedCopy-->

Crée un message.

message-destroy

xe message-destroy [uuid=message_uuid]
<!--NeedCopy-->

Détruit un message existant. Vous pouvez créer un script pour détruire tous les messages. Par exemple :

# Dismiss all alerts   \
    IFS=","; for m in $(xe message-list params=uuid --minimal); do  \
    xe message-destroy uuid=$m  \
    done
<!--NeedCopy-->

Commandes réseau

Commandes pour travailler avec les réseaux.

Les objets réseau peuvent être répertoriés avec la commande de listage d’objets standard (xe network-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres réseau

Les réseaux ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le réseau Lecture seule
name-label Le nom du réseau Lecture/Écriture
name-description Le texte de description du réseau Lecture/Écriture
VIF-uuids Une liste d’identifiants uniques des VIF (interfaces réseau virtuelles) qui sont attachées par les machines virtuelles à ce réseau Paramètre en lecture seule
PIF-uuids Liste des identifiants uniques des PIF (interfaces réseau physiques) qui sont attachés à ce réseau à partir des serveurs Citrix Hypervisor Paramètre en lecture seule
bridge Nom du pont correspondant à ce réseau sur le serveur Citrix Hypervisor local Lecture seule
default-locking-mode Objet réseau utilisé avec des objets VIF pour le filtrage ARP. Définissez sur unlocked pour supprimer toutes les règles de filtrage associées au VIF. Définissez sur disabled telle sorte que le VIF supprime tout le trafic. Lecture/Écriture
purpose Ensemble d’objectifs pour lesquels le serveur Citrix Hypervisor utilise ce réseau. Définissez sur nbd pour utiliser le réseau pour établir des connexions NBD. Lecture/Écriture
other-config:staticroutes Liste séparée par des virgules d’entrées formatées sous réseaux/masque de réseau/passerelle spécifiant l’adresse de passerelle à travers laquelle acheminer les sous-réseaux. Par exemple, si other-config:static-routes vous définissez la valeur 172.16.0.0/15/192.168.0.3,172.18.0.0/16/192.168.0.4, le trafic sur 172.16.0.0/15 est acheminé sur 192.168.0.3 et le trafic sur 172.18.0.0/16 sur 192.168.0.4. Lecture/Écriture
other-config:ethtoolautoneg Définissez cette option sur no pour désactiver la négociation automatique de l’interface physique ou du pont. La valeur par défaut est oui. Lecture/Écriture
other-config:ethtool-rx Définissez sur on pour activer la somme de contrôle de réception, sur off pour désactiver Lecture/Écriture
other-config:ethtool-tx Définissez sur on pour activer la somme de contrôle de transmission, sur off pour désactiver Lecture/Écriture
other-config:ethtool-sg Définissez sur on pour activer la ventilation-regroupement, sur off pour désactiver Lecture/Écriture
other-config:ethtool-tso Définissez sur on pour activer le déchargement de la segmentation TCP, sur off pour désactiver Lecture/Écriture
other-config:ethtool-ufo Définissez sur on pour activer le déchargement des fragments UDP, off pour désactiver Lecture/Écriture
other-config:ethtool-gso Définissez sur on pour activer le déchargement de la segmentation générique, sur off pour désactiver Lecture/Écriture
blobs Magasin de données binaires Lecture seule

network-create

xe network-create name-label=name_for_network [name-description=descriptive_text]
<!--NeedCopy-->

Crée un réseau.

network-destroy

xe network-destroy uuid=network_uuid
<!--NeedCopy-->

Détruit un réseau existant.

Commandes SR-IOV

Commandes pour travailler avec SR-IOV.

Les objets network-sriov peuvent être listés avec la commande de liste d’objets standard (xe network-sriov-list), et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres SR-IOV

SR-IOV possède les paramètres suivants :

Nom du paramètre Description Type
physical-PIF Le PIF pour activer SR-IOV. Lecture seule
logical-PIF Un PIF logique SR-IOV. Les utilisateurs peuvent utiliser ce paramètre pour créer un réseau VLAN SR-IOV. Lecture seule
requires-reboot S’il est défini sur True, utilisé pour redémarrer l’hôte afin de mettre en œuvre l’activation SR-IOV. Lecture seule
remaining-capacity Nombre de VF disponibles restants. Lecture seule

network-sriov-create

xe network-sriov-create network-uuid=network_uuid pif-uuid=physical_pif_uuid
<!--NeedCopy-->

Crée un objet réseau SR-IOV pour un PIF physique donné et active SR-IOV sur le PIF physique.

network-sriov-destroy

xe network-sriov-destroy uuid=network_sriov_uuid
<!--NeedCopy-->

Supprime un objet SR-IOV réseau et désactive SR-IOV sur son PIF physique.

Attribuer un VF SR-IOV

xe vif-create device=device_index mac=vf_mac_address network-uuid=sriov_network vm-uuid=vm_uuid
<!--NeedCopy-->

Attribue un VF d’un réseau SR-IOV à une machine virtuelle.

Commandes du contrôleur SDN

Commandes permettant de travailler avec le contrôleur SDN.

sdn-controller-forget

xe sdn-controller-introduce [address=address] [protocol=protocol] [tcp-port=tcp_port]
<!--NeedCopy-->

Introduisez un contrôleur SDN.

sdn-controller-introduce

xe sdn-controller-forget uuid=uuid
<!--NeedCopy-->

Retirez un contrôleur SDN.

Commandes du tunnel

Commandes pour travailler avec les tunnels.

tunnel-create

xe tunnel-create pif-uuid=pif_uuid network-uuid=network_uuid
<!--NeedCopy-->

Créez un nouveau tunnel sur un hôte.

tunnel-destroy

xe tunnel-destroy uuid=uuid
<!--NeedCopy-->

Détruisez un tunnel.

Commandes de correctifs

Commandes permettant de travailler avec des correctifs.

patch-apply

xe patch-apply uuid=patch_uuid host-uuid=host_uuid
<!--NeedCopy-->

Appliquez le correctif précédemment chargé à l’hôte spécifié.

patch-clean

xe patch-clean uuid=uuid
<!--NeedCopy-->

Supprimez un fichier de correctif précédemment chargé.

patch-destroy

xe patch-destroy uuid=uuid
<!--NeedCopy-->

Supprimez un enregistrement de correctif non appliqué et des fichiers du serveur.

patch-pool-apply

xe patch-pool-apply uuid=uuid
<!--NeedCopy-->

Appliquez le correctif précédemment chargé à tous les hôtes du pool.

patch-pool-clean

xe patch-pool-clean uuid=uuid
<!--NeedCopy-->

Supprimez un fichier de correctif précédemment chargé sur tous les hôtes du pool.

patch-precheck

xe patch-precheck uuid=uuid host-uuid=host_uuid
<!--NeedCopy-->

Exécutez les pré-vérifications contenues dans le correctif précédemment téléchargé sur l’hôte spécifié.

patch-upload

xe patch-upload file-name=file_name
<!--NeedCopy-->

Téléchargez un fichier de correctif sur le serveur.

Commandes PBD

Commandes pour travailler avec des PBD (Physical Block Devices). Les PBD sont les objets logiciels par le biais desquels le serveur Citrix Hypervisor accède aux référentiels de stockage (SR).

Les objets PBD peuvent être répertoriés avec la commande de listage d’objets standard (xe pbd-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres PBD

Les PBD ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le PBD. Lecture seule
sr-uuid Le référentiel de stockage vers lequel pointe le PBD Lecture seule
device-config Informations de configuration supplémentaires fournies au pilote de backend SR d’un hôte Paramètre de mappage en lecture seule
currently-attached True si le SR est connecté à cet hôte, False sinon Lecture seule
host-uuid UUID de la machine physique sur laquelle le PBD est disponible Lecture seule
host Le champ host est obsolète. Utilisez plutôt host_uuid. Lecture seule
other-config Informations de configuration supplémentaires. Paramètre de mappage en lecture/écriture

pbd-create

xe pbd-create host-uuid=uuid_of_host sr-uuid=uuid_of_sr [device-config:key=corresponding_value]
<!--NeedCopy-->

Créez un PBD sur votre serveur Citrix Hypervisor. Le device-config paramètre en lecture seule ne peut être défini qu’à la création.

Pour ajouter un mappage de ‘path’ à ‘/ tmp’, la ligne de commande doit contenir l’argument device-config:path=/tmp

Pour obtenir la liste complète des paires clé/valeur de configuration périphérique prises en charge pour chaque type SR, reportez-vous à la section Stockage.

pbd-destroy

xe pbd-destroy uuid=uuid_of_pbd
<!--NeedCopy-->

Détruisez le PBD spécifié.

pbd-plug

xe pbd-plug uuid=uuid_of_pbd
<!--NeedCopy-->

Tente de connecter le PBD au serveur Citrix Hypervisor. Si cette commande aboutit, le SR référencé (et les VDI qu’il contient) doivent alors devenir visibles par le serveur Citrix Hypervisor.

pbd-unplug

xe pbd-unplug uuid=uuid_of_pbd
<!--NeedCopy-->

Essayez de débrancher le PBD du serveur Citrix Hypervisor.

Commandes PIF

Commandes permettant de travailler avec des PIF (objets représentant les interfaces réseau physiques).

Les objets PIF peuvent être répertoriés avec la commande de listage d’objets standard (xe pif-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres PIF

Les PIF ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant/référence d’objet unique pour le PIF Lecture seule
device machine-readable Nom de l’interface (par exemple, eth0) Lecture seule
MAC L’adresse MAC du PIF Lecture seule
other-config Paires name:value de configuration PIF supplémentaires. Paramètre de mappage en lecture/écriture
physical Si vrai, le PIF pointe vers une interface réseau physique réelle Lecture seule
currently-attached Le PIF est-il actuellement attaché à cet hôte ? true ou false Lecture seule
MTU Unité de transmission maximale du PIF en octets. Lecture seule
VLAN Balise VLAN pour tout le trafic passant par cette interface. -1 indique qu’aucune balise VLAN n’est attribuée Lecture seule
bond-master-of L’UUID de l’obligation que ce PIF est le maître de (le cas échéant) Lecture seule
bond-slave-of L’UUID de la liaison dont ce PIF fait partie (le cas échéant) Lecture seule
management Ce PIF est-il désigné comme interface de gestion pour le domaine de contrôle ? Lecture seule
network-uuid Identifiant unique/référence d’objet du réseau virtuel auquel ce PIF est connecté Lecture seule
network-name-label Le nom du réseau virtuel auquel ce PIF est connecté Lecture seule
host-uuid L’identificateur/la référence d’objet unique du serveur Citrix Hypervisor auquel ce PIF est connecté Lecture seule
host-name-label Le nom du serveur Citrix Hypervisor auquel ce PIF est connecté Lecture seule
IP-configuration-mode Type de configuration d’adresse réseau utilisée ; DHCP ou statique Lecture seule
IP Adresse IP du PIF. Défini ici lorsque le mode de configuration IP est statique ; non défini lorsque DHCP Lecture seule
netmask Masque de réseau du PIF. Défini ici lorsque le mode de configuration IP est statique ; non défini lorsqu’il est fourni par DHCP Lecture seule
gateway Adresse de passerelle du PIF. Défini ici lorsque le mode de configuration IP est statique ; non défini lorsqu’il est fourni par DHCP Lecture seule
DNS Adresse DNS du PIF. Défini ici lorsque le mode de configuration IP est statique ; non défini lorsqu’il est fourni par DHCP Lecture seule
io_read_kbs Taux de lecture moyen en Ko/s pour l’appareil Lecture seule
io_write_kbs Taux d’écriture moyen en Ko/s pour l’appareil Lecture seule
carrier État du lien pour cet appareil Lecture seule
vendor-id L’ID attribué au fournisseur de la carte réseau Lecture seule
vendor-name Le nom du fournisseur de la carte réseau Lecture seule
device-id ID attribué par le fournisseur à ce modèle de carte réseau Lecture seule
device-name Le nom attribué par le fournisseur à ce modèle de carte réseau Lecture seule
speed Taux de transfert de données de la carte réseau Lecture seule
duplex Mode recto verso de la carte réseau ; pleine ou moitié Lecture seule
pci-bus-path Adresse du chemin du bus PCI Lecture seule
other-config:ethtoolspeed Définit la vitesse de connexion en Mbits/s Lecture/Écriture
other-config:ethtoolautoneg Définissez cette option sur no pour désactiver la négociation automatique de l’interface physique ou du pont. La valeur par défaut est oui. Lecture/Écriture
other-config:ethtoolduplex Définit la capacité de duplexage du PIF, qu’il soit complet ou partiel. Lecture/Écriture
other-config:ethtool-rx Définissez sur on pour activer la somme de contrôle de réception, sur off pour désactiver Lecture/Écriture
other-config:ethtool-tx Définissez sur on pour activer la somme de contrôle de transmission, sur off pour désactiver Lecture/Écriture
other-config:ethtool-sg Définissez sur on pour activer la ventilation-regroupement, sur off pour désactiver Lecture/Écriture
other-config:ethtool-tso Définissez sur on pour activer le déchargement de la segmentation TCP, sur off pour désactiver Lecture/Écriture
other-config:ethtool-ufo Définissez sur on pour activer le déchargement des fragments UDP, off pour désactiver Lecture/Écriture
other-config:ethtool-gso Définissez sur on pour activer le déchargement de la segmentation générique, sur off pour désactiver Lecture/Écriture
other-config:domain Liste séparée par des virgules utilisée pour définir le chemin de recherche DNS Lecture/Écriture
other-config:bondmiimon Intervalle entre les vérifications de l’activité de la liaison, en millisecondes Lecture/Écriture
other-config:bonddowndelay Nombre de millisecondes à attendre après la perte du lien avant de vraiment considérer que le lien a disparu. Ce paramètre prend en compte la perte de liaison transitoire Lecture/Écriture
other-config:bondupdelay Nombre de millisecondes à attendre après l’apparition du lien avant de vraiment l’envisager. Permet le battement de liens. La valeur par défaut est 31s pour laisser le temps aux commutateurs de commencer à transférer le trafic. Lecture/Écriture
disallow-unplug True si ce PIF est une carte réseau de stockage dédiée, false dans le cas contraire Lecture/Écriture

Remarque :

Les modifications apportées aux champs other-config d’un PIF ne prennent effet qu’après un redémarrage. Alternativement, utilisez les commandes xe pif-unplug et xe pif-plug pour provoquer la réécriture de la configuration PIF.

pif-forget

xe pif-forget uuid=uuid_of_pif
<!--NeedCopy-->

Détruit l’objet PIF spécifié sur un hôte particulier.

pif-introduce

xe pif-introduce host-uuid=host_uuid mac=mac_address_for_pif device=interface_name
<!--NeedCopy-->

Créez un objet PIF représentant une interface physique sur le serveur Citrix Hypervisor spécifié.

pif-plug

xe pif-plug uuid=uuid_of_pif
<!--NeedCopy-->

Essayez d’afficher l’interface physique spécifiée.

pif-reconfigure-ip

xe pif-reconfigure-ip uuid=uuid_of_pif [mode=dhcp|mode=static] gateway=network_gateway_address IP=static_ip_for_this_pif netmask=netmask_for_this_pif [DNS=dns_address]
<!--NeedCopy-->

Modifiez l’adresse IP du PIF. Pour la configuration IP statique, définissez le paramètre mode sur static, avec les paramètres gateway, IP et netmask sur les valeurs appropriées. Pour utiliser DHCP, définissez le paramètre mode sur DHCP et laissez les paramètres statiques indéfinis.

Remarque :

L’utilisation d’adresses IP statiques sur des interfaces réseau physiques connectées à un port d’un commutateur à l’aide du protocole Spanning Tree avec STP Fast Link désactivé (ou non pris en charge) entraîne une période pendant laquelle il n’y a pas de trafic.

pif-reconfigure-ipv6

xe pif-reconfigure-ipv6 uuid=uuid_of_pif mode=mode [gateway=network_gateway_address] [IPv6=static_ip_for_this_pif] [DNS=dns_address]
<!--NeedCopy-->

Reconfigurez les paramètres d’adresse IPv6 sur un PIF.

pif-scan

xe pif-scan host-uuid=host_uuid
<!--NeedCopy-->

Recherchez de nouvelles interfaces physiques sur votre serveur Citrix Hypervisor.

pif-set-primary-address-type

xe pif-set-primary-address-type  uuid=uuid primary_address_type=address_type
<!--NeedCopy-->

Modifiez le type d’adresse principal utilisé par ce PIF.

pif-unplug

xe pif-unplug uuid=uuid_of_pif
<!--NeedCopy-->

Tentative de désactivation de l’interface physique spécifiée.

Commandes de pool

Commandes permettant de travailler avec des pools. Un pool est un agrégat d’un ou plusieurs serveurs Citrix Hypervisor. Un pool utilise un ou plusieurs référentiels de stockage partagé afin que les machines virtuelles exécutées sur un hôte du pool puissent être migrées en temps quasi réel vers un autre hôte du pool. Cette migration a lieu alors que la machine virtuelle est toujours en cours d’exécution, sans qu’il soit nécessaire de l’arrêter et de la remettre en marche. Chaque serveur Citrix Hypervisor est réellement un pool composé d’un seul membre par défaut. Lorsque votre serveur Citrix Hypervisor est joint à un pool, il est désigné en tant que membre et le pool auquel il a rejoint devient le groupe principal du pool.

L’objet de pool singleton peut être répertorié à l’aide de la commande de liste d’objets standard (xe pool-list). Ses paramètres peuvent être manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres du pool

Les pools ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur unique/la référence de l’objet pour le pool Lecture seule
name-label Le nom du pool Lecture/Écriture
name-description La chaîne de description du pool Lecture/Écriture
master L’identificateur/la référence d’objet unique du serveur Citrix Hypervisor désigné comme maître du pool Lecture seule
default-SR Identifiant unique/référence d’objet du SR par défaut pour le pool Lecture/Écriture
crash-dump-SR L’identificateur/référence d’objet unique du SR où tous les vidages sur incident pour les membres du pool sont enregistrés Lecture/Écriture
metadata-vdis Tous les VDI de métadonnées connus pour le pool Lecture seule
suspend-image-SR Identifiant unique/référence d’objet du SR où les machines virtuelles suspendues sur les membres du pool sont enregistrées Lecture/Écriture
other-config Une liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le pool Paramètre de mappage en lecture/écriture
supported-sr-types Types de SR que ce pool peut utiliser Lecture seule
ha-enabled True si HA est activé pour le pool, false sinon Lecture seule
ha-configuration Réservé pour une utilisation future. Lecture seule
ha-statefiles Répertorie les UUID des VDI utilisés par HA pour déterminer la santé du stockage Lecture seule
ha-host-failures-to-tolerate Le nombre de défaillances d’hôtes à tolérer avant l’envoi d’une alerte système Lecture/Écriture
ha-plan-exists-for Le nombre de pannes d’hôtes pouvant réellement être traitées, selon les calculs de l’algorithme HA Lecture seule
ha-allow-overcommit True si le pool est autorisé à être surchargé, False sinon Lecture/Écriture
ha-overcommitted True si le pool est surchargé Lecture seule
blobs Magasin de données binaires Lecture seule
live-patching-disabled Définissez la valeur False pour activer l’application de correctifs en direct. Définissez la valeur True pour désactiver l’application de correctifs en direct. Lecture/Écriture
igmp-snooping-enabled Définissez la valeur sur True pour activer la surveillance IGMP. Définissez cette propriété sur False pour désactiver la surveillance IGMP. Lecture/Écriture

pool-apply-edition

xe pool-apply-edition edition=edition [uuid=uuid] [license-server-address=address] [license-server-port=port]
<!--NeedCopy-->

Appliquez une édition à l’ensemble du pool.

pool-certificate-install

xe pool-certificate-install filename=file_name
<!--NeedCopy-->

Installez un certificat TLS à l’échelle du pool.

pool-certificate-list

xe pool-certificate-list
<!--NeedCopy-->

Répertorie tous les certificats TLS installés dans un pool.

pool-certificate-sync

xe pool-certificate-sync
<!--NeedCopy-->

Synchronisez les certificats TLS et les listes de révocation de certificats du maître de pool vers les autres membres du pool.

pool-certificate-uninstall

xe pool-certificate-uninstall name=name
<!--NeedCopy-->

Désinstallez un certificat TLS.

pool-crl-install

xe pool-crl-install filename=file_name
<!--NeedCopy-->

Installez une liste de révocation de certificats TLS, à l’échelle du pool.

pool-crl-list

xe pool-crl-list
<!--NeedCopy-->

Répertorie toutes les listes de révocation de certificats TLS installées.

pool-crl-uninstall

xe pool-crl-uninstall name=name
<!--NeedCopy-->

Désinstallez une liste de révocation de certificats TLS.

pool-deconfigure-wlb

xe pool-deconfigure-wlb
<!--NeedCopy-->

Supprimez définitivement la configuration d’équilibrage des charges de travail.

pool-designate-new-master

xe pool-designate-new-master host-uuid=uuid_of_new_master
<!--NeedCopy-->

Demandez au serveur Citrix Hypervisor membre spécifié de devenir le maître d’un pool existant. Cette commande effectue un transfert ordonné du rôle d’hôte maître vers un autre hôte du pool de ressources. Cette commande ne fonctionne que lorsque le master actuel est en ligne. Elle ne remplace pas les commandes du mode d’urgence répertoriées ci-dessous.

pool-disable-external-auth

xe pool-disable-external-auth [uuid=uuid] [config=config]
<!--NeedCopy-->

Désactive l’authentification externe sur tous les hôtes d’un pool.

pool-disable-local-storage-caching

xe pool-disable-local-storage-caching uuid=uuid
<!--NeedCopy-->

Désactivez la mise en cache du stockage local sur le pool.

pool-disable-redo-log

xe pool-disable-redo-log
<!--NeedCopy-->

Désactivez le journal de journalisation s’il est utilisé, sauf si HA est activé.

pool-dump-database

xe pool-dump-database file-name=filename_to_dump_database_into_(on_client)
<!--NeedCopy-->

Téléchargez une copie de l’intégralité de la base de données du pool et videz-la dans un fichier sur le client.

pool-enable-external-auth

xe pool-enable-external-auth  auth-type=auth_type service-name=service_name [uuid=uuid] [config:=config]
<!--NeedCopy-->

Active l’authentification externe dans tous les hôtes d’un pool. Notez que certaines valeurs de auth-type requièrent des valeurs config: particulières.

pool-enable-local-storage-caching

xe pool-enable-local-storage-caching uuid=uuid
<!--NeedCopy-->

Activez la mise en cache du stockage local dans le pool.

pool-enable-redo-log

xe pool-ensable-redo-log sr-uuid=sr_uuid
<!--NeedCopy-->

Activez le journal de rétablissement sur le SR donné s’il est utilisé, sauf si HA est activé.

pool-eject

xe pool-eject host-uuid=uuid_of_host_to_eject
<!--NeedCopy-->

Demandez au serveur Citrix Hypervisor spécifié de quitter un pool existant.

pool-emergency-reset-master

xe pool-emergency-reset-master master-address=address_of_pool_master
<!--NeedCopy-->

Demandez à un serveur membre du pool de réinitialiser son adresse de serveur maître à la nouvelle valeur et d’essayer de s’y connecter. N’exécutez pas cette commande sur les serveurs maîtres.

pool-emergency-transition-to-master

xe pool-emergency-transition-to-master
<!--NeedCopy-->

Demandez à un serveur Citrix Hypervisor membre de devenir le maître du pool. Le serveur Citrix Hypervisor accepte cette commande uniquement lorsque l’hôte est passé en mode d’urgence. Le mode d’urgence signifie qu’il est membre d’un pool dont le maître a disparu du réseau et ne peut pas être contacté après un certain nombre de tentatives.

Si le mot de passe de l’hôte a été modifié depuis que l’hôte a rejoint le pool, cette commande peut provoquer la réinitialisation du mot de passe de l’hôte. Pour plus d’informations, voir (Commandes utilisateur).

pool-ha-enable

xe pool-ha-enable heartbeat-sr-uuids=uuid_of_heartbeat_sr
<!--NeedCopy-->

Activez la haute disponibilité sur le pool de ressources, en utilisant l’UUID SR spécifié comme référentiel de pulsations de stockage central.

pool-ha-disable

xe pool-ha-disable
<!--NeedCopy-->

Désactive la fonctionnalité de haute disponibilité sur le pool de ressources.

pool-ha-compute-hypothetical-max-host-failures-to-tolerate

Calculez le nombre maximal de défaillances d’hôtes à tolérer dans la configuration actuelle du pool.

pool-ha-compute-max-host-failures-to-tolerate

xe pool-ha-compute-hypothetical-max-host-failures-to-tolerate [vm-uuid=vm_uuid] [restart-priority=restart_priority]
<!--NeedCopy-->

Calculez le nombre maximal de défaillances d’hôte à tolérer avec les machines virtuelles protégées proposées.

pool-initialize-wlb

xe pool-initialize-wlb wlb_url=url wlb_username=wlb_username wlb_password=wlb_password xenserver_username=username xenserver_password=password
<!--NeedCopy-->

Initialisez l’équilibrage de charge de travail pour le pool actuel avec le serveur d’équilibrage de charge de travail cible.

pool-join

xe pool-join master-address=address master-username=username master-password=password
<!--NeedCopy-->

Demandez à votre serveur Citrix Hypervisor de rejoindre un pool existant.

pool-management-reconfigure

xe pool-management-reconfigure [network-uuid=network-uuid]
<!--NeedCopy-->

Reconfigure l’interface de gestion de tous les hôtes du pool pour utiliser l’interface réseau spécifiée, qui est l’interface utilisée pour se connecter à XenCenter. La commande réécrit la clé MANAGEMENT_INTERFACE dans /etc/xensource-inventory pour tous les hôtes du pool.

Si le nom de la machine d’une interface (qui doit avoir une adresse IP) est spécifié, l’hôte principal Citrix Hypervisor se reconnecte immédiatement. Cette commande fonctionne à la fois en mode normal et en mode urgence.

À partir de l’UUID réseau spécifié, l’UUID de l’objet PIF est identifié et mappé au serveur Citrix Hypervisor, qui détermine l’adresse IP à se relier. Il ne doit pas être en mode d’urgence lorsque cette commande est exécutée.

Avertissement :

Soyez prudent lorsque vous utilisez cette commande CLI hors hôte et assurez-vous que vous disposez d’une connectivité réseau sur la nouvelle interface. Utilisez xe pif-reconfigure pour en configurer un en premier. Sinon, les commandes CLI suivantes ne peuvent pas atteindre le serveur Citrix Hypervisor.

pool-recover-slaves

xe pool-recover-slaves
<!--NeedCopy-->

Demandez au maître du pool d’essayer de réinitialiser l’adresse principale de tous les membres qui s’exécutent actuellement en mode d’urgence. Cette commande est généralement utilisée après que pool-emergency-transition-to-master ait été utilisé pour définir l’un des membres comme nouveau maître.

pool-restore-database

xe pool-restore-database file-name=filename_to_restore_from_on_client [dry-run=true|false]
<!--NeedCopy-->

Chargez une sauvegarde de base de données (créée avec pool-dump-database) dans un pool. À la réception du téléchargement, le maître redémarre lui-même avec la nouvelle base de données.

Il existe également une option d’essai, qui vous permet de vérifier que la base de données du pool peut être restaurée sans effectuer l’opération. Par défaut, dry-run est défini sur false.

pool-retrieve-wlb-configuration

xe pool-retrieve-wlb-configuration
<!--NeedCopy-->

Récupère les critères d’optimisation du pool sur le serveur d’équilibrage de la charge de travail.

pool-retrieve-wlb-diagnostics

xe pool-retrieve-wlb-diagnostics [filename=file_name]
<!--NeedCopy-->

Récupère les diagnostics du serveur d’équilibrage de la charge de travail.

pool-retrieve-wlb-recommendations

xe pool-retrieve-wlb-recommendations
<!--NeedCopy-->

Récupère les recommandations de migration de VM pour le pool auprès du serveur d’équilibrage de la charge de travail.

pool-retrieve-wlb-report

xe pool-retrieve-wlb-report report=report [filename=file_name]
<!--NeedCopy-->

Récupère les rapports du serveur d’équilibrage de la charge de travail.

pool-rotate-secret

xe pool-rotate-secret
<!--NeedCopy-->

Faites pivoter le secret du pool.

Le secret du pool est un secret partagé entre les serveurs d’un pool qui permet au serveur de prouver son appartenance à un pool. Les utilisateurs ayant le rôle d’administrateur de pool peuvent afficher ce secret lorsqu’ils se connectent au serveur via SSH. Faites pivoter le secret du pool si l’un de ces utilisateurs quitte votre organisation ou perd son rôle d’administrateur de pool.

pool-send-test-post

xe pool-send-test-post dest-host=destination_host dest-port=destination_port body=post_body
<!--NeedCopy-->

Envoyez le corps donné à l’hôte et au port donnés, en utilisant HTTPS, et imprimez la réponse. Ceci est utilisé pour déboguer la couche TLS.

pool-send-wlb-configuration

xe pool-send-wlb-configuration [config:=config]
<!--NeedCopy-->

Définit les critères d’optimisation du pool pour le serveur d’équilibrage de la charge de travail

pool-sync-database

xe pool-sync-database
<!--NeedCopy-->

Forcer la synchronisation de la base de données du pool sur tous les hôtes du pool de ressources. Cette commande n’est pas nécessaire en fonctionnement normal puisque la base de données est régulièrement répliquée automatiquement. Toutefois, la commande peut être utile pour garantir que les modifications sont rapidement répliquées après avoir effectué un ensemble important d’opérations CLI.

Définir le pool igmp-snooping

xe pool-param-set [uuid=pool-uuid] [igmp-snooping-enabled=true|false]
<!--NeedCopy-->

Active ou désactive la surveillance IGMP sur un pool Citrix Hypervisor.

Commandes PVS Accelerator

Commandes permettant de travailler avec le PVS Accelerator.

pvs-cache-storage-create

xe pvs-cache-storage-create sr-uuid=sr_uuid pvs-site-uuid=pvs_site_uuid size=size
<!--NeedCopy-->

Configurez un cache PVS sur un SR donné pour un hôte donné.

pvs-cache-storage-destroy

xe pvs-cache-storage-destroy uuid=uuid
<!--NeedCopy-->

Supprimez un cache PVS.

pvs-proxy-create

xe pvs-proxy-create pvs-site-uuid=pvs_site_uuid vif-uuid=vif_uuid
<!--NeedCopy-->

Configurez une VM/VIF pour utiliser un proxy PVS.

pvs-proxy-destroy

xe pvs-proxy-destroy uuid=uuid
<!--NeedCopy-->

Supprimez (ou désactivez) un proxy PVS pour cette VIF/VM.

pvs-server-forget

xe pvs-server-forget uuid=uuid
<!--NeedCopy-->

Oubliez un serveur PVS.

pvs-server-introduce

xe pvs-server-introduce addresses=adresses first-port=first_port last-port=last_port pvs-site-uuid=pvs_site_uuid
<!--NeedCopy-->

Introduisez le nouveau serveur PVS.

pvs-site-forget

xe pvs-site-forget uuid=uuid
<!--NeedCopy-->

Oubliez un site PVS.

pvs-site-introduce

xe pvs-site-introduce name-label=name_label [name-description=name_description] [pvs-uuid=pvs_uuid]
<!--NeedCopy-->

Présentation du nouveau site PVS.

Commandes du gestionnaire de stockage

Commandes permettant de contrôler les plug-ins Storage Manager.

Les objets du gestionnaire de stockage peuvent être répertoriés à l’aide de la commande standard de listage d’objets (xe sm-list). Les paramètres peuvent être manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres SM

Les SM ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le plug-in SM Lecture seule
name-label Le nom du plug-in SM Lecture seule
name-description La chaîne de description du module SM Lecture seule
type Le type SR auquel ce plug-in se connecte Lecture seule
vendor Nom du fournisseur qui a créé ce plug-in Lecture seule
copyright Déclaration de copyright pour ce plug-in SM Lecture seule
required-api-version Version minimale de l’API SM requise sur le serveur Citrix Hypervisor Lecture seule
configuration Noms et descriptions des clés de configuration de l’appareil Lecture seule
capabilities Fonctionnalités du plug-in SM Lecture seule
driver-filename Le nom de fichier du pilote SR. Lecture seule

Commandes d’instantanés

Commandes permettant de travailler avec des instantanés.

snapshot-clone

xe snapshot-clone new-name-label=name_label [uuid=uuid] [new-name-description=description]
<!--NeedCopy-->

Créez un nouveau modèle en clonant un instantané existant, à l’aide de l’opération de clonage rapide de disque au niveau du stockage, le cas échéant.

snapshot-copy

xe snapshot-copy new-name-label=name_label [uuid=uuid] [new-name-description=name_description] [sr-uuid=sr_uuid]
<!--NeedCopy-->

Créez un nouveau modèle en copiant une machine virtuelle existante, mais sans utiliser l’opération de clonage rapide de disque au niveau du stockage (même si elle est disponible). Les images disque de la machine virtuelle copiée sont garanties d’être des « images complètes », c’est-à-dire qu’elles ne font pas partie d’une chaîne CoW.

snapshot-destroy

xe snapshot-destroy  [uuid=uuid] [snapshot-uuid=snapshot_uuid]
<!--NeedCopy-->

Détruisez un instantané. Cela laisse intact le stockage associé à l’instantané. Pour supprimer également le stockage, utilisez snapshot-uninstall.

snapshot-disk-list

xe snapshot-disk-list [uuid=uuid] [snapshot-uuid=snapshot_uuid] [vbd-params=vbd_params] [vdi-params=vdi_params]
<!--NeedCopy-->

Répertoriez les disques sur la ou les machines virtuelles sélectionnées.

snapshot-export-to-template

xe snapshot-export-to-template filename=file_name snapshot-uuid=snapshot_uuid  [preserve-power-state=true|false]
<!--NeedCopy-->

Exportez un instantané vers un nom de fichier.

snapshot-reset-powerstate

xe snapshot-reset-powerstate [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
<!--NeedCopy-->

Force l’arrêt de l’alimentation de la machine virtuelle uniquement dans la base de données de la pile d’outils de gestion. Cette commande est utilisée pour récupérer un instantané marqué comme « suspendu ». Il s’agit d’une opération potentiellement dangereuse : vous devez vous assurer de ne plus avoir besoin de l’image mémoire. Vous ne pourrez plus reprendre votre instantané.

snapshot-revert

xe snapshot-revert [uuid=uuid] [snapshot-uuid=snapshot_uuid]
<!--NeedCopy-->

Rétablissez un point de contrôle ou un état d’instantané d’une machine virtuelle existante.

snapshot-uninstall

xe snapshot-uninstall [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
<!--NeedCopy-->

Désinstallez un instantané. Cette opération détruira les VDI marqués RW et connectés à ce snapshot uniquement. Pour simplement détruire l’enregistrement de la machine virtuelle, utilisez snapshot-destroy.

Commandes SR

Commandes pour contrôler les SR (référentiels de stockage).

Les objets SR peuvent être répertoriés avec la commande de listage d’objets standard (xe sr-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres SR

Les SR ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour la demande de service Lecture seule
name-label Le nom du SR Lecture/Écriture
name-description La chaîne de description de la SR Lecture/Écriture
allowed-operations Liste des opérations autorisées sur le SR dans cet état Paramètre en lecture seule
current-operations Liste des opérations actuellement en cours sur ce SR Paramètre en lecture seule
VDIs Identificateur/référence d’objet unique pour les disques virtuels de cette demande de service Paramètre en lecture seule
PBDs Identifiant unique/référence d’objet pour les PBD attachés à cette SR Paramètre en lecture seule
physical-utilisation Espace physique actuellement utilisé sur cette SR, en octets. Pour les formats de disques à provisionnement fin, l’utilisation physique peut être inférieure à l’allocation virtuelle Lecture seule
physical-size Taille physique totale du SR, en octets Lecture seule
type Type de SR, utilisé pour spécifier le pilote principal SR à utiliser Lecture seule
introduced-by Le drtask (le cas échéant) qui a introduit le RS Lecture seule
content-type Le type de contenu de la demande de service. Utilisé pour distinguer les bibliothèques ISO des autres SR. Pour les référentiels de stockage qui stockent une bibliothèque d’ISO, le type de contenu doit être défini sur iso. Dans d’autres cas, nous vous recommandons de définir ce paramètre sur empty ou sur string user. Lecture seule
shared True si ce SR peut être partagé entre plusieurs serveurs Citrix Hypervisor ; False dans le cas contraire Lecture/Écriture
other-config Liste des paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le SR Paramètre de mappage en lecture/écriture
host Nom d’hôte du référentiel de stockage Lecture seule
virtual-allocation Somme des valeurs de taille virtuelle de tous les VDI de ce référentiel de stockage (en octets) Lecture seule
sm-config Données dépendantes du SM Paramètre de mappage en lecture seule
blobs Magasin de données binaires Lecture seule

sr-create

xe sr-create name-label=name physical-size=size type=type content-type=content_type device-config:config_name=value [host-uuid=host_uuid] [shared=true|false]
<!--NeedCopy-->

Crée un SR sur le disque, l’introduit dans la base de données et crée un PBD reliant le SR au serveur Citrix Hypervisor. Si shared est défini sur true, un PBD est créé pour chaque serveur Citrix Hypervisor du pool. Si n’ shared est pas spécifié ou défini sur false, un PBD est créé uniquement pour le serveur Citrix Hypervisor spécifié avec host-uuid.

Les paramètres device-config exacts diffèrent en fonction de l’appareil type. Pour plus de détails sur ces paramètres sur les différents back-ends de stockage, reportez-vous à la section Stockage.

sr-data-source-forget

xe sr-data-source-forget data-source=data_source
<!--NeedCopy-->

Arrêtez d’enregistrer la source de données spécifiée pour une SR et oubliez toutes les données enregistrées.

sr-data-source-list

xe sr-data-source-list
<!--NeedCopy-->

Répertoriez les sources de données qui peuvent être enregistrées pour une demande de service.

sr-data-source-query

xe sr-data-source-query data-source=data_source
<!--NeedCopy-->

Interroge la dernière valeur lue à partir d’une source de données SR.

sr-data-source-record

xe sr-data-source-record  data-source=data_source
<!--NeedCopy-->

Enregistrez la source de données spécifiée pour une demande de service.

sr-destroy

xe sr-destroy uuid=sr_uuid
<!--NeedCopy-->

Détruit le SR spécifié sur le serveur Citrix Hypervisor.

sr-enable-database-replication

xe sr-enable-database-replication uuid=sr_uuid
<!--NeedCopy-->

Active la réplication de la base de données XAPI vers le SR (partagé) spécifié.

sr-disable-database-replication

xe sr-disable-database-replication uuid=sr_uuid
<!--NeedCopy-->

Désactive la réplication de la base de données XAPI vers le SR spécifié.

sr-forget

xe sr-forget uuid=sr_uuid
<!--NeedCopy-->

L’agent XAPI oublie un SR spécifié sur le serveur Citrix Hypervisor. Lorsque l’agent XAPI oublie un SR, celui-ci est détaché et vous ne pouvez pas accéder aux VDI qui s’y trouvent, mais il reste intact sur le support source (les données ne sont pas perdues).

sr-introduce

xe sr-introduce name-label=name physical-size=physical_size type=type content-type=content_type uuid=sr_uuid
<!--NeedCopy-->

Il suffit de placer un enregistrement SR dans la base de données. Permet device-config de spécifier des paramètres supplémentaires dans le formulaire device-config:parameter_key=parameter_value, par exemple :

xe sr-introduce device-config:device=/dev/sdb1
<!--NeedCopy-->

Remarque :

Cette commande n’est jamais utilisée en fonctionnement normal. Cette opération avancée peut être utile lorsqu’une SR doit être reconfigurée comme étant partagée après sa création ou pour aider à récupérer à partir de différents scénarios d’échec.

sr-probe

xe sr-probe type=type [host-uuid=host_uuid] [device-config:config_name=value]
<!--NeedCopy-->

Effectue une analyse du backend à l’aide des device-config clés fournies. Si device-config est terminé pour le back-end SR, cette commande renvoie une liste des SR présents sur le périphérique, le cas échéant. Si les paramètres device-config ne sont que partiels, une analyse spécifique au back-end est effectuée, renvoyant les résultats qui vous guident dans l’amélioration des paramètres device-config restants. Les résultats de l’analyse sont renvoyés au format XML spécifique au serveur principal, imprimés sur l’interface de ligne de commande.

Les paramètres device-config exacts diffèrent en fonction de l’appareil type. Pour plus de détails sur ces paramètres sur les différents back-ends de stockage, reportez-vous à la section Stockage.

sr-probe-ext

xe sr-probe-ext type=type [host-uuid=host_uuid] [device-config:=config] [sm-config:-sm_config]
<!--NeedCopy-->

Effectuez une sonde de stockage. Les paramètres de configuration du périphérique peuvent être spécifiés par exemple device-config:devs=/dev/sdb1. Contrairement à sr-probe, cette commande renvoie les résultats dans le même format lisible par l’homme pour chaque type de SR.

sr-scan

xe sr-scan uuid=sr_uuid
<!--NeedCopy-->

Forcer une analyse SR, en synchronisant la base de données XAPI avec les VDI présents dans le substrat de stockage sous-jacent.

sr-update

xe sr-update uuid=uuid
<!--NeedCopy-->

Actualisez les champs de l’objet SR dans la base de données.

lvhd-enable-thin-provisioning

xe lvhd-enable-thin-provisioning  sr-uuid=sr_uuid initial-allocation=initial_allocation allocation-quantum=allocation_quantum
<!--NeedCopy-->

Activez le Thin-Provisioning sur un SR LVHD.

Commandes du sujet

Commandes pour travailler avec des sujets.

session-subject-identifier-list

xe session-subject-identifier-list
<!--NeedCopy-->

Renvoie une liste de tous les ID d’objet utilisateur de toutes les sessions existantes authentifiées en externe.

session-subject-identifier-logout

xe session-subject-identifier-logout subject-identifier=subject_identifier
<!--NeedCopy-->

Déconnectez-vous de toutes les sessions authentifiées en externe associées à un ID d’objet utilisateur.

session-subject-identifier-logout-all

xe session-subject-identifier-logout-all
<!--NeedCopy-->

Déconnectez-vous de toutes les sessions authentifiées en externe.

subject-add

xe subject-add subject-name=subject_name
<!--NeedCopy-->

Ajoutez un sujet à la liste des sujets pouvant accéder au pool.

subject-remove

xe subject-remove subject-uuid=subject_uuid
<!--NeedCopy-->

Supprimez un sujet de la liste des sujets pouvant accéder au pool.

subject-role-add

xe subject-role-add uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
<!--NeedCopy-->

Ajoutez un rôle à un sujet.

subject-role-remove

xe subject-role-remove uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
<!--NeedCopy-->

Supprimez un rôle d’un sujet.

secret-create

xe secret-create value=value
<!--NeedCopy-->

Créez un secret.

secret-destroy

xe secret-destroy uuid=uuid
<!--NeedCopy-->

Détruisez un secret.

Commandes de tâches

Commandes permettant de travailler avec des tâches asynchrones de longue durée. Ces commandes sont des tâches telles que le démarrage, l’arrêt et la suspension d’une machine virtuelle. Les tâches sont généralement constituées d’un ensemble d’autres sous-tâches atomiques qui, ensemble, accomplissent l’opération demandée.

Les objets de tâche peuvent être répertoriés avec la commande de liste d’objets standard (xe task-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres des tâches

Les tâches ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour la tâche Lecture seule
name-label Le nom de la tâche Lecture seule
name-description La chaîne de description de la tâche Lecture seule
resident-on Identifiant unique/référence d’objet de l’hôte sur lequel la tâche est exécutée Lecture seule
status État de la tâche Lecture seule
progress Si la tâche est toujours en attente, ce champ contient le pourcentage d’achèvement estimé, compris entre 0 et 1. Si la tâche est terminée, avec succès ou non, la valeur est 1. Lecture seule
type Si la tâche s’est terminée avec succès, ce paramètre contient le type du résultat codé. Le type est le nom de la classe dont la référence se trouve dans le champ de résultat. Sinon, la valeur de ce paramètre n’est pas définie Lecture seule
result Si la tâche s’est terminée avec succès, ce champ contient la valeur du résultat, soit Void, soit une référence d’objet ; sinon, la valeur de ce paramètre n’est pas définie Lecture seule
error_info Si la tâche a échoué, ce paramètre contient l’ensemble des chaînes d’erreur associées. Sinon, la valeur de ce paramètre n’est pas définie Lecture seule
allowed_operations Liste des opérations autorisées dans cet état Lecture seule
created Heure à laquelle la tâche a été créée Lecture seule
finished Heure à laquelle la tâche s’est terminée (c’est-à-dire qu’elle a réussi ou échoué). Si le statut de la tâche est en attente, la valeur de ce champ n’a aucune signification Lecture seule
subtask_of Contient l’UUID des tâches dont cette tâche est une sous-tâche Lecture seule
subtasks Contient les UUID de toutes les sous-tâches de cette tâche Lecture seule

task-cancel

xe task-cancel [uuid=task_uuid]
<!--NeedCopy-->

Demandez à la tâche spécifiée d’annuler et de revenir.

Commandes de modèle

Commandes permettant de travailler avec des modèles de machines virtuelles.

Les modèles sont essentiellement des machines virtuelles dont le paramètre is-a-template est défini sur true. Un modèle est une « image de référence » qui contient tous les différents paramètres de configuration permettant d’instancier une machine virtuelle spécifique. Citrix Hypervisor est livré avec un ensemble de modèles de base, qui sont des machines virtuelles « brutes » génériques pouvant démarrer un CD d’installation du fournisseur du système d’exploitation (par exemple : RHEL, CentOS, SLES, Windows). Vous pouvez créer des machines virtuelles, les configurer sous forme standard pour vos besoins particuliers et en enregistrer une copie en tant que modèles pour une utilisation future dans le déploiement de machines virtuelles.

Les objets modèles peuvent être répertoriés avec la commande de liste d’objets standard (xe template-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Remarque :

Les modèles ne peuvent pas être convertis directement en machines virtuelles en définissant le paramètre is-a-template sur false. La définition du paramètre is-a-template sur false n’est pas prise en charge et entraîne une machine virtuelle qui ne peut pas être démarrée.

Paramètres du modèle de VM

Les modèles possèdent les paramètres suivants :

  • uuid (lecture seule) l’identificateur unique/la référence de l’objet pour le modèle
  • name-label (lecture/écriture) le nom du modèle
  • name-description (lecture/écriture) la chaîne de description du modèle
  • user-version (lecture/écriture) pour les créateurs de machines virtuelles et de modèles pour y placer les informations de version
  • is-a-template (lecture/écriture) True si cette machine virtuelle est un modèle. Les machines virtuelles modèles ne peuvent jamais être démarrées, elles ne sont utilisées que pour cloner d’autres machines virtuelles. Une fois que cette valeur a été définie sur true, elle ne peut pas être réinitialisée sur false. Les machines virtuelles de modèle ne peuvent pas être converties en machines virtuelles à l’aide de ce paramètre.
  • is-control-domain (lecture seule) true s’il s’agit d’un domaine de contrôle (domaine 0 ou domaine pilote)
  • power-state (lecture seule) état d’alimentation actuel. La valeur est toujours arrêtée pour un modèle
  • memory-dynamic-max (lecture seule) mémoire maximale dynamique en octets. Actuellement inutilisé, mais en cas de modification, la contrainte suivante doit être respectée : memory_static_max >= memory_dynamic_max >= memory_dynamic_min >= memory_static_min.
  • memory-dynamic-min (lecture/écriture) mémoire minimale dynamique en octets. Actuellement inutilisé, mais en cas de modification, les mêmes contraintes memory-dynamic-max doivent être respectées.
  • memory-static-max (lecture/écriture) définit de manière statique (absolue) la mémoire maximale en octets. Ce champ est la principale valeur utilisée pour déterminer la quantité de mémoire attribuée à une machine virtuelle.
  • memory-static-min (lecture/écriture) fixe statiquement la mémoire minimale (absolue) en octets. Ce champ représente la mémoire minimale absolue et memory-static-min doit être inférieur à memory-static-max. Cette valeur n’est pas utilisée en fonctionnement normal, mais la contrainte précédente doit être respectée.
  • suspend-VDI-uuid (lecture seule) le VDI sur lequel une image suspendue est stockée (n’a aucune signification pour un modèle)
  • VCPUs-params (paramètre de mappage en lecture/écriture) pour la stratégie vCPU sélectionnée.

    Vous pouvez régler l’épinglage d’un processeur virtuel avec :

     xe template-param-set uuid=<template_uuid> vCPUs-params:mask=1,2,3
     <!--NeedCopy-->
    

    Une machine virtuelle créée à partir de ce modèle s’exécute uniquement sur les processeurs physiques 1, 2 et 3.

    Vous pouvez également régler la priorité du processeur virtuel (planification xen) avec les paramètres de plafond et de poids. Par exemple :

     xe template-param-set uuid=<template_uuid> VCPUs-params:weight=512 xe template-param-set uuid=<template_uuid> VCPUs-params:cap=100
     <!--NeedCopy-->
    

    Une machine virtuelle basée sur ce modèle avec un poids de 512 reçoit deux fois plus de CPU qu’un domaine avec un poids de 256 sur un hôte en conflit. Les poids légaux vont de 1 à 65535 et la valeur par défaut est 256.

    Le plafond fixe éventuellement la quantité maximale d’UC qu’une machine virtuelle basée sur ce modèle peut consommer, même si le serveur Citrix Hypervisor a des cycles d’UC inactifs. Le plafond est exprimé en pourcentage d’un processeur physique : 100 correspond à 1 processeur physique, 50 à la moitié d’un processeur, 400 à 4 processeurs, etc. La valeur par défaut, 0, signifie qu’il n’y a pas de plafond supérieur.

  • VCPUs-max (lecture/écriture) nombre maximal de processeurs virtuels
  • VCPUs-at-startup numéro de démarrage (lecture/écriture) des vCPU
  • actions-after-crash (lecture/écriture) à effectuer lorsqu’une machine virtuelle basée sur ce modèle plante
  • console-uuids (paramètre défini en lecture seule) consoles virtuelles
  • platform (paramètre de carte en lecture/écriture) configuration spécifique à la plate-forme

    Pour désactiver l’émulation d’un port parallèle pour les invités HVM (par exemple, les invités Windows) :

     xe vm-param-set uuid=<vm_uuid> platform:parallel=none
     <!--NeedCopy-->
    

    Pour désactiver l’émulation d’un port série pour les invités HVM :

     xe vm-param-set uuid=<vm_uuid> platform:hvm_serial=none
     <!--NeedCopy-->
    

    Pour désactiver l’émulation d’un contrôleur USB et d’une tablette USB pour les invités HVM :

     xe vm-param-set uuid=<vm_uuid> platform:usb=false
     xe vm-param-set uuid=<vm_uuid> platform:usb_tablet=false
     <!--NeedCopy-->
    
  • allowed-operations (paramètre de jeu en lecture seule) liste des opérations autorisées dans cet état
  • current-operations (paramètre de jeu en lecture seule) liste des opérations en cours sur ce modèle
  • allowed-VBD-devices (paramètre de jeu en lecture seule) liste des identifiants VBD disponibles pour utilisation, représentés par des entiers compris entre 0 et 15. Cette liste n’est fournie qu’à titre informatif et d’autres appareils peuvent être utilisés (mais peuvent ne pas fonctionner).
  • allowed-VIF-devices (paramètre de jeu en lecture seule) liste des identifiants VIF disponibles pour utilisation, représentés par des entiers compris entre 0 et 15. Cette liste n’est fournie qu’à titre informatif et d’autres appareils peuvent être utilisés (mais peuvent ne pas fonctionner).
  • HVM-boot-policy (lecture/écriture) la stratégie de démarrage pour les invités HVM. Ordre du BIOS ou chaîne vide.
  • HVM-boot-params (paramètre de mappage en lecture/écriture) la clé d’ordre contrôle l’ordre de démarrage de l’invité HVM, représenté sous la forme d’une chaîne où chaque caractère est une méthode de démarrage : d pour le CD/DVD, c pour le disque racine et n pour le démarrage PXE réseau. La valeur par défaut est dc.
  • PV-kernel (lecture/écriture) chemin vers le noyau
  • PV-ramdisk chemin d’accès (lecture/écriture) vers le initrd
  • PV-args (lecture/écriture) chaîne d’arguments de ligne de commande du noyau
  • PV-legacy-args (lecture/écriture) chaîne d’arguments pour que les machines virtuelles héritées basées sur ce modèle démarrent
  • PV-bootloader (lecture/écriture) nom ou chemin d’accès au chargeur de démarrage
  • PV-bootloader-args (lecture/écriture) chaîne de divers arguments pour le chargeur de démarrage
  • last-boot-CPU-flags (lecture seule) décrit les indicateurs de CPU sur lesquels une machine virtuelle basée sur ce modèle a été démarrée pour la dernière fois ; non renseigné pour un modèle
  • resident-on (lecture seule) le serveur Citrix Hypervisor sur lequel réside une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • affinity (lecture/écriture) le serveur Citrix Hypervisor sur lequel une machine virtuelle basée sur ce modèle a la préférence pour s’exécuter. Utilisé par la commande xe vm-start pour décider où exécuter la machine virtuelle
  • other-config (paramètre de carte en lecture/écriture) liste des paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour le modèle
  • start-time Horodatage (lecture seule) de la date et de l’heure auxquelles les métriques d’une machine virtuelle basée sur ce modèle ont été lues, sous la forme yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire à une seule lettre, par exemple, Z pour UTC (GMT). Définir sur 1 Jan 1970 Z (début de l’époque UNIX/POSIX) pour un modèle
  • install-time Horodatage (lecture seule) de la date et de l’heure auxquelles les métriques d’une machine virtuelle basée sur ce modèle ont été lues, sous la forme yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire à une seule lettre, par exemple, Z pour UTC (GMT). Définir sur 1 Jan 1970 Z (début de l’époque UNIX/POSIX) pour un modèle
  • memory-actual (lecture seule) la mémoire réelle utilisée par une machine virtuelle basée sur ce modèle ; 0 pour un modèle
  • VCPUs-number ( lecture seule) le nombre de processeurs virtuels affectés à une machine virtuelle basée sur ce modèle ; 0 pour un modèle
  • VCPUs-Utilization (paramètre de carte en lecture seule) liste des processeurs virtuels et leur poids paramètre de mappage en lecture seule os-version la version du système d’exploitation d’une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • PV-drivers-version (paramètre de carte en lecture seule) les versions des pilotes paravirtualisés pour une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • PV-drivers-detected (lecture seule) pour la dernière version des pilotes paravirtualisés pour une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • memory (paramètre de carte en lecture seule) des métriques de mémoire signalées par l’agent sur une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • disks (paramètre de carte en lecture seule) des métriques de disque signalées par l’agent sur une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • networks (paramètre de carte en lecture seule) des métriques réseau signalées par l’agent sur une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • other (paramètre de carte en lecture seule) d’autres métriques signalées par l’agent sur une machine virtuelle basée sur ce modèle. Apparaît comme not in database pour un modèle
  • guest-metrics-last-updated (lecture seule) horodatage lorsque l’agent invité a effectué la dernière écriture dans ces champs. Dans le formulaire yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire d’une seule lettre, par exemple, Z pour UTC (GMT)
  • actions-after-shutdown (lecture/écriture) à effectuer après l’arrêt de la machine virtuelle
  • actions-after-reboot (lecture/écriture) action à effectuer après le redémarrage de la machine virtuelle
  • possible-hosts (lecture seule) liste des hôtes pouvant potentiellement héberger la machine virtuelle
  • HVM-shadow-multiplier multiplicateur (lecture/écriture) appliqué à la quantité d’ombre mise à la disposition de l’invité
  • dom-id (lecture seule) ID de domaine (si disponible, -1 sinon)
  • recommendations (lecture seule) Spécification XML des valeurs et plages recommandées pour les propriétés de cette machine virtuelle
  • xenstore-data (paramètre de carte en lecture/écriture) à insérer dans l’ xenstore arborescence (/local/domain/*domid*/vmdata) après la création de la machine virtuelle.
  • is-a-snapshot (lecture seule) True si ce modèle est un instantané de machine virtuelle
  • snapshot_of (lecture seule) l’UUID de la machine virtuelle dont ce modèle est un instantané
  • snapshots (lecture seule) les UUID de tous les instantanés qui ont été pris de ce modèle
  • snapshot_time (lecture seule) l’horodatage du dernier instantané de machine virtuelle pris
  • memory-target (lecture seule) la quantité cible de mémoire définie pour ce modèle
  • blocked-operations (paramètre de mappage en lecture/écriture) répertorie les opérations qui ne peuvent pas être effectuées sur ce modèle
  • last-boot-record (lecture seule) enregistrement des derniers paramètres de démarrage de ce modèle, au format XML
  • ha-always-run (lecture/écriture) True si une instance de ce modèle est toujours redémarrée sur un autre hôte en cas de défaillance de l’hôte sur lequel elle réside. Ce paramètre est désormais obsolète. Utilisez plutôt le paramètre ha-restartpriority.
  • ha-restart-priority (lecture seule) redémarrage ou stockage de données binaires blobs en lecture/écriture au mieux
  • live (lecture seule) s’applique uniquement à une machine virtuelle en cours d’exécution.

template-export

xe template-export template-uuid=uuid_of_existing_template filename=filename_for_new_template
<!--NeedCopy-->

Exporte une copie d’un modèle spécifié vers un fichier portant le nouveau nom de fichier spécifié.

template-uninstall

xe template-uninstall template-uuid=template_uuid [--force]
<!--NeedCopy-->

Désinstallez un modèle personnalisé. Cette opération détruira les VDI marqués comme « possédés » par ce modèle.

Commandes de mise à jour

La section suivante contient les commandes de mise à jour du serveur Citrix Hypervisor.

Les objets de mise à jour peuvent être répertoriés avec la commande de listage d’objets standard (xe update-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres de mise à jour

Les mises à jour du serveur Citrix Hypervisor ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour la mise à jour Lecture seule
host La liste des hôtes auxquels cette mise à jour est appliquée Lecture seule
host-uuid L’identifiant unique pour le serveur Citrix Hypervisor à interroger Lecture seule
name-label Le nom de la mise à jour Lecture seule
name-description La chaîne de description de la mise à jour Lecture seule
applied Si la mise à jour a été appliquée ou non ; vrai ou faux Lecture seule
installation-size La taille de la mise à jour en octets Lecture seule
after-apply-guidance Indique si la pile d’outils XAPI ou l’hôte nécessite un redémarrage Lecture seule
version La version de la mise à jour Lecture seule

update-upload

xe update-upload file-name=update_filename
<!--NeedCopy-->

Téléchargez un fichier de mise à jour spécifié sur le serveur Citrix Hypervisor. Cette commande prépare une mise à jour à appliquer. En cas de succès, l’UUID de la mise à jour téléchargée est imprimé. Si la mise à jour a déjà été téléchargée,UPDATE_ALREADY_EXISTS une erreur est renvoyée à la place et le correctif n’est plus téléchargé.

update-precheck

xe update-precheck uuid=update_uuid host-uuid=host_uuid
<!--NeedCopy-->

Exécutez les prévérifications contenues dans la mise à jour spécifiée sur le serveur Citrix Hypervisor spécifié.

update-destroy

xe update-destroy uuid=update_file_uuid
<!--NeedCopy-->

Supprime un fichier de mise à jour qui n’a pas été appliqué du pool. Peut être utilisé pour supprimer un fichier de mise à jour qui ne peut pas être appliqué aux hôtes.

update-apply

xe update-apply host-uuid=host_uuid uuid=update_file_uuid
<!--NeedCopy-->

Appliquez le fichier de mise à jour spécifié.

update-pool-apply

xe update-pool-apply uuid=update_uuid
<!--NeedCopy-->

Appliquez la mise à jour spécifiée à tous les serveurs Citrix Hypervisor du pool.

update-introduce

xe update-introduce vdi-uuid=vdi_uuid
<!--NeedCopy-->

Introduire la mise à jour VDI.

update-pool-clean

xe update-pool-clean uuid=uuid
<!--NeedCopy-->

Supprime les fichiers de la mise à jour de tous les hôtes du pool.

Commandes utilisateur

user-password-change

xe user-password-change old=old_password new=new_password
<!--NeedCopy-->

Modifie le mot de passe de l’utilisateur connecté. L’ancien champ de mot de passe n’est pas vérifié car vous devez disposer des privilèges de superviseur pour utiliser cette commande.

Commandes VBD

Commandes pour travailler avec des VBD (Virtual Block Devices).

Un VBD est un objet logiciel qui connecte une machine virtuelle au VDI, qui représente le contenu du disque virtuel. Le VBD possède les attributs qui lient le VDI à la machine virtuelle (est-il amorçable, ses métriques de lecture/écriture, etc.). Le VDI contient les informations sur les attributs physiques du disque virtuel (quel type de SR, si le disque est partageable, si le support est en lecture/écriture ou en lecture seule, etc.).

Les objets VBD peuvent être répertoriés avec la commande de listage d’objets standard (xe vbd-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres VBD

Les VBD ont les paramètres suivants :

Nom du paramètre Description Type
uuid L’identificateur/référence d’objet unique pour le VBD Lecture seule
vm-uuid Identifiant unique/référence d’objet pour la machine virtuelle à laquelle ce VBD est attaché Lecture seule
vm-name-label Le nom de la machine virtuelle à laquelle ce VBD est attaché Lecture seule
vdi-uuid Identifiant unique/référence d’objet pour le VDI auquel ce VBD est mappé Lecture seule
vdi-name-label Le nom du VDI auquel ce VBD est mappé Lecture seule
empty Si true, ce VBD représente un lecteur vide Lecture seule
device L’appareil vu par l’invité, par exemple hda Lecture seule
userdevice Numéro d’appareil spécifié par le paramètre de périphérique pendant vbd-create, par exemple hda, 0 pour hdb, 1 pour, etc. Lecture/Écriture
bootable Vrai si ce VBD est amorçable Lecture/Écriture
mode Le mode avec lequel le VBD doit être monté Lecture/Écriture
type Comment le VBD apparaît sur la machine virtuelle, par exemple un disque ou un CD Lecture/Écriture
currently-attached True si le VBD est connecté à cet hôte, false sinon Lecture seule
storage-lock Vrai si un verrou de niveau de stockage a été acquis Lecture seule
status-code Code d’erreur/réussite associé à la dernière opération d’attachement Lecture seule
status-detail Informations d’erreur/succès associées au dernier statut de l’opération de rattachement Lecture seule
qos_algorithm_type L’algorithme QoS à utiliser Lecture/Écriture
qos_algorithm_params Paramètres de l’algorithme QoS choisi Paramètre de mappage en lecture/écriture
qos_supported_algorithms Algorithmes QoS pris en charge pour ce VBD Paramètre en lecture seule
io_read_kbs Taux de lecture moyen en Ko par seconde pour ce VBD Lecture seule
io_write_kbs Taux d’écriture moyen en Ko par seconde pour ce VBD Lecture seule
allowed-operations Liste des opérations autorisées dans cet état. Cette liste est uniquement consultative et l’état du serveur peut avoir changé au moment où ce champ est lu par un client. Paramètre en lecture seule
current-operations Lie chacune des tâches en cours d’exécution utilisant cet objet (par référence) à une énumération current_operation qui décrit la nature de la tâche. Paramètre en lecture seule
unpluggable Vrai si ce VBD prend en charge le débranchement à chaud Lecture/Écriture
attachable Vrai si l’appareil peut être connecté Lecture seule
other-config Configuration supplémentaire Paramètre de mappage en lecture/écriture

vbd-create

xe vbd-create vm-uuid=uuid_of_the_vm device=device_value vdi-uuid=uuid_of_vdi_to_connect_to [bootable=true] [type=Disk|CD] [mode=RW|RO]
<!--NeedCopy-->

Créez un VBD sur une machine virtuelle.

Les valeurs autorisées pour le device champ sont des entiers compris entre 0 et 15, et le nombre doit être unique pour chaque machine virtuelle. Les valeurs autorisées actuelles peuvent être vues dans le paramètre allowed-VBD-devices sur la machine virtuelle spécifiée. Ceci est considéré comme userdevice dans les paramètres vbd.

Si type c’est le cas Disk, vdi-uuid est obligatoire. Le mode peut être RO ou RW pour un disque.

Si l’option type est CD, vdi-uuid est facultative. Si aucun VDI n’est spécifié, un VBD vide est créé pour le CD. Le mode doit être RO pour un CD.

vbd-destroy

xe vbd-destroy uuid=uuid_of_vbd
<!--NeedCopy-->

Détruisez le VBD spécifié.

Si le paramètre VBD other-config:owner est défini sur true, le VDI associé est également détruit.

vbd-eject

xe vbd-eject uuid=uuid_of_vbd
<!--NeedCopy-->

Retirez le support du lecteur représenté par un VBD. Cette commande ne fonctionne que si le support est de type amovible (CD physique ou ISO). Sinon, un message d’erreur VBD_NOT_REMOVABLE_MEDIA est renvoyé.

vbd-insert

xe vbd-insert uuid=uuid_of_vbd vdi-uuid=uuid_of_vdi_containing_media
<!--NeedCopy-->

Insérez un nouveau support dans le lecteur représenté par un VBD. Cette commande ne fonctionne que si le support est de type amovible (CD physique ou ISO). Sinon, un message d’erreur VBD_NOT_REMOVABLE_MEDIA est renvoyé.

vbd-plug

xe vbd-plug uuid=uuid_of_vbd
<!--NeedCopy-->

Essayez de connecter le VBD alors que la machine virtuelle est en cours d’exécution.

vbd-unplug

xe vbd-unplug uuid=uuid_of_vbd
<!--NeedCopy-->

Tente de détacher le VBD de la machine virtuelle alors qu’elle est en cours d’exécution.

Commandes VDI

Commandes permettant de travailler avec des VDI (Virtual Disk Images).

Un VDI est un objet logiciel qui représente le contenu du disque virtuel vu par une machine virtuelle. C’est différent du VBD, qui est un objet qui lie une machine virtuelle au VDI. Le VDI contient les informations sur les attributs physiques du disque virtuel (quel type de SR, si le disque est partageable, si le support est en lecture/écriture ou en lecture seule, etc.). Le VBD possède les attributs qui lient le VDI à la machine virtuelle (est-il amorçable, ses métriques de lecture/écriture, etc.).

Les objets VDI peuvent être répertoriés avec la commande de listage d’objets standard (xe vdi-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres VDI

Les VDI ont les paramètres suivants :

Nom du paramètre Description Type
uuid Identifiant unique/référence d’objet pour le VDI Lecture seule
name-label Le nom du VDI Lecture/Écriture
name-description La chaîne de description du VDI Lecture/Écriture
allowed-operations Une liste des opérations autorisées dans cet état Paramètre en lecture seule
current-operations Une liste des opérations en cours sur ce VDI Paramètre en lecture seule
sr-uuid SR dans laquelle réside le VDI Lecture seule
vbd-uuids Une liste des VBD qui font référence à ce VDI Paramètre en lecture seule
crashdump-uuids Liste des vidages sur incident qui font référence à ce VDI Paramètre en lecture seule
virtual-size Taille du disque telle qu’elle est présentée à la machine virtuelle, en octets. Selon le type de back-end de stockage, la taille peut ne pas être respectée exactement Lecture seule
physical-utilisation Quantité d’espace physique occupée par le VDI sur le SR, en octets Lecture seule
type Type de VDI, par exemple, système ou utilisateur Lecture seule
sharable Vrai si ce VDI peut être partagé Lecture seule
read-only Vrai si ce VDI ne peut être monté qu’en lecture seule Lecture seule
storage-lock Vrai si ce VDI est verrouillé au niveau du stockage Lecture seule
parent Fait référence au VDI parent lorsque ce VDI fait partie d’une chaîne Lecture seule
missing True si l’opération d’analyse SR a signalé que ce VDI n’était pas présent Lecture seule
other-config Informations de configuration supplémentaires pour ce VDI Paramètre de mappage en lecture/écriture
sr-name-label Nom du référentiel de stockage contenant Lecture seule
location Informations sur l’emplacement Lecture seule
managed Vrai si le VDI est géré Lecture seule
xenstore-data Données à insérer dans l’arborescence xenstore (/local/domain/0/backend/ vbd/domid/device-id/smdata) une fois le VDI connecté. Les dorsaux SM définissent généralement ce champ sur vdi_attach. Paramètre de mappage en lecture seule
sm-config Données dépendantes du SM Paramètre de mappage en lecture seule
is-a-snapshot True si ce VDI est un snapshot de stockage de machine virtuelle Lecture seule
snapshot_of L’UUID du stockage dont ce VDI est un instantané Lecture seule
snapshots Les UUID de tous les instantanés de ce VDI Lecture seule
snapshot_time Horodatage de l’opération de snapshot qui a créé ce VDI Lecture seule
metadata-of-pool L’UUID du pool qui a créé ce VDI de métadonnées Lecture seule
metadata-latest Indicateur indiquant si le VDI contient les dernières métadonnées connues pour ce pool Lecture seule
cbt-enabled Indicateur indiquant si le suivi des blocs modifiés est activé pour le VDI Lecture/Écriture

vdi-clone

xe vdi-clone uuid=uuid_of_the_vdi [driver-params:key=value]
<!--NeedCopy-->

Créez une nouvelle copie inscriptible du VDI spécifié qui peut être utilisée directement. Il s’agit d’une variante vdi-copy qui peut exposer les installations de clonage d’images à grande vitesse là où elles existent.

Utilisez le paramètre optionnel driver-params map pour transmettre des informations de configuration supplémentaires spécifiques au fournisseur au pilote de stockage principal sur lequel repose le VDI. Pour plus d’informations, consultez la documentation du pilote du fournisseur de stockage.

vdi-copy

xe vdi-copy uuid=uuid_of_the_vdi sr-uuid=uuid_of_the_destination_sr
<!--NeedCopy-->

Copiez un VDI vers un SR spécifié.

vdi-create

xe vdi-create sr-uuid=uuid_of_sr_to_create_vdi_on name-label=name_for_the_vdi type=system|user|suspend|crashdump virtual-size=size_of_virtual_disk sm-config-*=storage_specific_configuration_data
<!--NeedCopy-->

Créez un VDI.

Le virtual-size paramètre peut être spécifié en octets ou en utilisant les suffixes standard IEC KiB, MiB, GiB et TiB.

Remarque :

Les types SR qui prennent en charge le provisionnement dynamique des disques (tels que le disque dur virtuel local et le NFS) n’imposent pas l’allocation virtuelle des disques. Faites attention lorsque vous allouez trop d’espace disque virtuel sur un SR. Si un SR surchargé devient complet, l’espace disque doit être disponible soit sur le substrat cible SR, soit en supprimant les VDI inutilisés dans le SR.

Certains types de SR peuvent arrondir la virtual-size valeur pour la rendre divisible selon une taille de bloc configurée.

vdi-data-destroy

xe vdi-data-destroy uuid=uuid_of_vdi
<!--NeedCopy-->

Détruisez les données associées au VDI spécifié, mais conservez les métadonnées de suivi des blocs modifiées.

Remarque :

Si vous utilisez le suivi des blocs modifiés pour effectuer des sauvegardes incrémentielles du VDI, veillez à utiliser la commande vdi-data-destroy pour supprimer les snapshots tout en conservant les métadonnées. Ne pas utiliser vdi-destroy sur des instantanés de VDI pour lesquels le suivi des blocs modifiés est activé.

vdi-destroy

xe vdi-destroy uuid=uuid_of_vdi
<!--NeedCopy-->

Détruisez le VDI spécifié.

Remarque :

Si vous utilisez le suivi des blocs modifiés pour effectuer des sauvegardes incrémentielles du VDI, veillez à utiliser la commande vdi-data-destroy pour supprimer les snapshots tout en conservant les métadonnées . Ne pas utiliser vdi-destroy sur des instantanés de VDI pour lesquels le suivi des blocs modifiés est activé.

Pour les types Local VHD et NFS SR, l’espace disque n’est pas libéré immédiatement vdi-destroy, mais périodiquement lors d’une opération d’analyse du référentiel de stockage. Si vous devez forcer la mise à disposition de l’espace disque supprimé, appelez [sr-scan] (#sr -scan) manuellement.

vdi-disable-cbt

xe vdi-disable-cbt uuid=uuid_of_vdi
<!--NeedCopy-->

Désactive le suivi des blocs modifiés pour le VDI.

vdi-enable-cbt

xe vdi-enable-cbt uuid=uuid_of_vdi
<!--NeedCopy-->

Activez le suivi des blocs modifiés pour le VDI.

Remarque :

Vous pouvez activer le suivi des blocs modifiés uniquement sur les instances sous licence de Citrix Hypervisor Premium Edition.

vdi-export

xe vdi-export uuid=uuid_of_vdi filename=filename_to_export_to [format=format] [base=uuid_of_base_vdi] [--progress]
<!--NeedCopy-->

Exportez un VDI vers le nom de fichier spécifié. Vous pouvez exporter un VDI dans l’un des formats suivants :

  • raw
  • vhd

Le format VHD peut être clairsemé. S’il y a des blocs non alloués dans le VDI, ces blocs peuvent être omis du fichier VHD, ce qui rend le fichier VHD plus petit. Vous pouvez exporter au format VHD à partir de tous les types de stockage VHD pris en charge (EXT3/EXT4, NFS).

Si vous spécifiez le paramètre base, cette commande exporte uniquement les blocs qui ont changé entre le VDI exporté et le VDI de base.

vdi-forget

xe vdi-forget uuid=uuid_of_vdi
<!--NeedCopy-->

Supprime de manière inconditionnelle un enregistrement VDI de la base de données sans toucher au back-end de stockage. En fonctionnement normal, vous devriez utiliser [vdi-destroy] (#vdi -destroy) à la place.

vdi-import

xe vdi-import uuid=uuid_of_vdi filename=filename_to_import_from [format=format] [--progress]
<!--NeedCopy-->

Importer un VDI. Vous pouvez importer un VDI à partir de l’un des formats suivants :

  • raw
  • vhd

vdi-introduce

xe vdi-introduce uuid=uuid_of_vdi sr-uuid=uuid_of_sr name-label=name_of_new_vdi type=system|user|suspend|crashdump location=device_location_(varies_by_storage_type) [name-description=description_of_vdi] [sharable=yes|no] [read-only=yes|no] [other-config=map_to_store_misc_user_specific_data] [xenstore-data=map_to_of_additional_xenstore_keys] [sm-config=storage_specific_configuration_data]
<!--NeedCopy-->

Créez un objet VDI représentant un périphérique de stockage existant, sans réellement modifier ni créer de stockage. Cette commande est principalement utilisée en interne pour introduire automatiquement des périphériques de stockage connectés à chaud.

vdi-list-changed-blocks

xe vdi-list-changed-blocks vdi-from-uuid=first-vdi-uuid vdi-to-uuid=second-vdi-uuid
<!--NeedCopy-->

Comparez deux VDI et renvoyez la liste des blocs qui ont changé entre les deux sous forme de chaîne codée en base64. Cette commande ne fonctionne que pour les VDI dont le suivi des blocs modifiés est activé.

Pour plus d’informations, voir Suivi des blocs modifiés.

vdi-pool-migrate

xe vdi-pool-migrate uuid=VDI_uuid sr-uuid=destination-sr-uuid
<!--NeedCopy-->

Migrez un VDI vers un SR spécifié, tandis que le VDI est attaché à un invité en cours d’exécution. (Migration en direct du stockage)

Pour plus d’informations, voir Migration des machines virtuelles.

vdi-resize

xe vdi-resize uuid=vdi_uuid disk-size=new_size_for_disk
<!--NeedCopy-->

Modifiez la taille du VDI spécifié par UUID.

vdi-snapshot

xe vdi-snapshot uuid=uuid_of_the_vdi [driver-params=params]
<!--NeedCopy-->

Produit une version en lecture-écriture d’un VDI qui peut être utilisée comme référence à des fins de sauvegarde ou de création de modèles, ou les deux. Utilisez l’instantané pour effectuer une sauvegarde plutôt que d’installer et d’exécuter un logiciel de sauvegarde à l’intérieur de la machine virtuelle. La machine virtuelle continue d’être exécutée pendant que le logiciel de sauvegarde externe diffuse le contenu de l’instantané vers le support de sauvegarde. De même, un instantané peut être utilisé comme « image dorée » sur laquelle baser un modèle. Un modèle peut être créé à l’aide de n’importe quel VDI.

Utilisez le paramètre optionnel driver-params map pour transmettre des informations de configuration supplémentaires spécifiques au fournisseur au pilote de stockage principal sur lequel repose le VDI. Pour plus d’informations, consultez la documentation du pilote du fournisseur de stockage.

Un clone d’un snapshot doit toujours produire un VDI inscriptible.

vdi-unlock

xe vdi-unlock uuid=uuid_of_vdi_to_unlock [force=true]
<!--NeedCopy-->

Tente de déverrouiller les VDI spécifiés. Si force=true est transmis à la commande, elle force l’opération de déverrouillage.

vdi-update

xe vdi-update uuid=uuid
<!--NeedCopy-->

Actualisez les champs de l’objet VDI dans la base de données.

Commandes VIF

Commandes pour travailler avec des VIF (Virtual Network Interfaces).

Les objets VIF peuvent être répertoriés avec la commande de listage d’objets standard (xe vif-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres VIF

Les VIF ont les paramètres suivants :

  • uuid (lecture seule) l’identificateur unique/la référence de l’objet pour le VIF
  • vm-uuid (lecture seule) l’identificateur/référence d’objet unique pour la machine virtuelle sur laquelle réside ce VIF
  • vm-name-label (lecture seule) le nom de la machine virtuelle sur laquelle réside ce VIF
  • allowed-operations (paramètre de jeu en lecture seule) une liste des opérations autorisées dans cet état
  • current-operations (paramètre de jeu en lecture seule) une liste des opérations actuellement en cours sur ce VIF
  • device (lecture seule) étiquette entière de ce VIF, indiquant l’ordre dans lequel les back-ends VIF ont été créés
  • MAC (lecture seule) adresse MAC du VIF, telle qu’elle est exposée à la machine virtuelle
  • MTU (lecture seule) Unité de transmission maximale du VIF en octets.

    Ce paramètre est en lecture seule, mais vous pouvez remplacer le paramètre MTU par la mtu clé à l’aide du paramètre other-config map. Par exemple, pour réinitialiser la MTU sur une carte réseau virtuelle afin d’utiliser des trames jumbo :

     xe vif-param-set \
         uuid=<vif_uuid> \
         other-config:mtu=9000
     <!--NeedCopy-->
    
  • currently-attached (lecture seule) Vrai si le périphérique est connecté
  • qos_algorithm_type algorithme QoS (lecture/écriture) à utiliser
  • qos_algorithm_params (paramètre de carte en lecture/écriture) pour l’algorithme QoS choisi
  • qos_supported_algorithms (paramètre de jeu en lecture seule) algorithmes QoS pris en charge pour ce VIF
  • MAC-autogenerated (lecture seule) True si l’adresse MAC du VIF a été générée automatiquement
  • other-config (paramètre de mappage lecture/écriture) paires de configuration key:value supplémentaires
  • other-config:ethtoolrx (lecture/écriture) défini sur on pour activer la somme de contrôle de réception, off pour désactiver
  • other-config:ethtooltx (lecture/écriture) défini sur on pour activer la somme de contrôle de transmission, sur off pour désactiver
  • other-config:ethtoolsg (lecture/écriture) réglé sur on pour activer la collecte de dispersion, sur off pour désactiver
  • other-config:ethtooltso (lecture/écriture) défini sur On pour activer le déchargement de la segmentation TCP, désactivé pour désactiver
  • other-config:ethtoolufo (lecture/écriture) défini sur On pour activer le déchargement de fragments UDP, désactivé pour désactiver
  • other-config:ethtoolgso (lecture/écriture) défini sur on pour activer le déchargement de la segmentation générique, sur off pour désactiver
  • other-config:promiscuous (lecture/écriture) fidèle à un VIF pour être promiscuité sur le pont, de sorte qu’il voit tout le trafic sur le pont. Utile pour exécuter un système de détection d’intrusion (IDS) ou similaire dans une machine virtuelle.
  • network-uuid (lecture seule) l’identificateur/référence d’objet unique du réseau virtuel auquel ce VIF est connecté
  • network-name-label (lecture seule) le nom descriptif du réseau virtuel auquel ce VIF est connecté
  • io_read_kbs (lecture seule) taux de lecture moyen en Ko/s pour ce VIF
  • io_write_kbs (lecture seule) taux d’écriture moyen en Ko/s pour ce VIF
  • locking_mode (lecture/écriture) Affecte la capacité des VIF à filtrer le trafic vers/depuis une liste d’adresses MAC et IP. Nécessite des paramètres supplémentaires.
  • locking_mode:default (lecture/écriture) Varie selon le mode de verrouillage par défaut du réseau VIF.

    Si le mode de verrouillage par défaut est défini sur disabled, Citrix Hypervisor applique une règle de filtrage afin que le VIF ne puisse ni envoyer ni recevoir de trafic. Si le mode de verrouillage par défaut est défini sur unlocked, Citrix Hypervisor supprime toutes les règles de filtrage associées au VIF. Pour plus d’informations, voir Commandes réseau.

  • locking_mode:locked (lecture/écriture) Seul le trafic envoyé vers ou envoyé à partir des adresses MAC et IP spécifiées est autorisé sur le VIF. Si aucune adresse IP n’est spécifiée, aucun trafic n’est autorisé.
  • locking_mode:unlocked (lecture/écriture) Aucun filtre n’est appliqué au trafic entrant ou sortant du VIF.
  • locking_mode:disabled (lecture/écriture) Citrix Hypervisor applique une règle de filtrage afin que le VIF supprime tout le trafic.

vif-create

xe vif-create vm-uuid=uuid_of_the_vm device=see below network-uuid=uuid_of_network_to_connect_to [mac=mac_address]
<!--NeedCopy-->

Créez un VIF sur une machine virtuelle.

Les valeurs appropriées pour le champ device sont répertoriées dans le paramètre allowed-VIF-devices sur la machine virtuelle spécifiée. Avant que des VIF n’existent, les valeurs autorisées sont des entiers compris entre 0 et 15.

Le paramètre mac est l’adresse MAC standard dans le formulaire aa:bb:cc:dd:ee:ff. Si vous ne le spécifiez pas, une adresse MAC aléatoire appropriée est créée. Vous pouvez également définir explicitement une adresse MAC aléatoire en spécifiant mac=random.

vif-destroy

xe vif-destroy uuid=uuid_of_vif
<!--NeedCopy-->

Détruisez un VIF.

vif-move

xe vif-move uuid=uuid network-uuid=network_uuid
<!--NeedCopy-->

Déplacez le VIF vers un autre réseau.

vif-plug

xe vif-plug uuid=uuid_of_vif
<!--NeedCopy-->

Essayez de joindre le VIF alors que la machine virtuelle est en cours d’exécution.

vif-unplug

xe vif-unplug uuid=uuid_of_vif
<!--NeedCopy-->

Tente de détacher le VIF de la machine virtuelle pendant son exécution.

vif-configure-ipv4

Configurez les paramètres IPv4 pour cette interface virtuelle. Définissez les paramètres IPv4 comme ci-dessous :

xe vif-configure-ipv4 uuid=uuid_of_vif mode=static address=CIDR_address gateway=gateway_address
<!--NeedCopy-->

Par exemple :

VIF.configure_ipv4(vifObject,"static", " 192.168.1.10/24", " 192.168.1.1")
<!--NeedCopy-->

Nettoyez les paramètres IPv4 comme ci-dessous :

xe vif-configure-ipv4 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

vif-configure-ipv6

Configurez les paramètres IPv6 pour cette interface virtuelle. Définissez les paramètres IPv6 comme ci-dessous :

xe vif-configure-ipv6 uuid=uuid_of_vif mode=static address=IP_address gateway=gateway_address
<!--NeedCopy-->

Par exemple :

VIF.configure_ipv6(vifObject,"static", "fd06:7768:b9e5:8b00::5001/64", "fd06:7768:b9e5:8b00::1")
<!--NeedCopy-->

Nettoyez les paramètres IPv6 comme ci-dessous :

xe vif-configure-ipv6 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

Commandes VLAN

Commandes pour travailler avec des VLAN (réseaux virtuels). Pour répertorier et modifier les interfaces virtuelles, reportez-vous aux commandes PIF, qui ont un paramètre VLAN pour signaler qu’elles ont un réseau virtuel associé. Pour plus d’informations, consultez la section Commandes PIF. Par exemple, pour répertorier les VLAN, utilisezxe pif-list.

vlan-create

xe vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
<!--NeedCopy-->

Créez un VLAN sur votre serveur Citrix Hypervisor.

pool-vlan-create

xe pool-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
<!--NeedCopy-->

Créez un VLAN sur tous les hôtes d’un pool, en déterminant l’interface (par exemple, eth0) sur laquelle se trouve le réseau spécifié (sur chaque hôte) et en créant et en connectant un nouvel objet PIF sur chaque hôte en conséquence.

vlan-destroy

xe vlan-destroy uuid=uuid_of_pif_mapped_to_vlan
<!--NeedCopy-->

Détruisez un VLAN. Nécessite l’UUID du PIF qui représente le VLAN.

Commandes VM

Commandes pour contrôler les machines virtuelles et leurs attributs.

Sélecteurs de machines virtuelles

Plusieurs des commandes répertoriées ici ont un mécanisme commun pour sélectionner une ou plusieurs machines virtuelles sur lesquelles effectuer l’opération. Le moyen le plus simple est de fournir l’argument vm=name_or_uuid. Un moyen simple d’obtenir l’UUID d’une machine virtuelle réelle consiste, par exemple, à exécuter xe vm-list power-state=running. (Récupère la liste complète des champs qui peuvent être mis en correspondance à l’aide de la commande xe vm-list params=all.) Par exemple, la spécification power-state=halted sélectionne des machines virtuelles dont le paramètre power-state est égal à halted. Lorsque plusieurs machines virtuelles correspondent, spécifiez l’option --multiple permettant d’effectuer l’opération. La liste complète des paramètres pouvant être mis en correspondance est décrite au début de cette section.

Les objets VM peuvent être répertoriés avec la commande de listage d’objets standard (xe vm-list) et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

Paramètres VM

Les machines virtuelles ont les paramètres suivants :

Remarque :

Toutes les valeurs des paramètres de VM inscriptibles peuvent être modifiées pendant que la machine virtuelle est en cours d’exécution, mais les nouveaux paramètres ne sont pas appliqués dynamiquement et ne peuvent pas être appliqués tant que la machine virtuelle n’est pas redémarrée.

  • appliance ( lecture/écriture) l’Appliance/vApp auquel appartient la VM
  • uuid (lecture seule) l’identificateur unique/la référence d’objet pour la machine virtuelle
  • name-label (lecture/écriture) le nom de la machine virtuelle
  • name-description (lecture/écriture) la chaîne de description de la machine virtuelle
  • order start order (lecture/écriture) pour le démarrage/l’arrêt de vApp et pour le démarrage après un basculement HA
  • version (lecture seule) le nombre de fois que cette machine virtuelle a été récupérée. Si vous souhaitez remplacer une nouvelle machine virtuelle par une ancienne version, appelez vm-recover
  • user-version (lecture/écriture) pour les créateurs de machines virtuelles et de modèles pour y placer les informations de version
  • is-a-template (lecture/écriture) False sauf si cette machine virtuelle est un modèle. Les machines virtuelles modèles ne peuvent jamais être démarrées, elles ne sont utilisées que pour cloner d’autres machines virtuelles. Une fois que cette valeur a été définie sur true, elle ne peut pas être réinitialisée sur false. Les machines virtuelles de modèle ne peuvent pas être converties en machines virtuelles à l’aide de ce paramètre.
  • is-control-domain (lecture seule) True s’il s’agit d’un domaine de contrôle (domaine 0 ou domaine pilote)
  • power-state (lecture seule) état d’alimentation actuel
  • start-delay (lecture/écriture) le délai d’attente avant qu’un appel de démarrage de la machine virtuelle ne revienne
  • shutdown-delay (lecture/écriture) le délai d’attente avant qu’un appel d’arrêt de la machine virtuelle ne revienne
  • memory-dynamic-max maximum dynamique (lecture/écriture) en octets
  • memory-dynamic-min Minimum dynamique (lecture/écriture) en octets
  • memory-static-max (lecture/écriture) défini statiquement (absolu) maximum en octets. Si vous souhaitez modifier cette valeur, la machine virtuelle doit être arrêtée.
  • memory-static-min (lecture/écriture) défini statiquement (absolu) minimum en octets. Si vous souhaitez modifier cette valeur, la machine virtuelle doit être arrêtée.
  • suspend-VDI-uuid (lecture seule) le VDI sur lequel une image suspendue est stockée
  • VCPUs-params (paramètre de mappage en lecture/écriture) pour la stratégie vCPU sélectionnée.

    Vous pouvez régler l’épinglage d’un vCPU avec

     xe vm-param-set uuid=<vm_uuid> VCPUs-params:mask=1,2,3
     <!--NeedCopy-->
    

    La machine virtuelle sélectionnée s’exécute ensuite uniquement sur les processeurs physiques 1, 2 et 3. Vous pouvez également régler la priorité du processeur virtuel (planification xen) avec les paramètres de plafond et de poids. Par exemple :

     xe vm-param-set uuid=<vm_uuid> VCPUs-params:weight=512 xe vm-param-set uuid=<vm_uuid> VCPUs-params:cap=100
     <!--NeedCopy-->
    

    Une machine virtuelle d’un poids de 512 reçoit deux fois plus de CPU qu’un domaine avec un poids de 256 sur un serveur Citrix Hypervisor en contention. Les poids légaux vont de 1 à 65535 et la valeur par défaut est 256. Le plafond fixe éventuellement la quantité maximale de CPU qu’une machine virtuelle pourra consommer, même si le serveur Citrix Hypervisor a des cycles CPU inactifs. Le plafond est exprimé en pourcentage d’un processeur physique : 100 correspond à 1 processeur physique, 50 à la moitié d’un processeur, 400 à 4 processeurs, etc. La valeur par défaut, 0, signifie qu’il n’y a pas de plafond supérieur.

  • VCPUs-max (lecture/écriture) nombre maximal de processeurs virtuels.
  • VCPUs-at-startup Nombre de démarrage (lecture/écriture) des processeurs virtuels
  • actions-after-crash (lecture/écriture) à effectuer en cas de panne de la machine virtuelle. Pour les invités PV, les paramètres valides sont les suivants :
    • preserve (pour analyse uniquement)
    • coredump_and_restart (enregistrer un coredump et redémarrer une machine virtuelle)
    • coredump_and_destroy (enregistrer un coredump et laisser la machine virtuelle interrompue)
    • restart (pas de coredump et redémarrage de la machine virtuelle)
    • destroy (pas de coredump et laisser la machine virtuelle interrompue)
  • console-uuids (paramètre défini en lecture seule) consoles virtuelles
  • platform (paramètre de carte en lecture/écriture) configuration spécifique à la plate-forme

    Pour désactiver le VDA afin de passer Windows 10 en mode tablette :

     xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=0
     <!--NeedCopy-->
    

    Pour permettre au VDA de basculer Windows 10 en mode Tablet :

     xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=1
     <!--NeedCopy-->
    

    Pour vérifier l’état actuel :

     xe vm-param-get uuid=<vm_uuid> param-name=platform param-key=acpi_laptop_slate
     <!--NeedCopy-->
    
  • allowed-operations (paramètre de jeu en lecture seule) liste des opérations autorisées dans cet état
  • current-operations (lecture seule paramètre set) une liste des opérations en cours sur la machine virtuelle
  • allowed-VBD-devices (paramètre de jeu en lecture seule) liste des identifiants VBD disponibles pour utilisation, représentés par des entiers compris entre 0 et 15. Cette liste n’est fournie qu’à titre informatif et d’autres appareils peuvent être utilisés (mais peuvent ne pas fonctionner).
  • allowed-VIF-devices (paramètre de jeu en lecture seule) liste des identifiants VIF disponibles pour utilisation, représentés par des entiers compris entre 0 et 15. Cette liste n’est fournie qu’à titre informatif et d’autres appareils peuvent être utilisés (mais peuvent ne pas fonctionner).
  • HVM-boot-policy (lecture/écriture) la stratégie de démarrage pour les invités HVM. Ordre du BIOS ou chaîne vide.
  • HVM-boot-params (paramètre de mappage en lecture/écriture) la clé d’ordre contrôle l’ordre de démarrage de l’invité HVM, représenté sous la forme d’une chaîne où chaque caractère est une méthode de démarrage : d pour le CD/DVD, c pour le disque racine et n pour le démarrage PXE réseau. La valeur par défaut est dc.
  • HVM-shadow-multiplier (lecture/écriture) Valeur à virgule flottante qui contrôle la quantité de mémoire ombragée à accorder à la machine virtuelle. La valeur par défaut est 1.0 (la valeur minimale), et seuls les utilisateurs avancés peuvent modifier cette valeur.
  • PV-kernel (lecture/écriture) chemin vers le noyau
  • PV-ramdisk chemin d’accès (lecture/écriture) vers le initrd
  • PV-args (lecture/écriture) chaîne d’arguments de ligne de commande du noyau
  • PV-legacy-args (lecture/écriture) chaîne d’arguments pour faire démarrer les machines virtuelles héritées
  • PV-bootloader (lecture/écriture) nom ou chemin d’accès au chargeur de démarrage
  • PV-bootloader-args (lecture/écriture) chaîne de divers arguments pour le chargeur de démarrage
  • last-boot-CPU-flags (lecture seule) décrit les indicateurs CPU sur lesquels la machine virtuelle a été démarrée pour la dernière fois
  • resident-on (lecture seule) le serveur Citrix Hypervisor sur lequel réside une machine virtuelle
  • affinity (lecture/écriture) Serveur Citrix Hypervisor sur lequel la machine virtuelle a la préférence pour s’exécuter. Utilisé par la commande xe vm-start pour décider où exécuter la machine virtuelle
  • other-config ( paramètre de carte en lecture/écriture) Liste de paires clé/valeur qui spécifient des paramètres de configuration supplémentaires pour la machine virtuelle. Par exemple, une machine virtuelle est démarrée automatiquement après le démarrage de l’hôte lorsque le paramètre other-configinclut la paire clé/valeur auto_poweron: true
  • start-time (lecture seule) horodatage de la date et de l’heure auxquelles les métriques de la machine virtuelle ont été lues. Cet horodatage se présente sous la forme yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire d’une seule lettre, par exemple, Z pour UTC (GMT)
  • install-time (lecture seule) horodatage de la date et de l’heure auxquelles les métriques de la machine virtuelle ont été lues. Cet horodatage se présente sous la forme yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire d’une seule lettre, par exemple, Z pour UTC (GMT)
  • memory-actual (lecture seule) la mémoire réelle utilisée par une machine virtuelle
  • VCPUs-number (lecture seule) le nombre de processeurs virtuels affectés à la machine virtuelle pour une machine virtuelle Linux. Ce nombre peut différer de VCPUS-max et peut être modifié sans redémarrer la machine virtuelle à l’aide de la commande vm-vcpu-hotplug. Pour plus d’informations, consultez vm-vcpu-hotplug. Les machines virtuelles Windows s’exécutent toujours avec le nombre de vCPU défini sur VCPUsmax et doit être redémarré pour modifier cette valeur. Les performances diminuent fortement lorsque VCPUs-number vous définissez une valeur supérieure au nombre de processeurs physiques sur le serveur Citrix Hypervisor.
  • VCPUs-Utilization (paramètre de carte en lecture seule) une liste des processeurs virtuels et leur poids
  • os-version (paramètre de carte en lecture seule) la version du système d’exploitation de la machine virtuelle
  • PV-drivers-version (paramètre de carte en lecture seule) les versions des pilotes paravirtualisés pour la machine virtuelle
  • PV-drivers-detected (lecture seule) pour la dernière version des pilotes paravirtualisés pour la machine virtuelle
  • memory (paramètre de mappage en lecture seule) des mesures de mémoire rapportées par l’agent sur la machine virtuelle
  • disks (paramètre de mappage en lecture seule) des mesures de disque signalées par l’agent sur la machine virtuelle
  • networks (paramètre de carte en lecture seule) mesures de réseau signalées par l’agent sur la machine virtuelle
  • other (paramètre de mappage en lecture seule) autres mesures rapportées par l’agent sur la machine virtuelle
  • guest-metrics-lastupdated (lecture seule) horodatage lorsque l’agent invité a effectué la dernière écriture dans ces champs. L’horodatage est sous la forme yyyymmddThh:mm:ss z, où z est l’indicateur de fuseau horaire militaire à une lettre unique, par exemple, Z pour UTC (GMT)
  • actions-after-shutdown (lecture/écriture) à effectuer après l’arrêt de la machine virtuelle
  • actions-after-reboot (lecture/écriture) action à effectuer après le redémarrage de la machine virtuelle
  • possible-hostshôtes potentiels de cette machine virtuelle en lecture seule
  • dom-id (lecture seule) ID de domaine (si disponible, -1 sinon)
  • recommendations (lecture seule) Spécification XML des valeurs et plages recommandées pour les propriétés de cette machine virtuelle
  • xenstore-data (paramètre de carte en lecture/écriture) à insérer dans l’arborescence xenstore (/local/domain/*domid*/vm-data) après la création de la machine virtuelle
  • is-a-snapshot (lecture seule) True si cette machine virtuelle est un instantané
  • snapshot_of (lecture seule) l’UUID de la machine virtuelle dont ce snapshot est de
  • snapshots (lecture seule) les UUID de tous les instantanés de cette machine virtuelle
  • snapshot_time (lecture seule) l’horodatage de l’opération de capture instantanée qui a créé ce snapshot de machine virtuelle
  • memory-target (lecture seule) la quantité cible de mémoire définie pour cette machine virtuelle
  • blocked-operations (paramètre de carte en lecture/écriture) répertorie les opérations qui ne peuvent pas être effectuées sur cette machine virtuelle
  • last-boot-record (lecture seule) enregistrement des derniers paramètres de démarrage de ce modèle, au format XML
  • ha-always-run (lecture/écriture) True si cette machine virtuelle est toujours redémarrée sur un autre hôte en cas de défaillance de l’hôte sur lequel elle réside. Ce paramètre est désormais obsolète. Utilisez plutôt le paramètre ha-restart-priority.
  • ha-restart-priority (lecture/écriture) redémarrage ou meilleur effort
  • blobs (lecture seule) stockage de données binaires
  • live (lecture seule) True si la machine virtuelle est en cours d’exécution. False si HA soupçonne que la machine virtuelle n’est pas en cours d’exécution.

vm-assert-can-be-recovered

xe vm-assert-can-be-recovered uuid [database] vdi-uuid
<!--NeedCopy-->

Teste si le stockage est disponible pour récupérer cette machine virtuelle.

vm-call-plugin

xe vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]
<!--NeedCopy-->

Appelle la fonction du plug-in sur la machine virtuelle donnée avec des arguments facultatifs (args:key=value). Pour passer une chaîne de « valeur » contenant des caractères spéciaux (par exemple nouvelle ligne), une syntaxe alternative args:key:file=local_file peut être utilisée en place, où le contenu de local_file sera récupéré et affecté à « key » dans son ensemble.

vm-cd-add

xe vm-cd-add cd-name=name_of_new_cd device=integer_value_of_an_available_vbd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Ajoutez un nouveau CD virtuel à la machine virtuelle sélectionnée. Le paramètre device doit être sélectionné à partir de la valeur du paramètre allowed-VBD-devices de la machine virtuelle.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-cd-eject

xe vm-cd-eject [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Éjectez un CD du lecteur de CD virtuel. Cette commande ne fonctionne que si un seul CD est connecté à la machine virtuelle. Lorsqu’il y a deux CD ou plus, utilisez la commande xe vbd-eject et spécifiez l’UUID du VBD.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-cd-insert

xe vm-cd-insert cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Insérez un CD dans le lecteur de CD virtuel. Cette commande ne fonctionne que s’il y a exactement un lecteur de CD vide connecté à la machine virtuelle. Lorsqu’il y a deux ou plusieurs périphériques CD vides, utilisez la commande xe vbd-insert et spécifiez les UUID du VBD et du VDI à insérer.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-cd-list

xe vm-cd-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Répertorie les CD attachés aux machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Vous pouvez également sélectionner les paramètres VBD et VDI à lister.

vm-cd-remove

xe vm-cd-remove cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Supprimez un CD virtuel des machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-checkpoint

xe vm-checkpoint new-name-label=name_label [new-name-description=description]
<!--NeedCopy-->

Checkpoint une machine virtuelle existante, à l’aide d’une opération rapide de snapshot de disque au niveau du stockage, le cas échéant.

vm-clone

xe vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Clonez une machine virtuelle existante, à l’aide d’une opération de clone de disque rapide au niveau du stockage, le cas échéant. Spécifiez le nom et la description facultative de la machine virtuelle clonée résultante à l’aide des arguments new-name-label et new-name-description.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-compute-maximum-memory

xe vm-compute-maximum-memory total=amount_of_available_physical_ram_in_bytes [approximate=add overhead memory for additional vCPUS? true|false] [vm_selector=vm_selector_value...]
<!--NeedCopy-->

Calculez la quantité maximale de mémoire statique qui peut être allouée à une machine virtuelle existante, en utilisant la quantité totale de RAM physique comme limite supérieure. Le paramètre optionnel approximate réserve suffisamment de mémoire supplémentaire dans le calcul pour tenir compte de l’ajout de vCPU supplémentaires dans la machine virtuelle ultérieurement.

Par exemple :

xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`
<!--NeedCopy-->

Cette commande utilise la valeur du paramètre memory-free renvoyé par la commande xe host-list pour définir la mémoire maximale de la machine virtuelle nomméetestvm .

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-compute-memory-overhead

xe vm-compute-memory-overhead
<!--NeedCopy-->

Calcule la surcharge mémoire de virtualisation d’une machine virtuelle.

vm-copy

xe vm-copy new-name-label=name_for_copy [new-name-description=description_for_copy] [sr-uuid=uuid_of_sr] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Copiez une machine virtuelle existante, mais sans utiliser l’opération de clonage rapide de disque au niveau du stockage (même si cette option est disponible). Les images disque de la machine virtuelle copiée sont garanties d’être des images complètes, c’est-à-dire qu’elles ne font pas partie d’une chaîne de copie sur écriture (CoW).

Spécifiez le nom et la description facultative de la machine virtuelle copiée résultante à l’aide des arguments new-name-label et new-name-description.

Spécifiez le SR de destination pour la machine virtuelle copiée résultante à l’aide du sr-uuid. Si ce paramètre n’est pas spécifié, la destination est la même SR que celle dans laquelle se trouve la machine virtuelle d’origine.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-copy-bios-strings

xe vm-copy-bios-strings host-uuid=host_uuid
<!--NeedCopy-->

Copiez les chaînes du BIOS de l’hôte donné sur la machine virtuelle.

Remarque :

Après avoir démarré une machine virtuelle pour la première fois, vous ne pouvez pas modifier ses chaînes de BIOS. Assurez-vous que les chaînes du BIOS sont correctes avant de démarrer la machine virtuelle pour la première fois.

vm-crashdump-list

xe vm-crashdump-list [vm-selector=vm selector value...]
<!--NeedCopy-->

Répertorier les crashdumps associés aux machines virtuelles spécifiées.

Lorsque vous utilisez l’argument optionnel params, la valeur de params est une chaîne contenant une liste de paramètres de cet objet que vous souhaitez afficher. Vous pouvez également utiliser le mot-clé all pour afficher tous les paramètres. Si params n’est pas utilisé, la liste renvoyée affiche un sous-ensemble par défaut de tous les paramètres disponibles.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-data-source-list

xe vm-data-source-list [vm-selector=vm selector value...]
<!--NeedCopy-->

Répertorie les sources de données pouvant être enregistrées pour une machine virtuelle.

Sélectionnez les machines virtuelles sur lesquelles effectuer cette opération à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section. Si aucun paramètre de sélection d’hôtes n’est donné, l’opération est effectuée sur toutes les machines virtuelles.

Les sources de données ont deux paramètres — standard et enabled — que vous pouvez voir dans la sortie de cette commande. Si une source de données a enabled défini sur true, les mesures sont actuellement enregistrées dans la base de données de performances. Si une source de données est standard définie sur true, les mesures sont enregistrées dans la base de données de performance par défaut (et enabled sont également définies sur true pour cette source de données). Si une source de données est standard définie sur false, les mesures ne sont pas enregistrées dans la base de données des performances par défaut (et enabled sont également définies sur false pour cette source de données).

Pour commencer à enregistrer des mesures de source de données dans la base de données de performances, exécutez la commande vm-data-source-record. Cette commande définit enabled sur true. Pour arrêter, lancez le vm-data-source-forget. Cette commande définit enabled sur false.

vm-data-source-record

xe vm-data-source-record data-source=name_description_of_data-source [vm-selector=vm selector value...]
<!--NeedCopy-->

Enregistrez la source de données spécifiée pour une machine virtuelle.

Cette opération écrit les informations de la source de données dans la base de données des mesures de performance persistantes des machines virtuelles spécifiées. Pour des raisons de performances, cette base de données est distincte de la base de données de l’agent normal.

Sélectionnez les machines virtuelles sur lesquelles effectuer cette opération à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section. Si aucun paramètre de sélection d’hôtes n’est donné, l’opération est effectuée sur toutes les machines virtuelles.

vm-data-source-forget

xe vm-data-source-forget data-source=name_description_of_data-source [vm-selector=vm selector value...]
<!--NeedCopy-->

Arrêtez d’enregistrer la source de données spécifiée pour une machine virtuelle et oubliez toutes les données enregistrées.

Sélectionnez les machines virtuelles sur lesquelles effectuer cette opération à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section. Si aucun paramètre de sélection d’hôtes n’est donné, l’opération est effectuée sur toutes les machines virtuelles.

vm-data-source-query

xe vm-data-source-query data-source=name_description_of_data-source [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Afficher la source de données spécifiée pour une machine virtuelle.

Sélectionnez les machines virtuelles sur lesquelles effectuer cette opération à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section. Si aucun paramètre de sélection d’hôtes n’est donné, l’opération est effectuée sur toutes les machines virtuelles.

vm-destroy

xe vm-destroy uuid=uuid_of_vm
<!--NeedCopy-->

Détruisez la machine virtuelle spécifiée. Cela laisse intact le stockage associé à la machine virtuelle. Pour supprimer également le stockage, utilisez xe vm-uninstall.

vm-disk-add

xe vm-disk-add disk-size=size_of_disk_to_add device=uuid_of_device [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Ajoutez un disque aux machines virtuelles spécifiées. Sélectionnez le paramètre devicedans la valeur du paramètre allowed-VBD-devices des machines virtuelles.

Le paramètre disk-size peut être spécifié en octets ou en utilisant les suffixes standard IEC Kio, Mio, Gio et Tio.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-disk-list

xe vm-disk-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Répertorie les disques attachés aux machines virtuelles spécifiées. Les paramètres vbd-params et vdi-params contrôlent les champs des objets respectifs à sortir. Donnez les paramètres sous forme de liste séparée par des virgules, ou la clé spéciale all pour la liste complète.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-disk-remove

xe vm-disk-remove device=integer_label_of_disk [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Supprimez un disque des machines virtuelles spécifiées et détruisez-le.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-export

xe vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Exportez les machines virtuelles spécifiées (y compris les images disque) vers un fichier sur la machine locale. Spécifiez le nom de fichier dans lequel exporter la machine virtuelle à l’aide du paramètre filename. Par convention, le nom du fichier doit avoir une .xva extension.

Si le paramètre metadata est true, les disques ne sont pas exportés. Seules les métadonnées de la machine virtuelle sont écrites dans le fichier de sortie. Utilisez ce paramètre lorsque le stockage sous-jacent est transféré via d’autres mécanismes et permet de recréer les informations de la machine virtuelle. Pour plus d’informations, consultez [vm-import] (#vm -import).

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-import

xe vm-import filename=export_filename [metadata=true|false] [preserve=true|false][sr-uuid=destination_sr_uuid]
<!--NeedCopy-->

Importez une machine virtuelle à partir d’un fichier précédemment exporté. Si preserve est défini sur true, l’adresse MAC de la machine virtuelle d’origine est conservée. Le sr-uuid détermine le SR de destination dans lequel importer la machine virtuelle. Si ce paramètre n’est pas spécifié, le SR par défaut est utilisé.

Si metadata est true, vous pouvez importer un jeu de métadonnées précédemment exporté sans les blocs de disque associés. L’importation des métadonnées uniquement échoue si aucun VDI est introuvable (nommé par SR et VDI.location) sauf si l’ --force option est spécifiée, auquel cas l’importation se poursuit malgré tout. Si les disques peuvent être mis en miroir ou déplacés hors bande, l’importation/exportation de métadonnées est un moyen rapide de déplacer des machines virtuelles entre des pools disjoints. Par exemple, dans le cadre d’un plan de reprise après sinistre.

Remarque :

Les importations de plusieurs machines virtuelles sont effectuées plus rapidement en série qu’en parallèle.

vm-install

xe vm-install new-name-label=name [template-uuid=uuid_of_desired_template] [template=template_uuid_or_name] [sr-uuid=sr_uuid | sr-name-label=name_of_sr][copy-bios-strings-from=host_uuid]
<!--NeedCopy-->

Installez ou clonez une machine virtuelle à partir d’un modèle. Spécifiez le nom du modèle à l’aide de l’argument template-uuidou template. Spécifiez une SR à l’aide de l’argument sr-uuid ou sr-name-label. Spécifiez l’installation du support verrouillé par le BIOS à l’aide de l’ copy-bios-strings-from argument

Remarque :

Lors de l’installation à partir d’un modèle comportant des disques existants, par défaut, les nouveaux disques sont créés dans le même SR que ces disques existants. Lorsque le SR le prend en charge, ces disques sont des copies rapides. Si une SR différente est spécifiée sur la ligne de commande, les nouveaux disques y sont créés. Dans ce cas, une copie rapide n’est pas possible et les disques sont des copies complètes.

Lors de l’installation à partir d’un modèle qui ne possède pas de disques existants, tous les nouveaux disques sont créés dans le SR spécifié, ou dans le SR par défaut du pool lorsqu’aucun SR n’est spécifié.

vm-is-bios-customized

xe vm-is-bios-customized
<!--NeedCopy-->

Indique si les chaînes du BIOS de la machine virtuelle ont été personnalisées.

vm-memory-balloon

xe vm-memory-balloon target=target
<!--NeedCopy-->

Définissez la cible mémoire pour une machine virtuelle en cours d’exécution. La valeur donnée doit être comprise dans la plage définie par les valeurs memory_dynamic_min et memory_dynamic_max de la machine virtuelle.

vm-memory-dynamic-range-set

xe vm-memory-dynamic-range-set min=min max=max
<!--NeedCopy-->

Configurez la plage de mémoire dynamique d’une machine virtuelle. La plage de mémoire dynamique définit des limites inférieures et supérieures souples pour la mémoire d’une machine virtuelle. Il est possible de modifier ces champs lorsqu’une machine virtuelle est en cours d’exécution ou arrêtée. La plage dynamique doit être comprise dans la plage statique.

vm-memory-limits-set

xe vm-memory-limits-set static-min=static_min static-max=static_max dynamic-min=dynamic_min dynamic-max=dynamic_max
<!--NeedCopy-->

Configurez les limites de mémoire d’une machine virtuelle.

vm-memory-set

xe vm-memory-set memory=memory
<!--NeedCopy-->

Configurez l’allocation de mémoire d’une machine virtuelle.

vm-memory-shadow-multiplier-set

xe vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]
<!--NeedCopy-->

Définissez le multiplicateur de mémoire instantanée pour la machine virtuelle spécifiée.

Il s’agit d’une option avancée qui modifie la quantité de mémoire fantôme affectée à une machine virtuelle assistée par matériel.

Dans certaines charges de travail d’applications spécialisées, telles que Citrix Virtual Apps, une mémoire fantôme supplémentaire est requise pour atteindre des performances optimales.

Cette mémoire est considérée comme une surcharge. Il est séparé des calculs de mémoire normaux pour la gestion de la mémoire vers une machine virtuelle. Lorsque cette commande est appelée, la quantité de mémoire hôte libre diminue en fonction du multiplicateur et le champ HVM_shadow_multiplier est mis à jour avec la valeur attribuée par Xen à la machine virtuelle. S’il n’y a pas assez de mémoire disponible sur le serveur Citrix Hypervisor, une erreur est renvoyée.

Les machines virtuelles sur lesquelles cette opération doit être effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles.

vm-memory-static-range-set

xe vm-memory-static-range-set min=min max=max
<!--NeedCopy-->

Configurez la plage de mémoire statique d’une machine virtuelle. La plage de mémoire statique définit des limites inférieures et supérieures strictes pour la mémoire d’une machine virtuelle. Il est possible de modifier ces champs uniquement lorsqu’une machine virtuelle est arrêtée. La plage statique doit englober la plage dynamique.

vm-memory-target-set

xe vm-memory-target-set target=target
<!--NeedCopy-->

Définissez la cible de mémoire pour une machine virtuelle arrêtée ou en cours d’exécution. La valeur donnée doit être comprise dans la plage définie par les valeurs memory_static_min et memory_static_max de la machine virtuelle.

vm-memory-target-wait

xe vm-memory-target-wait
<!--NeedCopy-->

Attendez qu’une machine virtuelle en cours d’exécution atteigne sa cible de mémoire actuelle.

vm-migrate

xe vm-migrate [copy=true|false] [host-uuid=destination_host_uuid] [host=name_or_ uuid_of_destination_host] [force=true|false] [live=true|false] [vm-selector=vm_selector_value...] [remote-master=destination_pool_master_uuid] [remote-username=destination_pool_username] [remote-password=destination_pool_password] [remote-network=destination_pool_network_uuid ][vif:=vif_uuid] [vdi=vdi_uuid]
<!--NeedCopy-->

Cette commande migre les machines virtuelles spécifiées entre les hôtes physiques. Le paramètre host peut être le nom ou l’UUID du serveur Citrix Hypervisor. Par exemple, pour migrer la machine virtuelle vers un autre hôte du pool, où les disques de la machine virtuelle se trouvent sur un stockage partagé par les deux hôtes :

xe vm-migrate uuid=vm_uuid host-uuid=host_uuid
<!--NeedCopy-->

Pour déplacer des machines virtuelles entre des hôtes du même pool, qui ne partagent pas le stockage (migration en direct du stockage) :

xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78 \
    remote-username=username remote-password=password \
    host-uuid=desination_host_uuid vdi=vdi_uuid
<!--NeedCopy-->

Vous pouvez choisir le SR où chaque VDI est stocké :

xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \
    vdi1:vdi_1_uuid=destination_sr_uuid \
    vdi2:vdi_2_uuid=destination_sr2_uuid \
    vdi3:vdi_3_uuid=destination_sr3_uuid
<!--NeedCopy-->

En outre, vous pouvez choisir le réseau auquel connecter la machine virtuelle après la migration :

xe vm-migrate uuid=vm_uuid \
    vdi1:vdi_1_uuid=destination_sr_uuid \
    vdi2:vdi_2_uuid=destination_sr2_uuid \
    vdi3:vdi_3_uuid=destination_sr3_uuid \
    vif:vif_uuid=network_uuid
<!--NeedCopy-->

Pour la migration entre pools :

xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78
    remote-username=username remote-password=password \
    host-uuid=desination_host_uuid vdi=vdi_uuid
<!--NeedCopy-->

Pour plus d’informations sur la migration en direct du stockage, la migration en direct et la migration VDI en direct, consultez Migrer des machines virtuelles.

Par défaut, la machine virtuelle est suspendue, migrée et reprise sur l’autre hôte. Le paramètre live sélectionne la migration dynamique. La migration en direct maintient la machine virtuelle en cours d’exécution pendant la migration, réduisant ainsi les temps d’arrêt de la machine virtuelle à moins d’une seconde. Dans certaines circonstances, telles que les charges de travail extrêmement gourmandes en mémoire sur la machine virtuelle, la migration en direct revient en mode par défaut et suspend la machine virtuelle pendant une courte période avant de terminer le transfert de mémoire.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-pause

xe vm-pause
<!--NeedCopy-->

Suspendre une machine virtuelle en cours d’exécution. Notez que cette opération ne libère pas la mémoire associée (voir vm-suspend).

vm-query-services

xe vm-query-services
<!--NeedCopy-->

Interrogez les services système proposés par les machines virtuelles données.

vm-reboot

xe vm-reboot [vm-selector=vm_selector_value...] [force=true]
<!--NeedCopy-->

Redémarrez les machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Utilisez l’argument force pour provoquer un redémarrage non gracieux. Où l’arrêt revient à débrancher un serveur physique.

vm-recover

xe vm-recover vm-uuid [database] [vdi-uuid] [force]
<!--NeedCopy-->

Récupère une machine virtuelle à partir de la base de données contenue dans le VDI fourni.

vm-reset-powerstate

xe vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}
<!--NeedCopy-->

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Il s’agit d’une commande avancée à utiliser uniquement lorsqu’un hôte membre d’un pool tombe en panne. Vous pouvez utiliser cette commande pour forcer le maître de pool à réinitialiser l’état d’alimentation des machines virtuelles à être halted. Essentiellement, cette commande force le verrouillage sur la machine virtuelle et ses disques afin qu’elle puisse être redémarrée ensuite sur un autre hôte de pool. Cet appel nécessite que l’indicateur de force soit spécifié et échoue s’il ne se trouve pas sur la ligne de commande.

vm-resume

xe vm-resume [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid]
<!--NeedCopy-->

Reprenez les machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Si la machine virtuelle se trouve sur une SR partagée dans un pool d’hôtes, utilisez l’argument onpour spécifier le membre de pool sur lequel démarrer. Par défaut, le système détermine un hôte approprié, qui peut être l’un des membres du pool.

vm-retrieve-wlb-recommendations

xe vm-retrieve-wlb-recommendations
<!--NeedCopy-->

Récupérez les recommandations d’équilibrage de la charge de travail pour la VM sélectionnée.

vm-shutdown

xe vm-shutdown [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

Arrêtez la machine virtuelle spécifiée.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Utilisez l’argument force pour provoquer un arrêt brutal, similaire à couper l’alimentation d’un serveur physique.

vm-snapshot

xe vm-snapshot new-name-label=name_label [new-name-description+name_description]
<!--NeedCopy-->

Effectuez un snapshot d’une machine virtuelle existante, en utilisant l’opération d’instantané de disque rapide au niveau du stockage,

vm-start

xe vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]
<!--NeedCopy-->

Démarrez les machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Si les machines virtuelles se trouvent sur une SR partagée dans un pool d’hôtes, utilisez l’argument on pour spécifier le membre de pool sur lequel démarrer les machines virtuelles. Par défaut, le système détermine un hôte approprié, qui peut être l’un des membres du pool.

vm-suspend

xe vm-suspend [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Suspendez la machine virtuelle spécifiée.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-uninstall

xe vm-uninstall [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

Désinstallez une machine virtuelle en détruisant ses disques (les VDI marqués RW et connectés à cette machine virtuelle uniquement) en plus de son enregistrement de métadonnées. Pour détruire uniquement les métadonnées de la machine virtuelle, utilisez xe vm-destroy.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

vm-unpause

xe vm-unpause
<!--NeedCopy-->

Réactiver une machine virtuelle en pause.

vm-vcpu-hotplug

xe vm-vcpu-hotplug new-vcpus=new_vcpu_count [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Ajustez dynamiquement le nombre de vCPU disponibles pour une machine virtuelle Linux en cours d’exécution. Le nombre de vCPU est limité par le paramètre VCPUs-max. Les machines virtuelles Windows s’exécutent toujours avec le nombre de vCPU défini sur VCPUs-max et doit être redémarré pour modifier cette valeur.

La ou les machines virtuelles Linux sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Remarque :

Lors de l’exécution de machines virtuelles Linux sans Citrix VM Tools installé, exécutez la commande suivante sur la machine virtuelle en tant que root afin de vous assurer que les vCPU récemment connectés à chaud sont utilisés : # for i in /sys/devices/system/cpu/cpu[1-9]*/online; do if [ "$(cat $i)" = 0 ]; then echo 1 > $i; fi; done

vm-vif-list

xe vm-vif-list [vm-selector=vm_selector_value...]
<!--NeedCopy-->

Répertorie les VIF des machines virtuelles spécifiées.

La ou les machines virtuelles sur lesquelles cette opération est effectuée sont sélectionnées à l’aide du mécanisme de sélection standard. Pour plus d’informations, voir sélecteurs de machines virtuelles. Les sélecteurs opèrent sur les enregistrements de VM lors du filtrage, et non sur les valeurs VIF. Les arguments facultatifs peuvent être n’importe quel nombre de paramètres VM répertoriés au début de cette section.

Instantanés planifiés

Commandes permettant de contrôler les instantanés planifiés de machine virtuelle et leurs attributs.

Les objets vmss peuvent être listés avec la commande de liste d’objets standard (xe vmss-list), et les paramètres manipulés avec les commandes de paramètres standard. Pour plus d’informations, voir Commandes de paramètres de bas niveau

vmss-create

xe vmss-create enabled=True/False name-label=name type=type frequency=frequency retained-snapshots=value name-description=description schedule:schedule
<!--NeedCopy-->

Crée une planification d’instantanés dans le pool.

Par exemple :

xe vmss-create retained-snapshots=9 enabled=true frequency=daily \
    name-description=sample name-label=samplepolicy type=snapshot \
    schedule:hour=10 schedule:min=30
<!--NeedCopy-->

Les planifications d’instantanés ont les paramètres suivants :

Nom du paramètre Description Type
name-label Nom de la planification des instantanés. Lecture/Écriture
name-description Description de la planification des instantanés. Lecture/Écriture
type Instantané disque ou instantané de mémoire. Lecture/Écriture
frequency Horaire ; Quotidien ; Hebdomadaire Lecture/Écriture
retained-snapshots Instantanés à conserver. Portée : 1 à 10. Lecture/Écriture
schedule schedule:days (du lundi au dimanche), schedule:hours (0 à 23), schedule:minutes (0, 15, 30, 45) Lecture/Écriture

vmss-destroy

xe vmss-destroy uuid=uuid
<!--NeedCopy-->

Détruit une planification d’instantanés dans le pool.

Pass-through USB

Activer/désactiver le passage USB

xe pusb-param-set uuid=pusb_uuid passthrough-enabled=true/false
<!--NeedCopy-->

Activer/désactiver le passage USB.

pusb-scan

xe pusb-scan host-uuid=host_uuid
<!--NeedCopy-->

Scannez le PUSB et mettez à jour.

vusb-create

xe vusb-create usb-group-uuid=usb_group_uuid vm-uuid=vm_uuid
<!--NeedCopy-->

Crée une clé USB virtuelle dans le pool. Démarrez la machine virtuelle pour passer par l’USB vers la machine virtuelle.

vusb-unplug

xe vusb-unplug uuid=vusb_uuid
<!--NeedCopy-->

Débranche l’USB de la machine virtuelle.

vusb-destroy

xe vusb-destroy uuid=vusb_uuid
<!--NeedCopy-->

Supprime la liste USB virtuelle de la machine virtuelle.