HelpCache/Microsoft.PowerShell.PackageManagement.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Updatable Help Version 5.0.1.0 --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-Package</command:name> <maml:description> <maml:para>Finds software packages in available package sources.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>Package</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Finds matching software packages that are available in package sources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-Package</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>If you add this parameter, Find-Package returns all available versions of the package, or all versions of the package that are in the range specified by the MinimumVersion and MaximumVersion parameters. By default, Find-Package returns the newest available version.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to search for packages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Find-Package, this means the Force parameter acts the same as the ForceBootstrap parameter. For example, running the command Find-Package -Name chrome -Provider Chocolatey –Force, on a computer that does not already have the Chocolatey provider installed, installs the Chocolatey provider.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>If you add this parameter, the search scope is expanded to include packages on which the specified package depends.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of a specified package that you want returned in your command results. By default, without this or the MinimumVersion parameters, Find-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of a specified package that you want returned in your command results. By default, without this or the MaximumVersion parameters, Find-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package providers. Separate multiple provider names with commas. You can get a list of package providers that are connected to OneGet by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to find. By default, without this parameter, Find-Package returns the newest available version. You cannot add this parameter to a command that includes either or both of the MinimumVersion or MaximumVersion parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. You can get a list of available package sources by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>If you add this parameter, Find-Package returns all available versions of the package, or all versions of the package that are in the range specified by the MinimumVersion and MaximumVersion parameters. By default, Find-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to search for packages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Find-Package, this means the Force parameter acts the same as the ForceBootstrap parameter. For example, running the command Find-Package -Name chrome -Provider Chocolatey –Force, on a computer that does not already have the Chocolatey provider installed, installs the Chocolatey provider.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>If you add this parameter, the search scope is expanded to include packages on which the specified package depends.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of a specified package that you want returned in your command results. By default, without this or the MinimumVersion parameters, Find-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of a specified package that you want returned in your command results. By default, without this or the MaximumVersion parameters, Find-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package providers. Separate multiple provider names with commas. You can get a list of package providers that are connected to OneGet by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to find. By default, without this parameter, Find-Package returns the newest available version. You cannot add this parameter to a command that includes either or both of the MinimumVersion or MaximumVersion parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. You can get a list of available package sources by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SoftwareIdentify[]</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Find all available packages from a package provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package –Provider PSModule </dev:code> <dev:remarks> <maml:para>This command finds all available Windows PowerShell module packages from galleries that are registered with the PSModule provider.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Find a package from a provider that is not yet installed</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package Git –Provider Chocolatey </dev:code> <dev:remarks> <maml:para>This command first bootstraps (or automatically installs) the Chocolatey provider on the local computer, then searches for the Git package within that provider.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Find a package from a package source</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package Git –Source ChocolateyRepository </dev:code> <dev:remarks> <maml:para>This command finds a package from a specified package source. This is a useful command if you know the name of the package source that you want to search, but are unsure about the package provider to which the source is registered. Without specifying a package source, Find-Package searches through all installed package providers and their package sources for a specified package. You can run Get-PackageSource -Location to get a package source name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Find a package from a file system</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package C:\temp </dev:code> <dev:remarks> <maml:para>This command finds packages from all installed OneGet package providers that are stored in the C:\temp folder on the local computer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Find a package with a specific name and version</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package –Name DSCAccel –RequiredVersion 2.1.2 </dev:code> <dev:remarks> <maml:para>This command finds version 2.1.2 of a package named “DSCAccelerator”. Although only part of the package name has been specified, Find-Package should be able to find the DSCAccelerator package if there are no other packages with a name matching that pattern.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Find packages within a range of versions</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package –Name DSCAccelerator –MinimumVersion 1.5.0 –MaximumVersion 2.1 –AllVersions </dev:code> <dev:remarks> <maml:para>This command finds a matching range of versions of a package named “DSCAccelerator”, by adding the MinimumVersion and MaximumVersion parameters to specify a range, and the AllVersions parameter to specify that all matching results within that range are returned as results.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517132</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-Package</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Package</command:name> <maml:description> <maml:para>Returns a list of all software packages that have been installed by using OneGet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Package</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-Package returns a list of all software packages on the local computer that have been installed by using OneGet. You can run Get-Package on remote computers by running it as part of an Invoke-Command or Enter-PSSession command or script.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Package</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-Package, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of a specified package that you want returned in your command results. By default, without this or the MinimumVersion parameters, Get-Package returns the newest available version of a specified package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of a specified package that you want returned in your command results. By default, without this or the MaximumVersion parameters, Get-Package returns the newest available version of a specified package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package providers. Separate multiple provider names with commas. You can get a list of package providers that are connected to OneGet by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to get. By default, without this parameter, Get-Package returns the newest available version. You cannot add this parameter to a command that includes either or both of the MinimumVersion or MaximumVersion parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-Package, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of a specified package that you want returned in your command results. By default, without this or the MinimumVersion parameters, Get-Package returns the newest available version of a specified package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of a specified package that you want returned in your command results. By default, without this or the MaximumVersion parameters, Get-Package returns the newest available version of a specified package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package providers. Separate multiple provider names with commas. You can get a list of package providers that are connected to OneGet by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to get. By default, without this parameter, Get-Package returns the newest available version. You cannot add this parameter to a command that includes either or both of the MinimumVersion or MaximumVersion parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SoftwareIdentity[]</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all installed packages</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Package </dev:code> <dev:remarks> <maml:para>This command gets all packages that are installed on the local computer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get packages that are installed on a remote computer</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Invoke-Command -ComputerName server01 -Credential CONTOSO\TestUser -ScriptBlock {Get-Package} </dev:code> <dev:remarks> <maml:para>This example gets a list of packages that were installed on a remote computer, server01, by using OneGet. When you run this command, you are prompted to provide credentials for the user CONTOSO\TestUser.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get packages for a specified provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Package –Provider ARP </dev:code> <dev:remarks> <maml:para>This command gets Add or Remove Programs software packages from the local computer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get an exact version of a specific package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Package –Name DSCAccel –RequiredVersion 2.1.2 </dev:code> <dev:remarks> <maml:para>This command gets version 2.1.2 of a package named “DSCAccelerator”. Although only part of the package name has been specified, Get-Package should be able to find the DSCAccelerator package if there are no other packages with a name matching that pattern.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Uninstall a package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Package –Name DSCAccelerator –RequiredVersion 2.1 | Uninstall-Package </dev:code> <dev:remarks> <maml:para>This command pipes the results of a Get-Package command to the Uninstall-Package cmdlet. In this example, you are uninstalling only version 2.1 of the DSCAccelerator package. You are prompted to confirm that you want to uninstall the package.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517135</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-Package</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PackageProvider</command:name> <maml:description> <maml:para>Returns a list of package providers that are connected to OneGet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PackageProvider</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-PackageProvider returns a list of package providers--such as PSModule, NuGet, and Chocolatey--that are connected to OneGet. You can filter the results based on all or part of one or more provider names.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PackageProvider</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more provider names, or partial provider names. Separate multiple provider names with commas. Valid values for this parameter include names of providers that you have installed with packages; OneGet ships with a set of default providers, including the PSModule and MSI providers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-PackageProvider, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-PackageProvider, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more provider names, or partial provider names. Separate multiple provider names with commas. Valid values for this parameter include names of providers that you have installed with packages; OneGet ships with a set of default providers, including the PSModule and MSI providers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PackageProvider[]</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all available package providers</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-PackageProvider </dev:code> <dev:remarks> <maml:para>This example gets a list of all package providers that are available on the local computer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Dynamically get a package provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-PackageProvider –Name Chocolatey -ForceBootstrap </dev:code> <dev:remarks> <maml:para>If your computer does not have the Chocolatey provider installed, this command bootstraps—or automatically installs—the Chocolatey provider.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517136</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PackageSource</command:name> <maml:description> <maml:para>Gets a list of package sources that are registered for a package provider.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PackageSource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-PackageSource gets a list of package sources that are registered with OneGet on the local computer. If you specify a package provider, Get-PackageSource gets only those sources that are associated with the specified provider. Otherwise, the command returns all package sources that are registered with OneGet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PackageSource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the friendly name of a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-PackageSource, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for a specified source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more provider names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces all other actions with this cmdlet that can be forced. In Get-PackageSource, this means the Force parameter acts the same as the ForceBootstrap parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for a specified source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the friendly name of a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more provider names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PackageSource[]</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all package sources</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-PackageSource </dev:code> <dev:remarks> <maml:para>This example gets all package sources that are registered with OneGet on the local computer.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all package sources for a specific provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-PackageSource –ProviderName PSModule </dev:code> <dev:remarks> <maml:para>This example gets all package sources that are registered for the PSModule provider.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all package sources for a specific provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-PackageProvider PSModule | Get-PackageSource </dev:code> <dev:remarks> <maml:para>This example is a variation on Example 2. This command gets all package sources for the PSModule provider by piping the results of a Get-PackageProvider cmdlet to Get-PackageSource.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517137</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-Package</command:name> <maml:description> <maml:para>Installs one or more software packages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>Package</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Installs one or more software packages on the local computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-Package</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to install a package for a specified package provider or source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides restrictions that prevent the command from succeeding, as long as the changes do not compromise security.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the maximum allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest (that is, highest-numbered) available version of the package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the minimum allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package provider names to which to scope your package search. You can get package provider names by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. Multiple package source names must be separated by commas. You can get package source names by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-Package</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package by using the package’s SoftwareIdentity type, which is shown in the results of the Find-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareIdentity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to install a package for a specified package provider or source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides restrictions that prevent the command from succeeding, as long as the changes do not compromise security.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to install a package for a specified package provider or source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides restrictions that prevent the command from succeeding, as long as the changes do not compromise security.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package by using the package’s SoftwareIdentity type, which is shown in the results of the Find-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareIdentity[]</command:parameterValue> <dev:type> <maml:name>SoftwareIdentity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the maximum allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest (that is, highest-numbered) available version of the package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the minimum allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package provider names to which to scope your package search. You can get package provider names by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact allowed version of the package that you want to install. If you do not add this parameter, Install-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. Multiple package source names must be separated by commas. You can get package source names by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SoftwareIdentity[]</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Install a package by package name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Install-Package –Name DSCAccelerator –Credential CONTOSO\TestUser </dev:code> <dev:remarks> <maml:para>This command installs a package named DSCAccelerator. When you run this command, you are prompted to provide a password for the account that has rights to install the package.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Install a package that you find with Find-Package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package zoomit | Install-Package </dev:code> <dev:remarks> <maml:para>This command installs a package named zoomit by piping the package from a Find-Package command.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Install packages by specifying a range of versions</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Install-Package –Name DSCAccel –MinimumVersion 2.1.2 –MaximumVersion 2.2 </dev:code> <dev:remarks> <maml:para>This command installs any package that has a name matching the partial name “DSCAccel.” The command installs the newest version of the package, within a range of versions that is specified by adding the MinimumVersion and MaximumVersion parameters.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517138</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-Package</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-PackageSource</command:name> <maml:description> <maml:para>Adds a package source for a specified package provider.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>PackageSource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Register-PackageSource adds a package source for a specified package provider. Package sources are always managed by a package provider. If the package provider cannot add or replace a package source, the provider generates an error message.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-PackageSource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name for the package source that you want to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format that is supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to register a package source for a specified package provider. Specify a user name, such as "User01", or "Domain\User01", or specify a PSCredential object, such as one generated by the Get-Credential cmdlet. The simplest way to specify a PSCredential object is to save the results of a Get-Credential cmdlet as a variable. When you add this parameter and specify a user name, you are prompted to provide a password after you run the command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the user confirmation prompt. Without this parameter, Register-PackageSource prompts you to confirm that you want to replace an existing source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Trusted</maml:name> <maml:description> <maml:para>Indicates whether users trust packages from this source; that is, indicates whether users are prompted to verify that they trust the package source before they install a package from it. If you add this parameter, users are not prompted.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies the provider name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to register a package source for a specified package provider. Specify a user name, such as "User01", or "Domain\User01", or specify a PSCredential object, such as one generated by the Get-Credential cmdlet. The simplest way to specify a PSCredential object is to save the results of a Get-Credential cmdlet as a variable. When you add this parameter and specify a user name, you are prompted to provide a password after you run the command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the user confirmation prompt. Without this parameter, Register-PackageSource prompts you to confirm that you want to replace an existing source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format that is supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name for the package source that you want to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies the provider name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Trusted</maml:name> <maml:description> <maml:para>Indicates whether users trust packages from this source; that is, indicates whether users are prompted to verify that they trust the package source before they install a package from it. If you add this parameter, users are not prompted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Register a package source for the NuGet provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Register-PackageSource -Name 'myRep' -Location 'http://contoso/psmodule/Features/api/v3' –ProviderName 'psModule' </dev:code> <dev:remarks> <maml:para>This example registers a package source, a web-based location for the PSModule provider. If you do not add the Trusted parameter, by default, the package is not trusted, and users are prompted to confirm that they trust the source before installing packages from the source.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517139</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-Package</command:name> <maml:description> <maml:para>Saves packages to the local computer without installing them.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>Package</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Save-Package saves packages to the local computer without installing them. Save-Package saves the newest version of a package unless you add the AllVersions parameter. The DestinationPath and LiteralPath parameters are mutually-exclusive, and cannot both be added to the same command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-Package</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to save a package from a specified package provider or source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the path to which you want to save the package. You cannot add both this parameter and the LiteralPath parameter to the same command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides restrictions that prevent the command from succeeding, as long as running the command does not compromise security.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>If you add this parameter, the search scope is expanded to include packages on which the specified package depends.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the literal path to which you want to save the package. You cannot add both this parameter and the DestinationPath parameter to the same command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of the package to be saved. If you do not add this parameter, Save-Package saves the newest version of the package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of the package to be saved. If you do not add this parameter, the newest available version of the package (subject to the maximum specified version, if any) is saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more provider names. Separate multiple provider names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to find. By default, without this parameter, Save-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. You can get a list of available package sources by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A software ID object that represents the package that you want to save. Software IDs are part of the results of the Find-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SoftwareIdentity</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to save a package from a specified package provider or source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the path to which you want to save the package. You cannot add both this parameter and the LiteralPath parameter to the same command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides restrictions that prevent the command from succeeding, as long as running the command does not compromise security.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>If you add this parameter, the search scope is expanded to include packages on which the specified package depends.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A software ID object that represents the package that you want to save. Software IDs are part of the results of the Find-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SoftwareIdentity</command:parameterValue> <dev:type> <maml:name>SoftwareIdentity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the literal path to which you want to save the package. You cannot add both this parameter and the DestinationPath parameter to the same command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the highest-numbered version of the package to be saved. If you do not add this parameter, Save-Package saves the newest version of the package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the lowest-numbered version of the package to be saved. If you do not add this parameter, the newest available version of the package (subject to the maximum specified version, if any) is saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names, or partial package names. Separate multiple package names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more provider names. Separate multiple provider names with commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact version of the package that you want to find. By default, without this parameter, Save-Package returns the newest available version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies one or more package sources. You can get a list of available package sources by running the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Save a package to the local computer</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Save-Package –Name 'DSCAccelerator' –DestinationPath 'C:\Users\TestUser\Downloads' </dev:code> <dev:remarks> <maml:para>This example saves the newest version of a package, DSCAccelerator, to the C:\Users\TestUser\Downloads folder.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Save an exact version of a package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Save-Package –Name 'DSCAccelerator' –RequiredVersion 2.1.2 –DestinationPath 'C:\Users\TestUser\Downloads' </dev:code> <dev:remarks> <maml:para>This example saves only version 2.1.2 of a package, DSCAccelerator, to the C:\Users\TestUser\Downloads folder.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Save a package by piping results of Find-Package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Find-Package –Name DSCAccel –RequiredVersion 2.1.2 | Save-Package –DestinationPath 'C:\Users\TestUser\Downloads' </dev:code> <dev:remarks> <maml:para>This command saves a package named DSCAccelerator by first locating the exact package with the Find-Package cmdlet, then piping the results of Find-Package to the Save-Package cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Save a package to a local folder, then install the package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Save-Package notepad2 –DestinationPath C:\temp PS C:\>Install-Package C:\temp\notepad2.4.2.25.3.nupkg </dev:code> <dev:remarks> <maml:para>The first command saves a package to C:\temp, a folder on the local computer. The second command installs the saved package from the C:\temp folder, instead of installing from the web.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517140</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-Package</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PackageSource</command:name> <maml:description> <maml:para>Replaces a package source for a specified package provider.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PackageSource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-PackageSource replaces a package source for a specified package provider. Package sources are always managed by a package provider.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PackageSource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="SourceName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the current friendly name of a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. Without this parameter, Set-PackageSource prompts you to confirm that you want to change an existing source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source currently points. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewLocation</maml:name> <maml:description> <maml:para>The new location to which you want a package source to point. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new friendly name that you want to assign to a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Trusted</maml:name> <maml:description> <maml:para>Indicates whether users trust packages from this source; that is, indicates whether users are prompted to verify that they trust the package source before they install a package from it. If you add this parameter, users are not prompted.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ProviderName"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifes the name of the package source’s provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PackageSource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. Without this parameter, Set-PackageSource prompts you to confirm that you want to change an existing source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewLocation</maml:name> <maml:description> <maml:para>The new location to which you want a package source to point. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new friendly name that you want to assign to a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Trusted</maml:name> <maml:description> <maml:para>Indicates whether users trust packages from this source; that is, indicates whether users are prompted to verify that they trust the package source before they install a package from it. If you add this parameter, users are not prompted.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A package source ID object that represents the package that you want to change. Package source IDs are part of the results of the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PackageSource</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. Without this parameter, Set-PackageSource prompts you to confirm that you want to change an existing source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A package source ID object that represents the package that you want to change. Package source IDs are part of the results of the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PackageSource</command:parameterValue> <dev:type> <maml:name>PackageSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source currently points. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="SourceName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the current friendly name of a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewLocation</maml:name> <maml:description> <maml:para>The new location to which you want a package source to point. The value of this parameter can be a URI, a file path, or any other destination format supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new friendly name that you want to assign to a package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ProviderName"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifes the name of the package source’s provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Trusted</maml:name> <maml:description> <maml:para>Indicates whether users trust packages from this source; that is, indicates whether users are prompted to verify that they trust the package source before they install a package from it. If you add this parameter, users are not prompted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Change a package source</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-PackageSource -Name psRep –NewName 'ps-Feature-Rep' –Trusted –ProviderName PSModule </dev:code> <dev:remarks> <maml:para>This example changes the friendly name of a package source for the PSModule provider. It also changes the package source to be trusted, so that users who install packages from this source are not prompted to verify that they trust the source.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517141</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Uninstall-Package</command:name> <maml:description> <maml:para>Uninstalls one or more software packages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>Package</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Uninstall-Package uninstalls one or more software packages from the local computer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-Package</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package by using the package’s SoftwareIdentity type, which is shown in the results of the Get-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareIdentity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces uninstallation of a package without prompting you to confirm.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Uninstall-Package</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces uninstallation of a package without prompting you to confirm.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the maximum allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package uninstalls the newest (that is, highest-numbered) available version of the package on the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the minimum allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package uninstalls the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package provider names to which to scope your package search. You can get package provider names by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces uninstallation of a package without prompting you to confirm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package by using the package’s SoftwareIdentity type, which is shown in the results of the Get-Package cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareIdentity[]</command:parameterValue> <dev:type> <maml:name>SoftwareIdentity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaximumVersion</maml:name> <maml:description> <maml:para>Specifies the maximum allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package uninstalls the newest (that is, highest-numbered) available version of the package on the computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Version"> <maml:name>MinimumVersion</maml:name> <maml:description> <maml:para>Specifies the minimum allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package uninstalls the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more package names. Multiple names must be separated by commas.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Provider"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specifies one or more package provider names to which to scope your package search. You can get package provider names by running the Get-PackageProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para>Specifies the exact allowed version of the package that you want to uninstall. If you do not add this parameter, Uninstall-Package installs the newest available version of the package (subject to any maximum specified version, if you’ve added the MaximumVersion parameter).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Uninstall a package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Uninstall-Package –Name DSCAccelerator </dev:code> <dev:remarks> <maml:para>This command uninstalls a package named DSCAccelerator.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Uninstall a package by piping results of Get-Package</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-Package –Name DSCAccel –RequiredVersion 2.1.2 | Uninstall-Package -Force </dev:code> <dev:remarks> <maml:para>This command uninstalls a package named DSCAccelerator by first locating the exact package with the Get-Package cmdlet, then piping the results of Get-Package to the Uninstall-Package cmdlet. The Force parameter ensures that you are not prompted to confirm that you want to uninstall the package.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517142</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Package</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-Package</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-PackageSource</command:name> <maml:description> <maml:para>Removes a registered package source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>PackageSource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Unregister-PackageSource removes a registered package source. Package sources are always managed by a package provider.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-PackageSource</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to unregister a package source for a specified package provider. Specify a user name, such as "User01", or "Domain\User01", or specify a PSCredential object, such as one generated by the Get-Credential cmdlet. The simplest way to specify a PSCredential object is to save the results of a Get-Credential cmdlet as a variable. When you add this parameter and specify a user name, you are prompted to provide a password after you run the command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the unregistration without prompting you to confirm.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package source by using the package source’s object, which is shown in the results of the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PackageSource[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Unregister-PackageSource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="Name"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the friendly name of the package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to unregister a package source for a specified package provider. Specify a user name, such as "User01", or "Domain\User01", or specify a PSCredential object, such as one generated by the Get-Credential cmdlet. The simplest way to specify a PSCredential object is to save the results of a Get-Credential cmdlet as a variable. When you add this parameter and specify a user name, you are prompted to provide a password after you run the command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the unregistration without prompting you to confirm.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format that is supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ProviderName"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the provider name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has rights to unregister a package source for a specified package provider. Specify a user name, such as "User01", or "Domain\User01", or specify a PSCredential object, such as one generated by the Get-Credential cmdlet. The simplest way to specify a PSCredential object is to save the results of a Get-Credential cmdlet as a variable. When you add this parameter and specify a user name, you are prompted to provide a password after you run the command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the unregistration without prompting you to confirm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceBootstrap</maml:name> <maml:description> <maml:para>Forces OneGet to bootstrap—or automatically install—the package provider for the specified package source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a package source by using the package source’s object, which is shown in the results of the Get-PackageSource cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PackageSource[]</command:parameterValue> <dev:type> <maml:name>PackageSource[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format that is supported by the package provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ProviderName"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the provider name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="Name"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the friendly name of the package source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Unregister a package source for the NuGet provider</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Unregister-PackageSource -Source 'myRep' -Location 'http://contoso/nuget/MyRepository/api/v3' –Provider 'nuget' </dev:code> <dev:remarks> <maml:para>This example unregisters a package source named Features for the NuGet provider. Because the Force parameter isn’t added, you are prompted to confirm that you want to unregister the package.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Unregister a package source by piping a PackageSource object</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$a = Get-PackageSource –Name 'myRep' –Location 'http://contoso/nuget/Features/api/v3' PS C:\>Unregister-PackageSource –InputObject $a -Force </dev:code> <dev:remarks> <maml:para>This example unregisters a package source named Features for the NuGet provider by saving the results of a Get-PackageSource command to a variable, and then using the variable as input to Unregister-PackageSource. The Force parameter ensures that you are not prompted to confirm that you want to unregister the package.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=517143</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PackageSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |