将当前会话中管理单元的名称导出到一个控制台文件。

语法

Export-Console [[-Path] <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]

说明

Export-Console cmdlet 将当前会话中 Windows PowerShell 管理单元的名称导出到一个 Windows PowerShell 控制台文件 (.psc1) 中。可以使用此 cmdlet 保存管理单元以便用在将来的会话中。

若要将 .psc1 控制台文件中的管理单元添加到一个会话中,请通过使用 Cmd.exe 或其他 Windows PowerShell 会话,在命令行启动 Windows PowerShell (Powershell.exe),然后使用 Powershell.exe 的 PSConsoleFile 参数指定该控制台文件。

有关 Windows PowerShell 管理单元的详细信息,请参阅 about_PSSnapins。

参数

-Force

在不提示的情况下覆盖控制台文件中的数据,即使该文件具有只读属性也是如此。命令完成后,只读属性将更改并且不会重置。

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-NoClobber

不覆盖现有控制台文件或替换该文件的内容。默认情况下,如果指定的路径中已有文件,则 Export-Console 将覆盖该文件,而不会发出警告。

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-Path <string>

指定控制台文件 (*.psc1) 的路径和文件名。输入路径(可选)和名称。不允许使用通配符。

如果只键入文件名,Export-Console 将在当前目录中创建一个具有该名称和“.psc1”文件扩展名的文件。

除非已使用 PSConsoleFile 参数打开了 Windows PowerShell 或在当前会话期间导出了控制台文件,否则此参数是必需的。在使用 NoClobber 参数防止当前控制台文件被覆盖时也会用到此参数。

如果省略此参数,则 Export-Console 将覆盖或替换最近在此会话中使用的控制台文件的内容。最近使用的控制台文件的路径存储在 $ConsoleFileName 自动变量的值中。有关详细信息,请参阅 about_Automatic_Variables。

是否为必需?

false

位置?

1

默认值

是否接受管道输入?

true (ByValue, ByPropertyName)

是否接受通配符?

false

-Confirm

在执行命令之前提示您进行确认。

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-WhatIf

描述如果执行该命令会发生什么情况(无需实际执行该命令)。

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

<CommonParameters>

此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

System.String

可以通过管道将路径字符串传递给 Export-Console。

输出

System.IO.FileInfo

Export-Console 创建一个包含导出的别名的文件。

说明

使用控制台文件 (.psc1) 启动会话时,控制台文件的名称自动存储在 $ConsoleFileName 自动变量中。当使用 Export-Console 的 Path 参数指定一个新的控制台文件时,$ConsoleFileName 的值也会相应地更新。如果没有使用控制台文件,$ConsoleFileName 将没有值 ($null)。

若要在新会话中使用 Windows PowerShell 控制台文件,请使用以下语法启动 Windows PowerShell:

“powershell.exe -PsConsoleFile <ConsoleFile>.psc1”。

还可以将 Add-PSSnapin 命令添加到 Windows PowerShell 配置文件中,从而保存 Windows PowerShell 管理单元以供将来的会话使用。有关详细信息,请参阅 about_Profiles。

示例 1

C:\PS>export-console -path $pshome\Consoles\ConsoleS1.psc1

说明
-----------
此命令将当前会话中 Windows PowerShell 管理单元的名称导出到 Windows PowerShell 安装目录 $pshome 的 Consoles 子目录内的 ConsoleS1.psc1 文件中。






示例 2

C:\PS>export-console

说明
-----------
此命令将当前会话中 Windows PowerShell 管理单元的名称导出到最近在当前会话中使用的 Windows PowerShell 控制台文件中。此命令会覆盖先前的文件内容。

如果在当前会话期间尚未导出过控制台文件,则系统将提示您需要相应权限才能继续操作,然后提示您输入文件名。






示例 3

C:\PS>add-pssnapin NewPSSnapin

C:\PS> export-console -path NewPSSnapinConsole.psc1

C:\PS> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1

说明
-----------
这些命令会将 NewPSSnapin Windows PowerShell 管理单元添加到当前会话,将当前会话中 Windows PowerShell 管理单元的名称导出到一个控制台文件,然后使用该控制台文件启动 Windows PowerShell 会话。

第一条命令使用 Add-PSSnapin cmdlet 将 NewPSSnapin 管理单元添加到当前会话。只能添加已在系统中注册的 Windows PowerShell 管理单元。

第二条命令将 Windows PowerShell 管理单元名称导出到 NewPSSnapinConsole.psc1 文件中。

第三条命令使用 NewPSSnapinConsole.psc1 文件启动 Windows PowerShell。因为该控制台文件包含 Windows PowerShell 管理单元名称,所以该管理单元中的 cmdlet 和提供程序在当前会话中可用。






示例 4

C:\PS>export-console -path Console01

C:\PS> notepad console01.psc1

<?xml version="1.0" encoding="utf-8"?>
<PSConsoleFile ConsoleSchemaVersion="1.0">
  <PSVersion>2.0</PSVersion>
  <PSSnapIns>
    <PSSnapIn Name="NewPSSnapin" />
  </PSSnapIns>
</PSConsoleFile>

说明
-----------
此命令将当前会话中的 Windows PowerShell 管理单元的名称导出到当前目录下的 Console01.psc1 文件中。

第二条命令使用记事本显示 Console01.psc1 文件的内容。






示例 5

C:\PS>powershell.exe -PSConsoleFile Console01.psc1

C:\PS> add-pssnapin MySnapin

C:\PS> export-console NewConsole.psc1

C:\PS> $consolefilename

C:\PS> add-pssnapin SnapIn03

C:\PS> export-console

说明
-----------
此示例说明在使用不带 Path 参数值的 Export-Console 的情况下,如何使用 $ConsoleFileName 自动变量来确定将更新的控制台文件。

第一条命令使用 PowerShell.exe 的 PSConsoleFile 参数来打开具有 Console01.psc1 文件的 Windows PowerShell。

第二条命令使用 Add-PSSnapin cmdlet 将 MySnapin Windows PowerShell 管理单元添加到当前会话中。

第三条命令使用 Export-Console cmdlet 将会话中所有 Windows PowerShell 管理单元的名称导出到 NewConsole.psc1 文件中。

第四条命令使用 $ConsoleFileName 参数来显示最近使用的控制台文件。示例输出显示 NewConsole.ps1 是最近使用的文件。

第五条命令将 SnapIn03 添加到当前控制台中。

第六条命令使用不带 Path 参数的 ExportConsole cmdlet。此命令将当前会话中所有 Windows PowerShell 管理单元的名称导出到最近使用的文件 NewConsole.psc1 中。






另请参阅




目录