Partager via

Set-SCVirtualCOMPort

  • Référence
Module:
VirtualMachineManager

Modifie les propriétés d’un port COM virtuel pour une machine virtuelle, un modèle de machine virtuelle ou un profil matériel.

Syntaxe

Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -VMHostCOMPort <Byte>
   [-WaitForModem <Boolean>]
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -TextFile <String>
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   [-NoAttach]
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -NamedPipe <String>
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -TextFile <String>
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   [-NoAttach]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -VMHostCOMPort <Byte>
   [-WaitForModem <Boolean>]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -NamedPipe <String>
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

L’applet de commande set-SCVirtualCOMPort modifie une ou plusieurs propriétés d’un port COM (Virtual Communications). Un port COM virtuel fait partie d’une machine virtuelle, d’un modèle de machine virtuelle ou d’un profil matériel utilisé dans un environnement Virtual Machine Manager (VMM). Spécifiez un port COM à l’aide du paramètre VirtualCOMPort ou spécifiez un ID de port COM virtuel pour le paramètre GuestPort. Les valeurs valides pour GuestPort sont zéro (0) et une (1).

Cette applet de commande peut connecter un port COM virtuel à un port COM physique, à un fichier texte ou à un canal nommé. Cette applet de commande peut déconnecter un port COM virtuel. Si vous connectez un port COM virtuel sur une machine virtuelle à un port COM physique sur son hôte, la machine virtuelle peut utiliser le port COM physique pour l’entrée et la sortie. Les types d’hôtes prennent en charge les types de connexion de port COM virtuels suivants :

  • Hyper-V. Se connecte à un canal nommé uniquement.
  • VMware ESX. Se connecte à un port COM physique, un fichier texte ou un canal nommé.
  • Citrix XenServer. Non pris en charge.

Le paramètre WaitForModem spécifie si un port COM virtuel sur une machine virtuelle se connecte immédiatement à un port COM physique sur l’hôte au démarrage de la machine virtuelle.

Si vous spécifiez une valeur de $True pour WaitForModem, la machine virtuelle tente de se connecter au port COM physique sur l’hôte uniquement si un programme qui s’exécute sur la machine virtuelle envoie une commande modem au port COM physique. Si le port COM sur l’hôte est déjà connecté, la machine virtuelle ne peut pas se connecter à celle-ci. Si la machine virtuelle se connecte correctement au port COM physique, la machine virtuelle libère ultérieurement le port COM physique vers le système d’exploitation hôte si le programme sur la machine virtuelle qui utilise le port COM s’arrête à l’aide du port COM.

Si vous spécifiez une valeur de $False pour WaitForModem, la machine virtuelle tente de se connecter au port COM physique sur l’hôte dès que la machine virtuelle démarre. Si le port COM sur l’hôte est déjà capturé, la machine virtuelle ne peut pas se connecter à celle-ci. Il s’agit du même comportement que pour une valeur de $True. Si la machine virtuelle se connecte correctement au port COM physique, la machine virtuelle ne libère pas le port COM physique vers le système d’exploitation hôte tant que la machine virtuelle n’est pas arrêtée.

Exemples

Exemple 1 : Connecter un port COM virtuel à un canal nommé

PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $COM1 = Get-SCVirtualCOMPort -VM $VM | where {$_.Name -eq "COM1"}
PS C:\> Set-SCVirtualCOMPort -VirtualCOMPort $COM1 -NamedPipe "\\Contoso\Pipe\PipeName"

La première commande obtient la machine virtuelle nommée VM02, puis stocke cet objet dans la variable $VM.

La deuxième commande obtient le port COM virtuel nommé COM1 à partir de VM02, puis stocke cet objet dans la variable $COM 1.

La dernière commande connecte le port COM virtuel dans $COM 1 au canal nommé \Contoso\Pipe\PipeName.

Exemple 2 : Déconnecter un port COM virtuel

