see changelog for v0.5.0

Author: jdhitsolutions

PSRemoteOperations.psd1

@@ -8,7 +8,7 @@
 RootModule = 'PSRemoteOperations.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.4.0'
+ModuleVersion = '0.5.0'
 
 # Supported PSEditions
 CompatiblePSEditions = @("Desktop")

PSRemoteOperations.psm1

@@ -14,7 +14,7 @@ Function New-PSRemoteOperation {
             HelpMessage = "Enter the name of the computer where this command will execute.")]
         [Alias("CN")]
         [ValidateNotNullorEmpty()]
-        [string]$Computername,
+        [string[]]$Computername,
 
         [Parameter(
             Mandatory,
@@ -47,19 +47,42 @@ Function New-PSRemoteOperation {
 
     Write-Verbose "Starting $($MyInvocation.MyCommand)"
 
+    foreach ($Computer in $Computername) {
+        Write-Verbose "Creating a remote operations file for $($computer.toUpper())"
     #define a here string for the psd1 content
     $out = @"
 @{
 CreatedOn = '$($env:computername)'
 CreatedBy = '$($env:userdomain)\$($env:username)'
 CreatedAt = '$((Get-Date).toUniversalTime()) UTC'
-Computername = '$Computername'
+Computername = '$($Computer.ToUpper())'
 
 "@
 
     if ($ArgumentList) {
-        $args = "$($ArgumentList -join ",")"
-        $out += "ArgumentList = '$args'"
+        $outargs = @()
+        foreach ($a in $ArgumentList ) {
+            
+            Switch ($a.gettype().name) {
+                "Object[]" {
+                    $items = "'$($a -join "','")'"
+                    $thisarg = "@($items)"
+                }
+                "Boolean" {
+                    $thisarg = "`$$($a)"
+                }
+                "string" {
+                    $thisarg = "'$a'"
+                }
+                Default {
+                    $thisarg = $a
+                }
+            }
+            $outargs+=$thisarg
+        }
+
+        $opargs = $outargs -join ","
+        $out += "ArgumentList = $opargs"
         $out += "`n"
     }
 
@@ -81,15 +104,17 @@ Computername = '$Computername'
     $out | Write-Verbose
 
     #make the filename all lower case
-    $fname = "$($Computername)_$(New-GUID).psd1"
-    $outFile = Join-path -Path $Path -ChildPath $fname.toLower()
+    $fname = "$($Computer.ToUpper())_$(New-GUID).psd1"
+    $outFile = Join-path -Path $Path -ChildPath $fname #.toLower()
 
     Write-Verbose "Creating datafile $outfile"
 
-    $out | Out-File -FilePath $outFile -force
+    $out | Out-File -FilePath $outFile -force -Encoding ascii
     if ($Passthru) {
         Get-Item -path $outFile
     }
+    } #foreach computer
+
     Write-Verbose "Ending $($MyInvocation.MyCommand)"
 } #close New-PSRemoteOperation
 
@@ -145,8 +170,9 @@ Function Invoke-PSRemoteOperation {
         if ($in.Scriptblock) {
             $in.Scriptblock = [scriptblock]::Create($in.Scriptblock)
         }
+
         if ($in.ArgumentList) {
-            $in.ArgumentList = $in.ArgumentList -split ","
+            $in.ArgumentList = $in.ArgumentList # -split ","
         }
 
         #run the command
@@ -202,7 +228,7 @@ Function Invoke-PSRemoteOperation {
             $resultFile = Join-Path -Path $ArchivePath -ChildPath $filename
 
             Write-Verbose "Creating results file $resultFile"
-            $resultdata | Out-File -FilePath $resultFile
+            $resultdata | Out-File -FilePath $resultFile -Encoding ascii
 
             #delete
             Write-Verbose "Removing operation file $cPath"
@@ -249,7 +275,7 @@ Function Get-PSRemoteOperationResult {
         $data = $data | Select-object -First $Newest
     }
     foreach ($file in $data) {
-        write-verbose "Processing $($file.fullname)"
+        Write-Verbose "Processing $($file.fullname)"
         $hash = Import-PowerShellDataFile -Path $file.fullname
         $hash.Add("Path", $file.fullname)
         $obj = New-Object -typename psobject -Property $hash

README.md

@@ -11,4 +11,4 @@ Or check out the individual commands:
 + [New-PSRemoteOperation](docs/New-PSRemoteOperation.md)
 + [Register-PSRemoteOperationWatcher](docs/Register-PSRemoteOperationWatcher.md)
 
- *last updated 2 October 2018*
+ *last updated 4 October 2018*

changelog.md

@@ -1,5 +1,11 @@
 # Changelog for PSRemoteOperations
 
+## v0.5.0
+
++ Modified `-Computername` parameter on `New-PSRemoteOperation` to accept an array of names. (Issue #1)
++ Set file encoding of psd1 files to ASCII (Issue #4)
++ Fixed bug with arguments when one of them is an array. (Issue #5)
+
 ## v0.4.0
 
 + Added initialization script option to RemoteJob definition and execution

docs/New-PSRemoteOperation.md

@@ -16,14 +16,14 @@ Create a new remote operation file.
 ### scriptblock (Default)
 
 ```yaml
-New-PSRemoteOperation [-Computername] <String> -Scriptblock <ScriptBlock> [-ArgumentList <Object[]>]
+New-PSRemoteOperation [-Computername] <String[]> -Scriptblock <ScriptBlock> [-ArgumentList <Object[]>]
  [-Initialization <ScriptBlock>] [-Path <String>] [-Passthru] [<CommonParameters>]
 ```
 
 ### filepath
 
 ```yaml
-New-PSRemoteOperation [-Computername] <String> -ScriptPath <String> [-ArgumentList <Object[]>]
+New-PSRemoteOperation [-Computername] <String[]> -ScriptPath <String> [-ArgumentList <Object[]>]
  [-Initialization <ScriptBlock>] [-Path <String>] [-Passthru] [<CommonParameters>]
 ```
 
@@ -57,6 +57,29 @@ Mode                LastWriteTime         Length Name
 
 Repeat the previous example but create the file in a UNC path and pass the file object to the pipeline.
 
+### Example 3
+
+```powershell
+PS C:\> $computers = Get-Content computers.txt
+PS C:\> New-PSRemoteOperation -Computername $computers -Scriptblock {
+    if (-Not (Test-Path C:\Work)) {
+        mkdir c:\work
+    }
+    Copy-Item C:\Data\foo.dat -destination C:\work
+}
+```
+
+In this example, an array of computer names is taken from the text file. A PSRemoteOperation file will be created for each computer using the same scriptblock.
+
+### Example 4
+
+```powershell
+PS C:\> $sb = {param([string[]]$Names,[string]$Path,[boolean]$append) restart-service $names -force -PassThru | out-file $path -append:$append -encoding ascii
+}
+PS C:\> New-PSRemoteOperation -Computername SRV4 -Scriptblock $sb -ArgumentList @("spooler","bits"),"c:\work\svc.txt",$True
+
+```
+
 ## PARAMETERS
 
 ### -ArgumentList
@@ -77,10 +100,10 @@ Accept wildcard characters: False
 
 ### -Computername
 
-Enter the name of the computer where this command will execute.
+Enter the name or names of the computer where this command will execute.
 
 ```yaml
-Type: String
+Type: String[]
 Parameter Sets: (All)
 Aliases: CN
 
@@ -172,9 +195,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
-For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

docs/about_PSRemoteOperations.md

@@ -1,6 +1,6 @@
 # PSRemoteOperation
 
-## about_PSRemoteOperation
+## about_PSRemoteOperations
 
 ## SHORT DESCRIPTION
 
@@ -30,34 +30,56 @@ It is strongly recommended that you define two global variables in your
 PowerShell profile script. The commands in this module are designed to use the
 variables as default.
 
-$PSRemoteOpPath will be the path where the PSRemoteOperation files will be
+`$PSRemoteOpPath` will be the path where the PSRemoteOperation files will be
 created.
 
-$PSRemoteOpArchive will be the path where the archive files will be created.
-Typically this will be a subfolder of $PSRemoteOpPath.
+`$PSRemoteOpArchive` will be the path where the archive files will be created.
+Typically, this will be a sub-folder of `$PSRemoteOpPath`.
 
-    PS C:\> mkdir c:\users\jeff\dropbox\ops\archive
-    PS C:\> $PSRemoteOpPath = "c:\users\jeff\dropbox\ops\"
-    PS C:\> $PSRemoteOpArchive = "c:\users\jeff\dropbox\ops\archive"
+```powershell
+PS C:\> mkdir c:\users\jeff\dropbox\ops\archive
+PS C:\> $PSRemoteOpPath = "c:\users\jeff\dropbox\ops\"
+PS C:\> $PSRemoteOpArchive = "c:\users\jeff\dropbox\ops\archive"
+```
 
 ## EXAMPLES
 
 With these default variables, here's how you might use the commands in this
 module. First, you need to create an operation file.
 
-    PS C:\> New-PSRemoteOperation -Computername SRV1 -Scriptblock {restart-service spooler -force}
+```powershell
+PS C:\> New-PSRemoteOperation -Computername SRV1 -Scriptblock {restart-service spooler -force}
+```
 
 This will create a file using the naming convention <computername>_<uid>.psd1.
 It is assumed that the destination path, $PSRemoteOpPath, is being replicated
 in some way to the remote computer, SRV1.
 
+You can also create multiple remote operations file to run the same script or
+scriptblock.
+
+```powershell
+PS C:\> $computers = Get-Content computers.txt
+PS C:\> New-PSRemoteOperation -Computername $computers -Scriptblock {
+    if (-Not (Test-Path C:\Work)) {
+        mkdir c:\work
+    }
+    Copy-Item C:\Data\foo.dat -destination C:\work
+}
+```
+
+This will create multiple psd1 files with the same scriptblock but for each
+computer in the $Computers variable.
+
 The remote computer needs some means of monitoring the target folder and
 invoking the file when detected. You can use whatever means you want. You may
 want to setup a FileWatcher or WMI Event subscription. You may have 3rd party
 products you can use. However you monitor the folder, once you've identified a
 matching file, use Invoke-PSRemoteOperation to execute it.
 
-    PS C:\> Invoke-PSRemoteOperation $file -archivepath c:\archive
+```powershell
+PS C:\> Invoke-PSRemoteOperation $file -archivepath c:\archive
+```
 
 Once the operation is complete, the original file is deleted and an archive
 version is created in the archive path location. If you placed your archive
@@ -66,7 +88,8 @@ as a sub-directory, the results will "replicate" back to you.
 On your computer, you can use Get-PSRemoteOperationResult to get the results
 from one or more computers or operations.
 
-    PS C:\> Get-PSRemoteOperationResult -Computername SRV1 -Newest 1
+```powershell
+PS C:\> Get-PSRemoteOperationResult -Computername SRV1 -Newest 1
 
         Computername  : SRV1
         Date          : 10/02/2018 21:29:35 UTC
@@ -75,6 +98,7 @@ from one or more computers or operations.
         ArgumentsList :
         Completed     : True
         Error         :
+```
 
 In this example, the command is getting new last result for computer SRV1.
 
@@ -84,12 +108,14 @@ need to.
 The module includes a command to setup a default "watcher" using a PowerShell
 scheduled job.
 
-    PS C:\> Register-PSRemoteOperationWatcher
+```powershell
+PS C:\> Register-PSRemoteOperationWatcher
+```
 
 You will be prompted for your user credentials. This will create a scheduled
 job called RemoteOpWatcher that will check every 5 minutes for matching files
-in $PSRemoteOpPath and use $PSRemoteOpArchive for the archive path. Use the
-scheduled job cmdlets to modify or unregister. Note that the job won't start
+in `$PSRemoteOpPath` and use `$PSRemoteOpArchive` for the archive path. Use the
+scheduled job cmdlets to modify or un-register. Note that the job won't start
 for 2 minutes upon initial setup. But thereafter it will run indefinitely and
 survive reboots.
 

en-us/PSRemoteOperations-help.xml

@@ -326,11 +326,11 @@ PS C:\&gt; Invoke-PSRemoteOperation $file</dev:code>
         <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="CN">
           <maml:name>Computername</maml:name>
           <maml:Description>
-            <maml:para>Enter the name of the computer where this command will execute.</maml:para>
+            <maml:para>Enter the name or names of the computer where this command will execute.</maml:para>
           </maml:Description>
-          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
           <dev:type>
-            <maml:name>String</maml:name>
+            <maml:name>String[]</maml:name>
             <maml:uri />
           </dev:type>
           <dev:defaultValue>None</dev:defaultValue>
@@ -400,11 +400,11 @@ PS C:\&gt; Invoke-PSRemoteOperation $file</dev:code>
         <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="CN">
           <maml:name>Computername</maml:name>
           <maml:Description>
-            <maml:para>Enter the name of the computer where this command will execute.</maml:para>
+            <maml:para>Enter the name or names of the computer where this command will execute.</maml:para>
           </maml:Description>
-          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
           <dev:type>
-            <maml:name>String</maml:name>
+            <maml:name>String[]</maml:name>
             <maml:uri />
           </dev:type>
           <dev:defaultValue>None</dev:defaultValue>
@@ -486,11 +486,11 @@ PS C:\&gt; Invoke-PSRemoteOperation $file</dev:code>
       <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="CN">
         <maml:name>Computername</maml:name>
         <maml:Description>
-          <maml:para>Enter the name of the computer where this command will execute.</maml:para>
+          <maml:para>Enter the name or names of the computer where this command will execute.</maml:para>
         </maml:Description>
-        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
+        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
         <dev:type>
-          <maml:name>String</maml:name>
+          <maml:name>String[]</maml:name>
           <maml:uri />
         </dev:type>
         <dev:defaultValue>None</dev:defaultValue>
@@ -612,6 +612,28 @@ Mode                LastWriteTime         Length Name
           <maml:para>Repeat the previous example but create the file in a UNC path and pass the file object to the pipeline.</maml:para>
         </dev:remarks>
       </command:example>
+      <command:example>
+        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
+        <dev:code>PS C:\&gt; $computers = Get-Content computers.txt
+PS C:\&gt; New-PSRemoteOperation -Computername $computers -Scriptblock {
+    if (-Not (Test-Path C:\Work)) {
+        mkdir c:\work
+    }
+    Copy-Item C:\Data\foo.dat -destination C:\work
+}</dev:code>
+        <dev:remarks>
+          <maml:para>In this example, an array of computer names is taken from the text file. A PSRemoteOperation file will be created for each computer using the same scriptblock.</maml:para>
+        </dev:remarks>
+      </command:example>
+      <command:example>
+        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
+        <dev:code>PS C:\&gt; $sb = {param([string[]]$Names,[string]$Path,[boolean]$append) restart-service $names -force -PassThru | out-file $path -append:$append -encoding ascii
+}
+PS C:\&gt; New-PSRemoteOperation -Computername SRV4 -Scriptblock $sb -ArgumentList @("spooler","bits"),"c:\work\svc.txt",$True</dev:code>
+        <dev:remarks>
+          <maml:para></maml:para>
+        </dev:remarks>
+      </command:example>
     </command:examples>
     <command:relatedLinks>
       <maml:navigationLink>