N-central Help

Modify Serial COM Port

Configures the COM port of a virtual machine.

Input Parameters

Name Type Required Description
VM Name String Yes Specifies the name of the virtual machine for which the COM port is to be configured.
COM Port Selector Yes Specifies the COM port to be configured.
COM Port Path String No Specifies a named pipe path for the COM port to be configured. Specify local pipes as “\\.\pipe\PipeName” and remote pipes as "\\RemoteServer\pipe\PipeName".

Output Parameters

Name Type Description
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
VM Name String Yes Guest001
COM Port String No 1
COM Port Path String Yes

\\.\pipe\PipeName

\\RemoteServer\pipe\PipeName