Skip to content

Commit ec38dd9

Browse files
FriedrichWeinmannFriedrichWeinmann
committed
updates
1 parent e653d5d commit ec38dd9

File tree

3 files changed

+209
-4
lines changed

3 files changed

+209
-4
lines changed

‎PSFramework.NuGet/functions/Get/Install-PSFModule.ps1

+112-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,116 @@
11
function Install-PSFModule {
2+
<#
3+
.SYNOPSIS
4+
Installs PowerShell modules from a PowerShell repository.
5+
6+
.DESCRIPTION
7+
Installs PowerShell modules from a PowerShell repository.
8+
They can be installed locally or to remote computers.
9+
10+
.PARAMETER Name
11+
Name of the module to install.
12+
13+
.PARAMETER Version
14+
Version constrains for the module to install.
15+
Will use the latest version available within the limits.
16+
Examples:
17+
- "1.0.0": EXACTLY this one version
18+
- "1.0.0-1.999.999": Any version between the two limits (including the limit values)
19+
- "[1.0.0-2.0.0)": Any version greater or equal to 1.0.0 but less than 2.0.0
20+
- "2.3.0-": Any version greater or equal to 2.3.0.
21+
22+
Supported Syntax:
23+
<Prefix><Version><Connector><Version><Suffix>
24+
25+
Prefix: "[" (-ge) or "(" (-gt) or nothing (-ge)
26+
Version: A valid version of 2-4 elements or nothing
27+
Connector: A "," or a "-"
28+
Suffix: "]" (-le) or ")" (-lt) or nothing (-le)
29+
30+
.PARAMETER Prerelease
31+
Whether to include prerelease versions in the potential results.
32+
33+
.PARAMETER Scope
34+
Where to install the module to.
35+
Use Register-PSFModuleScope to add additional scopes to the list of options.
36+
Scopes can either use a static path or dynamic code to calculate - per computer - where to install the module.
37+
If not specified, it will default to:
38+
- CurrentUser - for local installation (irrespective of whether the console is run "As Administrator" or not.)
39+
- AllUsers - for remote installations when using the -ComputerName parameter.
40+
41+
.PARAMETER ComputerName
42+
The computers to deploy the modules to.
43+
Accepts both names or established PSRemoting sessions.
44+
All transfer happens via PowerShell Remoting.
45+
46+
If you provide names, by default this module will connect to the "Microsoft.PowerShell" configuration name.
47+
To change that name, use the 'PSFramework.NuGet.Remoting.DefaultConfiguration' configuration setting.
48+
49+
.PARAMETER SkipDependency
50+
Do not include any dependencies.
51+
Works with PowerShellGet V1/V2 as well.
52+
53+
.PARAMETER AuthenticodeCheck
54+
Whether modules must be correctly signed by a trusted source.
55+
Uses "Get-PSFModuleSignature" for validation.
56+
Defaults to: $false
57+
Default can be configured under the 'PSFramework.NuGet.Install.AuthenticodeSignature.Check' setting.
58+
59+
.PARAMETER Force
60+
Redeploy a module that already exists in the target path.
61+
By default it will skip modules that do already exist in the target path.
62+
63+
.PARAMETER Credential
64+
The credentials to use for connecting to the Repository (NOT the remote computers).
65+
66+
.PARAMETER RemotingCredential
67+
The credentials to use for connecting to remote computers we want to deploy modules to via remoting.
68+
These will NOT be used for repository access.
69+
70+
.PARAMETER ThrottleLimit
71+
Up to how many computers to deploy the modules to in parallel.
72+
Defaults to: 5
73+
Default can be configured under the 'PSFramework.NuGet.Remoting.Throttling' setting.
74+
75+
.PARAMETER Repository
76+
Repositories to install from. Respects the priority order of repositories.
77+
See Get-PSFRepository for available repositories (and their priority).
78+
Lower numbers are installed from first.
79+
80+
.PARAMETER TrustRepository
81+
Whether we should trust the repository installed from and NOT ask users for confirmation.
82+
83+
.PARAMETER Type
84+
What type of repository to download from.
85+
V2 uses classic Save-Module.
86+
V3 uses Save-PSResource.
87+
Availability depends on the installed PSGet module versions and configured repositories.
88+
Use Install-PSFPowerShellGet to deploy the latest versions of the package modules.
89+
90+
Only the version on the local computer matters, even when deploying to remote computers.
91+
92+
.PARAMETER InputObject
93+
The module to install.
94+
Takes the output of Get-Module, Find-Module, Find-PSResource and Find-PSFModule, to specify the exact version and name of the module.
95+
Even when providing a locally available version, the module will still be downloaded from the repositories chosen.
96+
97+
.EXAMPLE
98+
PS C:\> Install-PSFModule -Name EntraAuth
99+
100+
Installs the EntraAuth module locally for the CurrentUser.
101+
102+
.EXAMPLE
103+
PS C:\> Install-PSFModule -Name ADMF -ComputerName AdminHost1, AdminHost2
104+
105+
Installs the ADMF module (and all of its dependencies) for All Users on the computers AdminHost1 and AdminHost2
106+
107+
.EXAMPLE
108+
PS C:\> Install-PSFModule -Name string, PoshRSJob -ComputerName $sshSessions -Scope ScriptModules
109+
110+
Installs the String and PoshRSJob module to all computers with an established session in $sshSessions.
111+
The modules will be installed to the "ScriptModules" scope - something that must have first been registered
112+
using the Register-PSFModuleScope command.
113+
#>
2114
[CmdletBinding(PositionalBinding = $false, DefaultParameterSetName = 'ByName', SupportsShouldProcess = $true)]
3115
Param (
4116
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'ByName')]
@@ -57,8 +169,6 @@
57169
)
58170

