Administration du cache à l'aide de Windows PowerShell (mise en cache de Windows Server AppFabric)

Grâce à Windows PowerShell, vous pouvez administrer le cluster de cache, les hôtes de cache et le cache lui-même. Si vous utilisez un ordinateur sur lequel la fonctionnalité d'administration du cache est installée, vous pouvez gérer les fonctionnalités de mise en cache d'AppFabric de deux façons via Windows PowerShell. Dans le menu Démarrer, accédez à Outils d'administration, puis cliquez sur Modules Windows PowerShell. Ou dans le menu Démarrer, cliquez sur Tous les programmes, Windows Server AppFabric, puis sur Windows PowerShell pour l'administration de la mise en cache.

Notes

Sous les systèmes d'exploitation Windows Vista, Windows 7 et Windows Server 2008, vous devez exécuter Windows PowerShell avec des privilèges d'administrateur pour que certaines commandes d'administration fonctionnent correctement. Pour le raccourci Windows PowerShell pour l'administration de la mise en cache, cliquez avec le bouton droit dessus et sélectionner Exécuter en tant qu'administrateur.

Les commandes PowerShell de mise en cache d'AppFabric appartiennent à deux catégories principales : commandes d'administration et commandes de configuration. Cette rubrique s'attache à décrire les seules commandes d'administration. Pour plus d'informations sur les commandes de configuration, consultez la rubrique Configuration du cache à l'aide de Windows PowerShell (mise en cache de Windows Server AppFabric). Les commandes d'administration sont divisées en catégories dans les tableaux de cette rubrique. Certaines commandes apparaissent dans plusieurs tableaux, avec différents paramètres selon qu'elles s'appliquent à l'une des quatre catégories de commandes :

• Commandes liées au cluster de cache

• Commandes liées à l'hôte de cache

• Commandes liées au cache

• Commandes de gestion de la console

Accès à l'aide dans la session Windows PowerShell

Les informations ci-dessous récapitulent les commandes de configuration des fonctionnalités de mise en cache d'AppFabric. Vous pouvez également obtenir de l'aide dans la session Windows PowerShell. Par exemple, la commande suivante affiche toutes les commandes d'administration :

get-command -module DistributedCacheAdministration

Si vous avez besoin d'aide sur une commande précise, vous pouvez utiliser la commande get-help pour la rechercher. Par exemple, la commande suivante affiche l'aide complète pour la commande New-Cache :

get-help New-Cache -full

Considérations importantes

Il convient de tenir compte des aspects suivants dans le cadre de l'utilisation des commandes Windows PowerShell décrites dans cette rubrique :

• L'identité de sécurité de l'utilisateur des commandes Windows PowerShell doit disposer de privilèges d'administrateur sur tous les serveurs de cache dans le cluster de cache.

• Les valeurs des paramètres des commandes respectent la casse. Par exemple, si vous créez le cache NamedCache1, la commande Get-CacheConfig -CacheName namedcache1 ne fonctionnera pas. Vous devez reproduire la casse comme suit : Get-CacheConfig -CacheName NamedCache1.

• Lorsque vous modifiez la configuration du cluster à l'aide des commandes Export-CacheClusterConfig et Import-CacheClusterConfig, vous pouvez modifier les paramètres de configuration du cluster (attributs XML) dans le fichier XML, mais pas ajouter ou supprimer des caches nommés et des hôtes de cache en insérant ou en supprimant des éléments XML.

• Les commandes de cluster de cache Start-CacheCluster, Stop-CacheCluster et Restart-CacheCluster impliquent une coordination de l'état du service Windows d'hôte de cache sur tous les serveurs de cache dans le cluster. L'exécution de ces commandes peut prendre davantage de temps lorsque les hôtes principaux exécutent le rôle de gestion du cluster. La majorité des hôtes principaux doit être en cours d'exécution lors de l'arrêt et du redémarrage des hôtes de cache restants.

• Démarrez et arrêtez toujours le service de mise en cache à l'aide des commandes de cluster de cache Start-CacheCluster, Stop-CacheCluster et Restart-CacheCluster. L'utilisation de l'outil d'administration des services pour démarrer et arrêter le service peut entraîner un blocage. Par ailleurs, ces commandes doivent être exécutées à partir d'une session Windows PowerShell dotée de privilèges d'administrateur.

• Les commandes de cluster de cache Stop-CacheCluster et Restart-CacheCluster purgent les données de la mémoire sur tous les hôtes de cache du cluster.

• Les commandes Set-CacheConfig et Import-CacheClusterConfig nécessitent le redémarrage du cluster de cache à l'aide de la commande Restart-CacheCluster pour que les modifications prennent effet.

• Les commandes Remove-Cache et New-Cache permettent de modifier la configuration d'un cache nommé sans affecter les autres caches nommés dans le cluster.

Commandes liées au cluster de cache

Le tableau suivant répertorie les commandes Windows PowerShell pour l'administration du cache qui permettent d'exécuter des opérations liées au cluster.

Commande	Description
Use-CacheCluster	Définit le contexte de votre session Windows PowerShell sur le cluster de cache souhaité. Lorsque vous démarrez une session Windows PowerShell, vous devez commencer par exécuter cette commande. Si la session utilise un hôte de cache, exécutez la commande sans paramètres car ceux-ci sont extraits de la configuration du cache sur l'ordinateur. Si la session utilise un ordinateur non hôte, vous pouvez utiliser les paramètres suivants pour spécifier le cluster de cache souhaité. Les paramètres (alias) sont décrits ci-dessous : Provider (P) : fournisseur utilisé pour stocker les paramètres de configuration du cluster. Ce paramètre peut avoir la valeur System.Data.SqlClient ou XML selon le mode de stockage des informations de configuration. ConnectionString (C) : chaîne de connexion de la base de données ou emplacement du fichier de configuration XML.
Start-CacheCluster	Démarre tous les services de cache dans le cluster. Les hôtes principaux sont démarrés en premier. Notez que les services cache ne sont pas démarrés automatiquement après un redémarrage : la commande Start-CacheCluster ou Start-CacheHost doit être appelée pour démarrer un service. Cette commande requiert des privilèges d'administrateur.
Stop-CacheCluster	Arrête tous les services de cache dans le cluster. Cette commande requiert des privilèges d'administrateur.
Restart-CacheCluster	Redémarre tous les services de cache dans le cluster selon la séquence appropriée. Cette commande requiert des privilèges d'administrateur.
Get-CacheClusterHealth	Renvoie les statistiques relatives au fonctionnement du cluster de cache.
Export-CacheClusterConfig	Conçue pour être utilisée avec la commande Import-CacheClusterConfig, cette commande permet de modifier les paramètres de configuration du cluster dans le fichier XML associé. Pour plus d’informations, consultez la rubrique Modification des paramètres de configuration du cluster (mise en cache de Windows Server AppFabric). Cette commande exporte les paramètres de configuration du cluster, tels qu'ils existent dans le cluster, vers le fichier de configuration XML spécifié. Cette commande peut être utilisée quel que soit l'emplacement de stockage des paramètres de configuration de votre cluster (SQL Server ou dossier réseau partagé). Les paramètres (alias) sont décrits ci-dessous : File (F) : nom et chemin d'accès complets du fichier de configuration XML à créer, décrivant les paramètres actuels de configuration du cluster de cache. Exemple : Export-CacheClusterConfig -File c:\Temp\CurrentClusterConfig.xml
Import-CacheClusterConfig	Conçue pour être utilisée avec la commande Export-CacheClusterConfig, cette commande permet de modifier les paramètres de configuration du cluster dans le fichier XML associé. Pour plus d’informations, consultez la rubrique Modification des paramètres de configuration du cluster (mise en cache de Windows Server AppFabric). Cette commande importe les paramètres de configuration du cluster tels que définis dans le fichier de configuration XML spécifié. Cette commande peut être utilisée quel que soit l'emplacement de stockage des paramètres de configuration de votre cluster (SQL Server ou dossier réseau partagé). Vous devez redémarrer le cluster à l'aide de la commande Restart-CacheCluster pour que les modifications prennent effet. Les paramètres (alias) sont décrits ci-dessous : File (Fi) : nom et chemin d'accès complets du fichier de configuration XML décrivant les paramètres de configuration du cluster de cache à appliquer au cluster. Force (Fo) : importe le fichier de configuration sans demander de confirmation. Exemple : Import-CacheClusterConfig -File c:\CurrentClusterConfig.xml
Grant-CacheAllowedClientAccount	Octroie à un compte Windows l'accès au cluster de cache. Par défaut, les comptes d'administrateur sur les hôtes de cache ont accès au cluster de cache. Les autres comptes doivent être ajoutés de manière explicite à la liste des comptes clients autorisés à l'aide de cette commande. Les paramètres (alias) sont décrits ci-dessous : Account (A) : compte Windows auquel octroyer l'accès au cluster de cache. Force (F) : ajoute le compte client spécifié sans valider son existence.
Revoke-CacheAllowedClientAccount	Révoque l'accès d'un compte Windows au cluster de cache. Notez que ceci n'empêche pas les administrateurs sur les hôtes de cache d'accéder au cluster de cache. Les paramètres (alias) sont décrits ci-dessous : Account (A) : compte Windows auquel octroyer l'accès au cluster de cache.
Get-Cache	Lorsque cette commande est utilisée sans paramètres, elle répertorie les informations sur tous les caches dans le cluster de cache. Notes Pour plus d'informations sur l'utilisation de cette commande avec le paramètre HostName, consultez le tableau suivant.

