Update receive-fogimage and test choco publish (#31)

* Fix some typos in descriptions and add step in Remove-ModuleManually to remove the parent install folder if no other versions exist.

* Update README.md

markdown fixes and spell checking

* Add error handling if a module path doesn't exist for choco package install template

* Should resolve Add pipeline and task options to Receive-FogImage #29

---------

Co-authored-by: geotsot <[email protected]>
 - publish build for 2411.9.17

FogApi/FogApi.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: JJ Fullmer, FOG Project
 #
-# Generated on: 9/23/2024
+# Generated on: 11/17/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'FogApi.psm1'
 
 # Version number of this module.
-ModuleVersion = '2409.9.16'
+ModuleVersion = '2411.9.17'
 
 # Supported PSEditions
 CompatiblePSEditions = 'Desktop', 'Core'
@@ -177,47 +177,23 @@ PrivateData = @{
 
         # ReleaseNotes of this module
         ReleaseNotes = '
-# 2409.9.16
+# 2411.9.17
 
-	add publishing chocolatey package to release flow (#22)
+	Update receive-fogimage and test choco publish (#31)
 
-* Updated docs to be more unified in their appearance where information is purposely duplicated.
+* Fix some typos in descriptions and add step in Remove-ModuleManually to remove the parent install folder if no other versions exist.
 
-* Added icon to module files and included staically.io cdn version of icon in manifest. Unified the manifest description with the Readme as the manifest description is  used in choco package description.
-Want to be sure any new user gets the same information now matter how they find the module.
+* Update README.md
 
-* Added chocolatey packaging that includes the psgetmoduleinfo.xml to install the module in an alternative method outside of psget and psresourceget while maintaining compatibility with psget and psresourceget.
-Also reordered some functions in the build script and made other various improvements to the build process.
+markdown fixes and spell checking
 
-* Added comment in the set-fogserversettings function help and a warning when running in linux about paste issues that sometimes occur when running set-fogserversettings -interactive.
+* Add error handling if a module path doesn''t exist for choco package install template
 
-* Updated and unified various docs, added icon packaging with best practicies for chocolatey and psgallery. Updated chocolatey packaging and build functions. Updated docs for set-fogserversettings.md and added psresourceget methods to invoke-modulebuild for test builds to use the same methodology as prod builds
+* Should resolve Add pipeline and task options to Receive-FogImage #29
 
-* use ''-'' instead of ''*'' in markdown formats
+---------
 
-* verbage fix and add forums link
-
-* unify the overview docs
-
-* Fix choco template issue of typo of folder name sources vs files
-
-* Shortened the manifest and nuspec description
-
-* Update files section of nuspec to properly include the module files
-
-* Added gpu properties to get-foginventory for upcoming add of gpu info to fog inventory records and fixed missing functions in in get-winbcdpxeid
-
-* Added nuspec and psgetmodule info templates
-
-* Updates to release note formatting, manifest description format, and build script improvements
-
-* Updated Send-FogImage with params for 1.6 and added switch options and autocomplete for available fog images. Also added a basic Set-FogHostImage function, needs to be further flushes out but the basic functionality is there.
-
-* Filter out rdp display driver when getting host inventory details and append video memory in GB to each adapter name
-
-* revert change of appending gpu ram as it doesn''t work for all gpus equally
-
-* Update tag-and-release.yml - Comment out the choco community publish, will continue to have the choco nupkg attached to the release until the first version is approved.
+Co-authored-by: geotsot <[email protected]>
 
 
 Full change log history available at https://fogapi.readthedocs.io/en/latest/ReleaseNotes/'

docs/ReleaseNotes.md

@@ -2,6 +2,26 @@
 
 ## 9.x
 
+### 2411.9.17
+
+	Update receive-fogimage and test choco publish (#31)
+
+* Fix some typos in descriptions and add step in Remove-ModuleManually to remove the parent install folder if no other versions exist.
+
+* Update README.md
+
+markdown fixes and spell checking
+
+* Add error handling if a module path doesn't exist for choco package install template
+
+* Should resolve Add pipeline and task options to Receive-FogImage #29
+
+---------
+
+Co-authored-by: geotsot <[email protected]>
+
+see https://fogapi.readthedocs.io/en/latest/ReleaseNotes/ for full historical change log
+
 ### 2409.9.16
 
 	add publishing chocolatey package to release flow (#22)
@@ -487,5 +507,6 @@ see https://fogapi.readthedocs.io/en/latest/ReleaseNotes/ for full historical ch
 
 
 
+
 
 

docs/commands/Receive-FogImage.md

@@ -14,16 +14,28 @@ Starts or schedules a capture task on a given host
 
 ### now (Default)
 ```
-Receive-FogImage [-hostId <Object>] [-fogHost <Object>] [-ProgressAction <ActionPreference>]
+Receive-FogImage [-hostId <Object>] [-debugMode] [-NoWol] [-shutdown] [-ProgressAction <ActionPreference>]
  [<CommonParameters>]
 ```
 
 ### schedule
 ```
-Receive-FogImage [-hostId <Object>] [-fogHost <Object>] [-StartAtTime <DateTime>]
+Receive-FogImage [-hostId <Object>] [-StartAtTime <DateTime>] [-debugMode] [-NoWol] [-shutdown]
  [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
+### schedule-byhost
+```
+Receive-FogImage [-fogHost <Object>] [-StartAtTime <DateTime>] [-debugMode] [-NoWol] [-shutdown]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### now-byhost
+```
+Receive-FogImage [-fogHost <Object>] [-debugMode] [-NoWol] [-shutdown] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
+```
+
 ## DESCRIPTION
 Starts a capture task to receive a new version of an image in fog
 
@@ -52,14 +64,21 @@ Using another alias for this command, will schedule a capture task for the host
 i.e.
 if today was friday, this would schedule it for sunday at 8pm.
 
+### EXAMPLE 4
+```
+Get-FogHost | Receive-FogImage -debugMode -shutdown
+```
+
+Capture an image from the current host right now in debug mode, shutdown the computer after complete
+
 ## PARAMETERS
 
 ### -hostId
 The id of the host to capture from
 
 ```yaml
 Type: Object
-Parameter Sets: (All)
+Parameter Sets: now, schedule
 Aliases:
 
 Required: False
@@ -70,11 +89,11 @@ Accept wildcard characters: False
 ```
 
 ### -fogHost
-{{ Fill fogHost Description }}
+fogHost object (get-foghost) that can be brought in from pipeline
 
 ```yaml
 Type: Object
-Parameter Sets: (All)
+Parameter Sets: schedule-byhost, now-byhost
 Aliases:
 
 Required: False
@@ -89,7 +108,7 @@ When to start to capture, if not given will start now
 
 ```yaml
 Type: DateTime
-Parameter Sets: schedule
+Parameter Sets: schedule, schedule-byhost
 Aliases:
 
 Required: False
@@ -99,6 +118,51 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -debugMode
+Switch param to mark the task as a debug task
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -NoWol
+Switch param to not use wake on lan in the task, default is to use wake on lan
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -shutdown
+Switch param to indicate the host should shutdown at the end of the task instead of restarting.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ProgressAction
 {{ Fill ProgressAction Description }}