PS C:\> $VM = Get-SCVirtualMachine -Name "VM04"
PS C:\> $COM1 = Get-SCVirtualCOMPort -VM $VM | where {$_.Name -eq "COM1"}
PS C:\> Set-SCVirtualCOMPort -VirtualCOMPort $COM1 -NoAttach

La première commande obtient la machine virtuelle nommée VM04, puis stocke cet objet dans la variable $VM.

La deuxième commande obtient le port COM virtuel sur VM04 nommé COM1, puis stocke cet objet dans la variable $COM 1.

La dernière commande spécifie le paramètre NoAttach. Cela entraîne la déconnexion du port COM virtuel dans $COM 1. Vous pouvez utiliser cette commande pour déconnecter un port COM virtuel actuellement connecté à un port COM physique sur un hôte, à un canal nommé ou à un fichier texte.

Paramètres

-GuestPort

Spécifie l’ID d’un port COM virtuel sur une machine virtuelle. Les valeurs valides sont : 0 et 1.

Type:Byte
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-JobGroup

Spécifie un identificateur pour une série de commandes qui s’exécute en tant que jeu juste avant la commande finale qui inclut le même identificateur de groupe de travaux.

Type:Guid
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-JobVariable

Spécifie une variable dans laquelle la progression du travail est suivie et stockée.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NamedPipe

Spécifie un canal nommé vers lequel un port COM virtuel se connecte. Les utilisations classiques incluent la connexion d’une machine virtuelle à un programme de débogage sur l’hôte. Vous pouvez également créer un câble de modem Null virtuel entre deux machines virtuelles. Spécifiez un canal au format suivant : \.\ComputerName\Pipe\PipeName

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NoAttach

Indique que cette applet de commande spécifie qu’aucun port COM physique sur un hôte, un canal nommé ou un fichier se connecte à un port COM virtuel. Si vous spécifiez ce paramètre, l’applet de commande déconnecte un port COM virtuel déjà connecté à un port COM physique, à un canal nommé ou à un fichier texte.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PROTipID

Spécifie l’ID de l’info-bulle d’optimisation des performances et des ressources (PRO) qui a déclenché cette action. Cela permet d’auditer les conseils PRO.

Type:Guid
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RunAsynchronously

Indique que le travail s’exécute de façon asynchrone afin que le contrôle retourne immédiatement à l’interpréteur de commandes.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TextFile

Spécifie un fichier texte sur l’hôte auquel le port COM virtuel se connecte. La machine virtuelle envoie la sortie du port COM virtuel le fichier texte spécifié par ce paramètre. Le fichier texte peut se trouver sur n’importe quel lecteur de disque valide sur l’hôte.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-VirtualCOMPort

Spécifie un objet de port COM virtuel que cette applet de commande modifie. VMM prend en charge la configuration de deux ports COM sur une machine virtuelle, un modèle ou un profil matériel.

Type:VirtualCOMPort
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-VMHostCOMPort

Spécifie un objet de port COM physique sur un serveur hôte auquel la machine virtuelle peut connecter un port COM virtuel.

Type:Byte
Alias:HostPort
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-VMMServer

Spécifie un serveur VMM.

Type:ServerConnection
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WaitForModem

Indique si un port COM virtuel sur une machine virtuelle se connecte immédiatement à un port COM physique sur l’hôte au démarrage de la machine virtuelle.

Si vous spécifiez une valeur de $True, le port COM virtuel attend de se connecter à un port COM physique sur l’hôte. Si vous spécifiez une valeur de $False, le port COM virtuel se connecte immédiatement à un port COM physique sur l’hôte dès que la machine virtuelle démarre.

Type:Boolean
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Sorties

VirtualCOMPort

Cette applet de commande retourne un objet VirtualCOMPort.

Notes

  • Nécessite un objet de port COM virtuel VMM. Vous pouvez récupérer cet objet à l’aide de l’applet de commande get-SCVirtualCOMPort .