Commandes liées à l'hôte de cache

Le tableau suivant répertorie les commandes pour l'exécution des opérations liées à l'hôte de cache dans Windows PowerShell.

Commande	Description
Get-CacheHost	Répertorie les informations relatives à l'hôte de cache spécifié. Si aucun paramètre n'est transmis, la commande répertorie tous les services cache appartenant au cluster de cache. Les paramètres (alias) sont décrits ci-dessous : HostName (H) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache de l'hôte de cache. Exemple : Get-CacheHost
Get-CacheHostConfig	Renvoie les informations de configuration relatives à l'hôte de cache spécifié. Les paramètres (alias) sont décrits ci-dessous : HostName (H) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache de l'hôte de cache. Exemple : Get-CacheConfig -HostName CacheServer1 -CachePort 22233
Set-CacheHostConfig	Met à jour la configuration de l'hôte de cache avec les valeurs spécifiées dans les paramètres de la commande. Tous les paramètres sont facultatifs à l'exception de HostName et CachePort. Pour plus d’informations, consultez la rubrique Modification des paramètres de configuration du cluster (mise en cache de Windows Server AppFabric). Les paramètres (alias) sont décrits ci-dessous : HostName (H) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache actuel de l'hôte de cache. ClusterPortNumber (CPort) : numéro de port de cluster utilisé par l'hôte de cache. ArbitratorPortNumber (APort) : nouveau numéro de port d'arbitrage. ReplicationPortNumber (RPort) : nouveau numéro de port de réplication. CacheSize (Size) : quantité de mémoire allouée au stockage des données sur l'hôte de cache, en mégaoctets (Mo). HWM (HWM) : pourcentage de la limite supérieure de mémoire, lorsque l'éviction doit commencer à supprimer les objets non encore expirés. LWM (LWM) : pourcentage de la limite inférieure de mémoire, lorsque l'éviction doit commencer à supprimer les objets expirés. Une fois la valeur du paramètre HWM atteinte, lorsque l'éviction doit arrêter de supprimer les objets non encore expirés. Exemple : Set-CacheConfig -HostName CacheServer1 -CachePort 22233 -LowWM 80
Start-CacheHost	Démarre le service cache spécifié. Cette commande est requise après le redémarrage d'un serveur de cache pour permettre au service cache de rejoindre un cluster de cache en cours d'exécution. Notez que si le cluster de cache est interrompu, vous devez utiliser la commande Start-CacheCluster. Par ailleurs, les services cache ne sont pas démarrés automatiquement après un redémarrage : la commande Start-CacheHost ou Start-CacheCluster doit être appelée pour démarrer un service. Les paramètres (alias) sont décrits ci-dessous : HostName (HostN) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache de l'hôte de cache. HostTimeout(T) : valeur de délai d'expiration en secondes pour le démarrage de l'hôte de cache spécifié. La valeur par défaut est 60 secondes. Exemple : Start-CacheHost -HostName CacheServer1 -CachePort 22233
Stop-CacheHost	Arrête le service cache spécifié. Notes La commande Stop-CacheHost n'arrête pas un service Windows d'hôte de cache si celui-ci exécute le rôle de gestion du cluster. Par ailleurs, l'arrêt de l'hôte de cache provoque l'arrêt du cluster entier. Pour plus d'informations, consultez la rubrique Hôtes principaux et gestion du cluster (mise en cache de Windows Server AppFabric). Les paramètres (alias) sont décrits ci-dessous : HostName (HostN) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache de l'hôte de cache. HostTimeout(T) : valeur de délai d'expiration en secondes pour le démarrage de l'hôte de cache spécifié. Exemple : Stop-CacheHost -HostName CacheServer1 -CachePort 22233
Get-CacheStatistics	Affiche les statistiques relatives à l'hôte de cache spécifié, notamment la taille totale (en octets), et le nombre d'objets mis en cache, de régions, de caches nommés, de demandes et d'absences dans le cache. Notes Pour plus d'informations sur l'utilisation de cette commande avec le paramètre CacheName, consultez le tableau suivant. Les paramètres (alias) sont décrits ci-dessous : HostName (H) : nom de l'hôte de cache. CachePort (P) : numéro de port de cache de l'hôte de cache. Exemple : Get-CacheStatistics -HostName CacheServer1 -CachePort 22233
Get-Cache	Répertorie les caches et régions qui résident dans l'hôte de cache spécifié. Les paramètres (alias) sont décrits ci-dessous : HostName (H) : nom de l'hôte de cache. CachePort (C) : numéro de port de cache de l'hôte de cache. Exemple : Get-Cache -HostName CacheServer1 -CachePort 22233
Get-CacheRegion	Renvoie la liste des régions dans le cluster de cache. Seul le client de cache peut créer ou supprimer des régions. Le cluster de cache identifie l'hôte de cache sur lequel elles résideront. Tous les paramètres sont facultatifs. Notes Pour plus d'informations sur l'utilisation de cette commande avec le paramètre CacheName, consultez le tableau suivant. Les paramètres (alias) sont décrits ci-dessous : MaxRegions : nombre maximal de régions à afficher. Cette commande ne peut pas être utilisée avec le paramètre MaxRegionsPerHost. MaxRegionsPerHost : nombre maximal de régions à afficher pour chaque hôte dans le cluster de cache. Exemple : Get-CacheRegion -MaxRegionsPerHost 4

