patternshellMinor
Creating a script to automate implicit remoting
Viewed 0 times
scriptimplicitcreatingautomateremoting
Problem
Goal:
I am attempting to create a script that would automatically establish a PSSession to a Windows server for implicit remoting.
Problem:
Side notes:
A large number of users will use this script to establish PSSessions daily, I am trying to find the most efficient way to get all the users to access these modules - Amodule, Bmodule and Cmodule. Additionally, the script still works despite the above mentioned error.
Here is a sample of my script:
Question:
Is there a more effective way to structure/write this script given my goal and problem?
I am attempting to create a script that would automatically establish a PSSession to a Windows server for implicit remoting.
Problem:
Export-PSSession : Proxy creation has been skipped for the '%' command, because Windows PowerShell could not verify the safety of the command name.
At Z:Somewhere\aScript.ps1:12 char:3
+ Export-PSSession -Session $ServerPS -OutputModule 'First Module' - ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidData: (:) [Export-PSSession], InvalidOperationException
+ FullyQualifiedErrorId : ErrorSkippedUnsafeCommandName,Microsoft.PowerShell.Commands.ExportPSSessionCommandSide notes:
A large number of users will use this script to establish PSSessions daily, I am trying to find the most efficient way to get all the users to access these modules - Amodule, Bmodule and Cmodule. Additionally, the script still works despite the above mentioned error.
Here is a sample of my script:
$Server = New-PSSession -ComputerName ServerPS -Authentication Kerberos
Set-Alias -Name go -Value Get-CustomMods -Description 'Gets the modules'
function Get-CustomMods
{
# Import first module
Write-Verbose -Message 'Importing First module'
Invoke-command { import-module 'Amodule.ps1' } -session $ServerPS
Export-PSSession -Session $Server -OutputModule 'Amodule' -Force -AllowClobber
# Import second module
Write-Verbose -Message 'Importing Second Module'
Invoke-command { import-module 'Bmodule.ps1'} -session $ServerPS
Export-PSSession -Session $Server -OutputModule 'Bmodule' -Force -AllowClobber
# Import third module
Write-Verbose -Message 'Importing Third Module'
Invoke-command { import-module 'Cmodule.ps1' } -session $ServerPS
Export-PSSession -Session $Server -OutputModule 'Cmodule' -Force -AllowClobber
}Question:
Is there a more effective way to structure/write this script given my goal and problem?
Solution
I wish I had more to offer but I wanted to add some pointers about the code I do see.
Code Repetition
If you find yourself repeating the same code over and over again you should be asking if there is another way.
Another function
You could easily wrap the block
into its own function. That way if you need to make some changes they will be more centralized.
Splatting
Note that this is meant to be a simple example. Things like parameter typing might be advisable but were omitted for brevity. If functions are overkill for this little script of yours something else to consider would be splatting your parameters that are the same across cmdlet calls.
Variable Names
You follow the verb-noun convention for your functions which is good.
Your session variable name is a little misleading. You call it
Function Declaration
You are supposed to declare your functions before you use them. That being said, you would typically find functions at the beginning of scripts. While the order you have things declared will not be a problem (since it is working) I wanted to be sure that was understood.
If you were to call
Your Problem
Like I said I don't have much to offer here. I would like to point out that I think you scrubbed your code incorrectly since the code in your error does not match your code block.
Code Repetition
If you find yourself repeating the same code over and over again you should be asking if there is another way.
Another function
You could easily wrap the block
# Import first module
Write-Verbose -Message 'Importing First module'
Invoke-command { import-module 'Amodule.ps1' } -session $ServerPS
Export-PSSession -Session $Server -OutputModule 'Amodule' -Force -AllowClobberinto its own function. That way if you need to make some changes they will be more centralized.
function Export-SessionModule{
param(
$session,
$moduleName
)
# Import named module
Write-Verbose -Message "Importing $moduleName module"
Invoke-command { import-module "$moduleName.ps1" } -session $session
Export-PSSession -Session $session -OutputModule $moduleName -Force -AllowClobber
}Splatting
Note that this is meant to be a simple example. Things like parameter typing might be advisable but were omitted for brevity. If functions are overkill for this little script of yours something else to consider would be splatting your parameters that are the same across cmdlet calls.
$exportPSSessionParams = @{
Session = $session
Force = $true
AllowClobber = $true
}
# .....
Export-PSSession -OutputModule 'Amodule' @exportPSSessionParams
# .....
Export-PSSession -OutputModule 'Bmodule' @exportPSSessionParams
# .....
Export-PSSession -OutputModule 'Cmodule' @exportPSSessionParamsVariable Names
You follow the verb-noun convention for your functions which is good.
Your session variable name is a little misleading. You call it
$server. I usually see that representing a string with a server name. Since it is a session object it would be clearer if it was named as such. $session at a minimum or even $serverSession if you prefer. This could clash with your $sessionPS which is more reason to make them clear. Function Declaration
You are supposed to declare your functions before you use them. That being said, you would typically find functions at the beginning of scripts. While the order you have things declared will not be a problem (since it is working) I wanted to be sure that was understood.
If you were to call
go after your created the alias it would fail. Your Problem
Like I said I don't have much to offer here. I would like to point out that I think you scrubbed your code incorrectly since the code in your error does not match your code block.
- Have you checked on SO for that message already? There are a few different causes although I didn't find an exact match. Admittingly I do not work with modules much.
- I would debug this by seeing if it is the same module and if perhaps how it is being called is causing some problems. Perhaps being run more than once in a session? (AllowClobber should have fixed that though)
Code Snippets
# Import first module
Write-Verbose -Message 'Importing First module'
Invoke-command { import-module 'Amodule.ps1' } -session $ServerPS
Export-PSSession -Session $Server -OutputModule 'Amodule' -Force -AllowClobberfunction Export-SessionModule{
param(
$session,
$moduleName
)
# Import named module
Write-Verbose -Message "Importing $moduleName module"
Invoke-command { import-module "$moduleName.ps1" } -session $session
Export-PSSession -Session $session -OutputModule $moduleName -Force -AllowClobber
}$exportPSSessionParams = @{
Session = $session
Force = $true
AllowClobber = $true
}
# .....
Export-PSSession -OutputModule 'Amodule' @exportPSSessionParams
# .....
Export-PSSession -OutputModule 'Bmodule' @exportPSSessionParams
# .....
Export-PSSession -OutputModule 'Cmodule' @exportPSSessionParamsContext
StackExchange Code Review Q#152658, answer score: 3
Revisions (0)
No revisions yet.