59171
begin {
60-
throw "Not implemented yet!"
61-
62172
$killIt = $ErrorActionPreference -eq 'Stop'
63173
$cleanedUp = $false
64174

‎PSFramework.NuGet/internal/functions/Get/Resolve-ModuleScopePath.ps1

+95
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
function Resolve-ModuleScopePath {
22
[CmdletBinding()]
33
param (
4+
[AllowEmptyString()]
45
[string]
56
$Scope,
67

8+
[AllowNull()]
79
$ManagedSession,
810

911
[ValidateSet('All', 'Any', 'None')]
@@ -12,7 +14,100 @@
1214

1315
$Cmdlet
1416
)
17+
begin {
18+
#region Code
19+
$code = {
20+
param ($Data)
21+
22+
$result = [PSCustomObject]@{
23+
ComputerName = $env:COMPUTERNAME
24+
Scope = $Data.Name
25+
Path = $Data.Path
26+
Results = @()
27+
ExistsAll = $false
28+
ExistsAny = $false
29+
Success = $false
30+
Error = $null
31+
SessionID = $global:__PsfSessionId
32+
Session = $null
33+
}
34+
35+
#region Calculate Target paths
36+
$targetPaths = $Data.Path
37+
if ($Data.ScriptBlock) {
38+
$pathCalculator = [ScriptBlock]::Create($Data.ScriptBlock.ToString())
39+
if (Get-Module PSFramework) {
40+
try { $targetPaths = ([PsfScriptBlock]$pathCalculator).InvokeGlobal() }
41+
catch {
42+
$result.Error = $_
43+
return $result
44+
}
45+
}
46+
else {
47+
try {
48+
$targetPaths = & $pathCalculator
49+
}
50+
catch {
51+
$result.Error = $_
52+
return $result
53+
}
54+
}
55+
}
56+
#endregion Calculate Target paths
57+
58+
$pathResults = foreach ($path in $targetPaths) {
59+
if (-not $path) { continue }
60+
try {
61+
$resolvedPaths = Resolve-Path -Path $path -ErrorAction Stop
62+
}
63+
catch {
64+
[PSCustomObject]@{
65+
ComputerName = $env:COMPUTERNAME
66+
Path = $path
67+
Exists = $false
68+
}
69+
continue
70+
}
71+
foreach ($resolvedPath in $resolvedPaths) {
72+
[PSCustomObject]@{
73+
ComputerName = $env:COMPUTERNAME
74+
Path = $resolvedPath
75+
Exists = $true
76+
}
77+
}
78+
}
79+
80+
$result.Results = $pathResults
81+
$result.ExistsAll = @($pathResults).Where{ -not $_.Exists }.Count -lt 1
82+
$result.ExistsAny = @($pathResults).Where{ $_.Exists }.Count -gt 0
83+
84+
if ($Data.PathHandling -eq 'All') { $result.Success = $result.ExistsAll }
85+
else { $result.Success = $result.ExistsAny }
86+
87+
if (-not $result.Success) {
88+
$message = "[$env:COMPUTERNAME] Path not found: $(@($pathResults).Where{ -not $_.Exists }.ForEach{ "'$($_.Path)'" } -join ', ')"
89+
$result.Error = [System.Management.Automation.ErrorRecord]::new(
90+
[System.Exception]::new($message),
91+
'PathNotFound',
92+
[System.Management.Automation.ErrorCategory]::ObjectNotFound,
93+
@(@($pathResults).Where{ -not $_.Exists }.ForEach{ "'$($_.Path)'" })
94+
)
95+
}
96+
97+
$result
98+
}
99+
#endregion Code
100+
101+
if (-not $Scope) {
102+
$Scope = 'AllUsers'
103+
if (-not $ManagedSession) { $Scope = 'CurrentUser' }
104+
}
105+
}
15106
process {
16107
throw "Not Implemented Yet!"
108+
109+
110+
111+
17112
}
18113
}

‎PSFramework.NuGet/internal/functions/Get/Resolve-RemotePath.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
$code = {
9292
param ($Data)
9393

94-
$pathResults = foreach ($path in $Data.Paths) {
94+
$pathResults = foreach ($path in $Data.Path) {
9595
try {
9696
$resolvedPaths = Resolve-Path -Path $path -ErrorAction Stop
9797
}
@@ -141,7 +141,7 @@
141141
#endregion Implementing Code
142142

143143
# Passing a single array-argument as a hashtable is more reliable
144-
$data = @{ Paths = $Path; PathHandling = $PathHandling }
144+
$data = @{ Path = $Path; PathHandling = $PathHandling }
145145
}
146146
process {
147147
#region Collect Test-Results

0 commit comments

Comments
 (0)