Commandes liées au cache

Le tableau suivant répertorie les commandes pour l'exécution des opérations liées au cache dans Windows PowerShell.

Commande	Description
New-Cache	Crée un nouveau cache nommé lorsque le cluster est exécuté. Toutes les valeurs sont facultatives, à l'exception de CacheName. Notes Il peut y avoir jusqu'à 128 caches nommés. Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Secondaries (S) : la valeur 1 active la fonctionnalité de haute disponibilité, tandis que la valeur 0 la désactive. La valeur par défaut est 0. NotificationsEnabled (Notif) : la valeur True active la fonctionnalité de notifications de cache, tandis que la valeur False la désactive. Eviction (Evict) : la valeur LRU active l'éviction LRU (dernier récemment utilisé), tandis que la valeur None la désactive. La valeur par défaut est LRU. Avertissement La valeur None peut saturer la mémoire de l'hôte de cache. TimeToLive (T) : délai d'expiration par défaut des objets stockés dans le cache avant leur expiration, en minutes. La valeur par défaut est 10. Expirable : la valeur True active l'expiration, tandis que la valeur False la désactive. La valeur par défaut est True. Exemple : New-Cache -CacheName NamedCache1 -Secondaries 1 -TimeToLive 15
Remove-Cache	Supprime un cache nommé, comme spécifié par le paramètre CacheName. Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Exemple : Remove-Cache -CacheName NamedCache1
Get-CacheConfig	Renvoie les détails de configuration du cache nommé spécifié par le paramètre CacheName. Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Exemple : Get-CacheConfig -CacheName NamedCache1
Set-CacheConfig	Met à jour les paramètres de configuration du cache nommé, comme spécifié par le paramètre CacheName. Le cluster de cache peut être arrêté lorsque le paramètre CacheName est utilisé pour modifier le cache. Vous pouvez également utiliser les commandes Remove-Cache et New-Cache. Celles-ci permettent de modifier la configuration d'un cache nommé sans affecter les autres caches nommés dans le cluster par l'arrêt du cluster. Pour plus d’informations, consultez la rubrique Modification des paramètres de configuration du cache avec Windows PowerShell (mise en cache de Windows Server AppFabric). Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Secondaries (S) : la valeur 1 active la fonctionnalité de haute disponibilité, tandis que la valeur 0 la désactive. La valeur par défaut est 0. Notez que cette fonctionnalité est uniquement prise en charge pour les hôtes de cache exécutant les éditions Enterprise ou DataCenter de Windows Server. NotificationsEnabled (Notif) : la valeur True active la fonctionnalité de notifications de cache, tandis que la valeur False la désactive. Eviction (Evict) : la valeur LRU active l'éviction LRU (dernier récemment utilisé), tandis que la valeur None la désactive. La valeur par défaut est LRU. Avertissement La valeur None peut saturer la mémoire de l'hôte de cache. TimeToLive (T) : délai d'expiration par défaut des objets stockés dans le cache avant leur expiration, en minutes. La valeur par défaut est 10. Expirable : la valeur True active l'expiration, tandis que la valeur False la désactive. La valeur par défaut est True. Exemple : Set-CacheConfig -CacheName NamedCache1 -TimeToLive 30
Get-CacheStatistics	Renvoie les statistiques d'un cache nommé, comme spécifié par le paramètre CacheName. Notes Pour plus d'informations sur l'utilisation de cette commande avec les paramètres HostName et CachePort, consultez le tableau précédent. Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Exemple : Get-CacheStatistics -CacheName NamedCache1
Get-CacheRegion	Renvoie la liste des régions d'un cache nommé, comme spécifié par le paramètre CacheName. Seul le client de cache peut créer ou supprimer des régions. Le cluster de cache contrôle l'hôte de cache sur lequel les régions résident. Notes Pour plus d'informations sur l'utilisation de cette commande avec les paramètres HostName et CachePort, consultez le tableau précédent. Les paramètres (alias) sont décrits ci-dessous : CacheName (N) : nom du cache. Exemple : Get-CacheRegion -CacheName NamedCache1

Commandes de gestion de la console

Le tableau suivant répertorie les commandes pour l'exécution des opérations de gestion de l'outil d'administration du cache basé sur Windows PowerShell.

Commande	Description
Set-CacheLogging	Cette commande active la journalisation basée sur des fichiers pour la session de l'outil d'administration du cache basé sur Windows PowerShell. Le suivi des événements initié par cette commande ne dure que le temps de la session Windows PowerShell depuis laquelle il a été appelé. Par défaut, la journalisation est activée au niveau VERBOSE. Le fichier journal par défaut se trouve dans le répertoire%temp%. Son nom est constitué du préfixe DCacheAdministration, suivi de l'identificateur du processus et de l'horodatage de création. Si un fichier du même nom existe déjà, Windows PowerShell tente de l'ajouter au fichier journal. Les paramètres (alias) sont décrits ci-dessous : LogLevel (L) : niveau d'événement spécifiant les types d'événements capturés par le suivi. Les valeurs valides sont NONE, ERROR, WARNING, INFO et VERBOSE. File (F) : dossier ou chemin d'accès de fichier absolu dans lequel les journaux doivent être écrits. Si le nom du fichier n'est pas spécifié, il prend la valeur DCacheAdminTrace[<ProcessId>].log par défaut, où <ProcessId> correspond au numéro de l'ID de processus Windows de la session Windows PowerShell. ".log" est ajouté à tous les noms de fichier spécifiés. Cet exemple crée le fichier c:\WarningLog.log qui capture les messages d'avertissement et d'erreur : Set-CacheLogging -LogLevel WARNING -File c:\WarningLog Cette commande suit les événements de la seule session Windows PowerShell, et non du client de cache ou de l'hôte de cache.
Invoke-GC	Appelle manuellement le nettoyage de la mémoire sur le cluster de cache pour libérer la mémoire inutilisée. Cette commande est uniquement disponible dans certaines circonstances. En général, le nettoyage de la mémoire est géré par .NET Framework et les fonctionnalités de gestion de la mémoire du cluster de cache d'AppFabric.
Get-Help	Fournit des informations d'aide sur toutes les commandes prises en charge. Ce mot clé peut également être associé au caractère « * » pour filtrer les informations d'aide affichées, par exemple : Get-Help new* Get-Help Start* Get-Help *cache Get-Help *cachehost
exit	Ferme la session Windows PowerShell.
cls	Efface l'écran Windows PowerShell.

Voir aussi

Concepts

Configuration du cache à l'aide de Windows PowerShell (mise en cache de Windows Server AppFabric)
Paramètres de configuration (mise en cache de Windows Server AppFabric)
Options de configuration de la mise en cache de Windows Server AppFabric
Dépannage de la mise en cache de Windows Server AppFabric
Concepts relatifs à la mise en cache de Windows Server AppFabric
Développement d'un client de cache (mise en cache de Windows Server AppFabric)

  2011-12-05