From 585b3b00bbc5c8b534cef99c190737301c0b0b8d Mon Sep 17 00:00:00 2001 From: JJ Fullmer Date: Sun, 18 Aug 2024 09:04:14 -0600 Subject: [PATCH] 10-add-get-fogversion (#14) Created Get-FogVersion and implmented check for 1.6 version so correct dynamic parameters are used for 1.5.x vs 1.6 Also added a separate build test script for running a build test on each push. * Add get-fogversion #10 - Updated dynamic params to be contextual to the version * doc updates * Cleaned up a couple things * Added separate build script for use with testing builds on each push * Increment version, update release notes * trailing slash for import test * try psscript root * try importing with manifest * fix build test script path syntax * fix test for if module imported * don't error when testing import, wait for check for loaded module * Add built test badge to show if current master branch is passing build test --- .github/workflows/build-test.yml | 37 + .github/workflows/build-test.yml.notready | 34 - .gitignore | 1 + FogApi/FogApi.psd1 | 20 +- FogApi/Private/Get-DynmicParam.ps1 | 36 +- FogApi/Public/Find-FogObject.ps1 | 8 +- FogApi/Public/Get-FogInventory.ps1 | 78 +- FogApi/Public/Set-FogInventory.ps1 | 8 +- README.md | 2 + build.ps1 | 4 +- docs/ReleaseNotes.md | 12 + docs/commands/Add-FogHostMac.md | 17 +- docs/commands/Add-FogResultData.md | 17 +- docs/commands/Approve-FogPendingMac.md | 17 +- docs/commands/Deny-FogPendingMac.md | 17 +- docs/commands/Find-FogObject.md | 18 +- docs/commands/Get-FogActiveTasks.md | 17 +- docs/commands/Get-FogGroupAssociations.md | 17 +- docs/commands/Get-FogGroupByName.md | 17 +- docs/commands/Get-FogGroups.md | 17 +- docs/commands/Get-FogHost.md | 22 +- docs/commands/Get-FogHostAssociatedSnapins.md | 17 +- docs/commands/Get-FogHostGroup.md | 17 +- docs/commands/Get-FogHostMacs.md | 19 +- docs/commands/Get-FogHostPendingMacs.md | 17 +- docs/commands/Get-FogHosts.md | 17 +- docs/commands/Get-FogImages.md | 17 +- docs/commands/Get-FogInventory.md | 17 +- docs/commands/Get-FogLog.md | 17 +- docs/commands/Get-FogMacAddresses.md | 17 +- docs/commands/Get-FogModules.md | 17 +- docs/commands/Get-FogObject.md | 18 +- docs/commands/Get-FogServerSettings.md | 17 +- docs/commands/Get-FogServerSettingsFile.md | 17 +- docs/commands/Get-FogSnapinAssociations.md | 17 +- docs/commands/Get-FogSnapins.md | 17 +- docs/commands/Get-FogVersion.md | 58 + docs/commands/Get-LastImageTime.md | 21 +- docs/commands/Install-FogService.md | 17 +- docs/commands/Invoke-FogApi.md | 18 +- docs/commands/New-FogHost.md | 20 +- docs/commands/New-FogObject.md | 18 +- docs/commands/Receive-FogImage.md | 20 +- docs/commands/Remove-FogObject.md | 18 +- docs/commands/Remove-UsbMac.md | 18 +- docs/commands/Repair-FogSnapinAssociations.md | 17 +- docs/commands/Reset-HostEncryption.md | 18 +- docs/commands/Resolve-HostID.md | 17 +- docs/commands/Send-FogImage.md | 20 +- docs/commands/Send-FogWolTask.md | 105 ++ docs/commands/Set-FogInventory.md | 18 +- docs/commands/Set-FogServerSettings.md | 19 +- .../Set-FogServerSettingsFileSecurity.md | 18 +- docs/commands/Set-FogSnapins.md | 18 +- docs/commands/Start-FogSnapin.md | 21 +- docs/commands/Start-FogSnapins.md | 18 +- docs/commands/Update-FogObject.md | 17 +- docs/commands/index.md | 93 -- docs/en-us/FogApi-help.xml | 1392 ++++++++++++++++- invoke-modulebuild.ps1 | 123 ++ 60 files changed, 2529 insertions(+), 267 deletions(-) create mode 100644 .github/workflows/build-test.yml delete mode 100644 .github/workflows/build-test.yml.notready create mode 100644 docs/commands/Get-FogVersion.md create mode 100644 docs/commands/Send-FogWolTask.md delete mode 100644 docs/commands/index.md create mode 100644 invoke-modulebuild.ps1 diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml new file mode 100644 index 0000000..2ea1bdc --- /dev/null +++ b/.github/workflows/build-test.yml @@ -0,0 +1,37 @@ +name: Test Build + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + build: + runs-on: windows-latest + + steps: + - uses: actions/checkout@v4 + + - name: Run build script + run: | + # Install-PSResource -Name PlatyPS -TrustRepository -Version 0.14.2 -Scope CurrentUser -AcceptLicense + $moduleName="FogApi"; + .\invoke-modulebuild.ps1 + $builtPath = ".\_module_build\$moduleName" + ls -recurse $builtPath; + if (Test-Modulemanifest -path "$builtPath\$moduleName.psd1") { + import-module "$builtPath\" -ea 0 + if ($null -ne (Get-module $modulename -ea 0)) { + "Built module imported successfully!`n$((Get-module $modulename) | out-string)" | out-host + return $true; + } else { + Write-Error "Failed to import module!" + return $false; + } + } else { + Write-Error "Manifest threw error" + return $false; + } \ No newline at end of file diff --git a/.github/workflows/build-test.yml.notready b/.github/workflows/build-test.yml.notready deleted file mode 100644 index c66e3d6..0000000 --- a/.github/workflows/build-test.yml.notready +++ /dev/null @@ -1,34 +0,0 @@ -# Need to modularize the build steps so that documentation related steps can be run separately from the build steps as well as the incremeneting of the version number. -name: Test Build - -on: - push: - branches: - - master - pull_request: - branches: - - master - -jobs: - build: - runs-on: windows-latest - - steps: - - uses: actions/checkout@v4 - - - name: Run build script - run: | - Install-PSResource -Name PlatyPS -TrustRepository -Version 0.14.2 -Scope CurrentUser -AcceptLicense - .\build.ps1 - if (Test-Modulemanifest -path "$Home\ModuleBuild\$moduleName\$moduleName.psd1") { - if (import-module "$Home\ModuleBuild\$moduleName") { - "Built module imported successfully!" - return $true; - } else { - Write-Error "Failed to import module!" - return $false; - } - } else { - Write-Error "Manifest threw error" - return $false; - } \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9a1abec..a2c82f3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ _build +_module_build .lastprereqrun diff --git a/FogApi/FogApi.psd1 b/FogApi/FogApi.psd1 index a48c099..8da9f25 100644 --- a/FogApi/FogApi.psd1 +++ b/FogApi/FogApi.psd1 @@ -3,7 +3,7 @@ # # Generated by: JJ Fullmer # -# Generated on: 11/17/2023 +# Generated on: 8/18/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'FogApi.psm1' # Version number of this module. -ModuleVersion = '2311.6.4' +ModuleVersion = '2408.6.9' # Supported PSEditions # CompatiblePSEditions = @() @@ -130,10 +130,11 @@ FunctionsToExport = 'Add-FogHostMac', 'Add-FogResultData', 'Approve-FogPendingMa 'Get-FogMacAddresses', 'Get-FogModules', 'Get-FogObject', 'Get-FogSecsSinceEpoch', 'Get-FogServerSettings', 'Get-FogServerSettingsFile', 'Get-FogSnapinAssociations', - 'Get-FogSnapins', 'Get-LastImageTime', 'Install-FogService', - 'Invoke-FogApi', 'New-FogHost', 'New-FogObject', 'Receive-FogImage', - 'Remove-FogObject', 'Remove-UsbMac', 'Repair-FogSnapinAssociations', - 'Reset-HostEncryption', 'Resolve-HostID', 'Send-FogImage', + 'Get-FogSnapins', 'Get-FogVersion', 'Get-LastImageTime', + 'Install-FogService', 'Invoke-FogApi', 'New-FogHost', 'New-FogObject', + 'Receive-FogImage', 'Remove-FogObject', 'Remove-UsbMac', + 'Repair-FogSnapinAssociations', 'Reset-HostEncryption', + 'Resolve-HostID', 'Send-FogImage', 'Send-FogWolTask', 'Set-FogInventory', 'Set-FogServerSettings', 'Set-FogServerSettingsFileSecurity', 'Set-FogSnapins', 'Start-FogSnapin', 'Start-FogSnapins', 'Update-FogObject' @@ -182,9 +183,12 @@ PrivateData = @{ # ReleaseNotes of this module ReleaseNotes = ' -# 2311.6.4 +# 2408.6.9 - typo bug fix there was a stray extra character. Also added switch for Set-FogSnapins called -repairBeforeAdd to allow running the repair before attempting to add. Also added in more try catch logic to set-fogsnapins. Also cleaned up release notes in manifest to just include the latest release to allow for faster import of module' + Created Get-FogVersion and implmented check for 1.6 version + so correct dynamic parameters are used for 1.5.x vs 1.6 + Also added a separate build test script for running a build test + on each push.' # Prerelease string of this module # Prerelease = '' diff --git a/FogApi/Private/Get-DynmicParam.ps1 b/FogApi/Private/Get-DynmicParam.ps1 index 349c107..5c58d93 100644 --- a/FogApi/Private/Get-DynmicParam.ps1 +++ b/FogApi/Private/Get-DynmicParam.ps1 @@ -32,17 +32,31 @@ the position to put the dynamic parameter in $attributeCollection.Add($attributes) - $coreObjects = @( - "clientupdater", "dircleaner", "greenfog", "group", "groupassociation", - "history", "hookevent", "host", "hostautologout", "hostscreensetting", "image", - "imageassociation", "imagepartitiontype", "imagetype", "imaginglog", "inventory", "ipxe", - "keysequence", "macaddressassociation", "module", "moduleassociation", "multicastsession", - "multicastsessionassociation", "nodefailure", "notifyevent", "os", "oui", "plugin", - "powermanagement", "printer", "printerassociation", "pxemenuoptions", "scheduledtask", - "service", "setting", "snapin", "snapinassociation", "snapingroupassociation", "snapinjob", - "snapintask", "storagegroup", "storagenode", "task", "tasklog", "taskstate", "tasktype", - "unisearch", "user", "usercleanup", "usertracking", "virus" - ); + if ((Get-FogVersion) -like '1.6*') { + $coreObjects = @( + "group", "groupassociation", "history", "hookevent", "host", "hostautologout", + "hostscreensetting", "image", "imageassociation", "imagepartitiontype", "imagetype", + "imaginglog", "inventory", "ipxe", "keysequence", "macaddressassociation", "module", + "moduleassociation", "multicastsession", "multicastsessionassociation", "nodefailure", + "notifyevent", "os", "oui", "plugin", "powermanagement", "printer", "printerassociation", + "pxemenuoptions", "scheduledtask", "setting", "snapin", "snapinassociation", + "snapingroupassociation", "snapinjob", "snapintask", "storagegroup", "storagenode", "task", + "tasklog", "taskstate", "tasktype", "unisearch", "user", "usertracking", "setting", "user" + ); + } else { + $coreObjects = @( + "clientupdater", "dircleaner", "greenfog", "group", "groupassociation", + "history", "hookevent", "host", "hostautologout", "hostscreensetting", "image", + "imageassociation", "imagepartitiontype", "imagetype", "imaginglog", "inventory", "ipxe", + "keysequence", "macaddressassociation", "module", "moduleassociation", "multicastsession", + "multicastsessionassociation", "nodefailure", "notifyevent", "os", "oui", "plugin", + "powermanagement", "printer", "printerassociation", "pxemenuoptions", "scheduledtask", + "service", "setting", "snapin", "snapinassociation", "snapingroupassociation", "snapinjob", + "snapintask", "storagegroup", "storagenode", "task", "tasklog", "taskstate", "tasktype", + "unisearch", "user", "usercleanup", "usertracking", "virus" + ); + } + $coreTaskObjects = @("group", "host", "multicastsession", "scheduledtask", "snapinjob", "snapintask", "task"); $coreActiveTaskObjects = @("multicastsession", "powermanagement", "scheduledtask", "snapinjob", "snapintask", "task"); } diff --git a/FogApi/Public/Find-FogObject.ps1 b/FogApi/Public/Find-FogObject.ps1 index 15c4889..7f735cd 100644 --- a/FogApi/Public/Find-FogObject.ps1 +++ b/FogApi/Public/Find-FogObject.ps1 @@ -49,7 +49,7 @@ function Find-FogObject { DynamicParam { $paramDict = Set-DynamicParams $type; return $paramDict;} - begin { + process { $paramDict | ForEach-Object { New-Variable -Name $_.Keys -Value $($_.Values.Value);} # $paramDict; Write-Verbose "Building uri and api call for $($paramDict.keys) $($paramDict.values.value)"; @@ -67,13 +67,7 @@ function Find-FogObject { uriPath=$uri; Method="GET"; } - } - - process { $result = Invoke-FogApi @apiInvoke; - } - - end { #convert the output to use the data property added in fog 1.6 if ($coreObject -ne "unisearch") { $result = Add-FogResultData $result; diff --git a/FogApi/Public/Get-FogInventory.ps1 b/FogApi/Public/Get-FogInventory.ps1 index b390026..34c9a94 100644 --- a/FogApi/Public/Get-FogInventory.ps1 +++ b/FogApi/Public/Get-FogInventory.ps1 @@ -52,46 +52,46 @@ function Get-FogInventory { $baseBoard = Get-CimInstance -ClassName Win32_BaseBoard; $case = Get-CimInstance -ClassName Win32_SystemEnclosure; $info = Get-ComputerInfo; + $hostObj.inventory.hostID = $hostObj.id; + # $hostObj.inventory.primaryUser = + # $hostObj.inventory.other1 = + # $hostObj.inventory.other2 = + $hostObj.inventory.createdTime = $((get-date -format u).replace('Z','')); + # $hostObj.inventory.deleteDate = '0000-00-00 00:00:00' + $hostObj.inventory.sysman = $compSys.Vendor; #manufacturer + $hostObj.inventory.sysproduct = $compSys.Name; #model + $hostObj.inventory.sysversion = $compSys.Version; + $hostObj.inventory.sysserial = $compSys.IdentifyingNumber; + if ($compSys.UUID -notmatch "12345678-9012-3456-7890-abcdefabcdef" ) { + $hostObj.inventory.sysuuid = $compSys.UUID; + } else { + $hostObj.inventory.sysuuid = ($compSys.Qualifiers | Where-Object Name -match 'UUID' | Select-Object -ExpandProperty Value); + } + $hostObj.inventory.systype = $case.chassistype; #device form factor found chassistype member of $case but it references a list that hasn't been updated anywhere I can find. i.e. returns 35 for a minipc but documented list only goes to 24 + $hostObj.inventory.biosversion = $bios.name; + $hostObj.inventory.biosvendor = $bios.Manufacturer; + $hostObj.inventory.biosdate = $(get-date $info.BiosReleaseDate -Format d); + $hostObj.inventory.mbman = $baseBoard.Manufacturer; + $hostObj.inventory.mbproductname = $baseBoard.Product; + $hostObj.inventory.mbversion = $baseBoard.Version; + $hostObj.inventory.mbserial = $baseBoard.SerialNumber; + $hostObj.inventory.mbasset = $baseBoard.Tag; + $hostObj.inventory.cpuman = $cpu.Manufacturer; + $hostObj.inventory.cpuversion = $cpu.Name; + $hostObj.inventory.cpucurrent = "Current Speed: $($cpu.currentClockSpeed) MHz"; + $hostObj.inventory.cpumax = "Max Speed $($cpu.MaxClockSpeed) MHz"; + $hostObj.inventory.mem = "MemTotal: $($comp.TotalPhysicalMemory) kB"; + $hostObj.inventory.hdmodel = $hdd.Model; + $hostObj.inventory.hdserial = $hdd.SerialNumber; + $hostObj.inventory.hdfirmware = $hdd.FirmareRevision; + $hostObj.inventory.caseman = $case.Manufacturer; + $hostObj.inventory.casever = $case.Version; + $hostObj.inventory.caseserial = $case.SerialNumber; + $hostObj.inventory.caseasset = $case.SMBIOSAssetTag; + $hostObj.inventory.memory = "$([MATH]::Round($(($comp.TotalPhysicalMemory) / 1GB),2)) GiB"; + $jsonData = $hostObj.inventory | ConvertTo-Json; + return $jsonData; } - $hostObj.inventory.hostID = $hostObj.id; - # $hostObj.inventory.primaryUser = - # $hostObj.inventory.other1 = - # $hostObj.inventory.other2 = - $hostObj.inventory.createdTime = $((get-date -format u).replace('Z','')); - # $hostObj.inventory.deleteDate = '0000-00-00 00:00:00' - $hostObj.inventory.sysman = $compSys.Vendor; #manufacturer - $hostObj.inventory.sysproduct = $compSys.Name; #model - $hostObj.inventory.sysversion = $compSys.Version; - $hostObj.inventory.sysserial = $compSys.IdentifyingNumber; - if ($compSys.UUID -notmatch "12345678-9012-3456-7890-abcdefabcdef" ) { - $hostObj.inventory.sysuuid = $compSys.UUID; - } else { - $hostObj.inventory.sysuuid = ($compSys.Qualifiers | Where-Object Name -match 'UUID' | Select-Object -ExpandProperty Value); - } - $hostObj.inventory.systype = $case.chassistype; #device form factor found chassistype member of $case but it references a list that hasn't been updated anywhere I can find. i.e. returns 35 for a minipc but documented list only goes to 24 - $hostObj.inventory.biosversion = $bios.name; - $hostObj.inventory.biosvendor = $bios.Manufacturer; - $hostObj.inventory.biosdate = $(get-date $info.BiosReleaseDate -Format d); - $hostObj.inventory.mbman = $baseBoard.Manufacturer; - $hostObj.inventory.mbproductname = $baseBoard.Product; - $hostObj.inventory.mbversion = $baseBoard.Version; - $hostObj.inventory.mbserial = $baseBoard.SerialNumber; - $hostObj.inventory.mbasset = $baseBoard.Tag; - $hostObj.inventory.cpuman = $cpu.Manufacturer; - $hostObj.inventory.cpuversion = $cpu.Name; - $hostObj.inventory.cpucurrent = "Current Speed: $($cpu.currentClockSpeed) MHz"; - $hostObj.inventory.cpumax = "Max Speed $($cpu.MaxClockSpeed) MHz"; - $hostObj.inventory.mem = "MemTotal: $($comp.TotalPhysicalMemory) kB"; - $hostObj.inventory.hdmodel = $hdd.Model; - $hostObj.inventory.hdserial = $hdd.SerialNumber; - $hostObj.inventory.hdfirmware = $hdd.FirmareRevision; - $hostObj.inventory.caseman = $case.Manufacturer; - $hostObj.inventory.casever = $case.Version; - $hostObj.inventory.caseserial = $case.SerialNumber; - $hostObj.inventory.caseasset = $case.SMBIOSAssetTag; - $hostObj.inventory.memory = "$([MATH]::Round($(($comp.TotalPhysicalMemory) / 1GB),2)) GiB"; - $jsonData = $hostObj.inventory | ConvertTo-Json; - return $jsonData; } diff --git a/FogApi/Public/Set-FogInventory.ps1 b/FogApi/Public/Set-FogInventory.ps1 index c09303f..a9a2b2d 100644 --- a/FogApi/Public/Set-FogInventory.ps1 +++ b/FogApi/Public/Set-FogInventory.ps1 @@ -21,19 +21,13 @@ the jsondata with the inventory $jsonData = (Get-FogInventory -hostObj $hostObj) ) - begin { + process { $inventoryApi = @{ jsonData = $jsonData; Method = 'Post'; uriPath = "inventory/new"; } - } - - process { Invoke-FogApi @inventoryApi -verbose; - } - - end { return; } diff --git a/README.md b/README.md index a99e833..178e914 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Overview +[![Test Build](https://github.com/darksidemilk/FogApi/actions/workflows/build-test.yml/badge.svg)](https://github.com/darksidemilk/FogApi/actions/workflows/build-test.yml) + This is a powershell module to make using the Fog Project API even easier. FOG is an opensource tool for imaging comptuters, this module uses the API on your internal fog server to perform almost any operation. It can be used to create more automation or to simply have a command line method of controlling fog operations. diff --git a/build.ps1 b/build.ps1 index e030fb0..0963641 100644 --- a/build.ps1 +++ b/build.ps1 @@ -315,4 +315,6 @@ $newContent += "`n`n" $newContent += "### $newVer`n`n`t$releaseNote`n" $newContent += $curNotes # pause; -Set-Content -Path "$docsPth\ReleaseNotes.md" -value $newContent \ No newline at end of file +Set-Content -Path "$docsPth\ReleaseNotes.md" -value $newContent + +return $buildPth; \ No newline at end of file diff --git a/docs/ReleaseNotes.md b/docs/ReleaseNotes.md index 2e6b32d..d8cb883 100644 --- a/docs/ReleaseNotes.md +++ b/docs/ReleaseNotes.md @@ -2,6 +2,13 @@ ## 6.x +### 2408.6.9 + + Created Get-FogVersion and implmented check for 1.6 version + so correct dynamic parameters are used for 1.5.x vs 1.6 + Also added a separate build test script for running a build test + on each push. + ### 2311.6.4 typo bug fix there was a stray extra character. Also added switch for Set-FogSnapins called -repairBeforeAdd to allow running the repair before attempting to add. Also added in more try catch logic to set-fogsnapins. Also cleaned up release notes in manifest to just include the latest release to allow for faster import of module @@ -298,3 +305,8 @@ * Added hostID param to get-foghost so you can get a host from the internal hostID if you already have that + + + + + diff --git a/docs/commands/Add-FogHostMac.md b/docs/commands/Add-FogHostMac.md index 5b86cc6..74d1abe 100644 --- a/docs/commands/Add-FogHostMac.md +++ b/docs/commands/Add-FogHostMac.md @@ -14,7 +14,7 @@ Adds a given macaddress to a host of a given ID ``` Add-FogHostMac [[-hostID] ] [[-macAddress] ] [-primary] [-ignoreMacOnClient] - [-ignoreMacForImaging] [-forceUpdate] [] + [-ignoreMacForImaging] [-forceUpdate] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -129,6 +129,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Add-FogResultData.md b/docs/commands/Add-FogResultData.md index 99d19f6..2a7f868 100644 --- a/docs/commands/Add-FogResultData.md +++ b/docs/commands/Add-FogResultData.md @@ -14,7 +14,7 @@ If the data property is missing it is added ## SYNTAX ``` -Add-FogResultData [[-result] ] [] +Add-FogResultData [[-result] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -48,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Approve-FogPendingMac.md b/docs/commands/Approve-FogPendingMac.md index 15092dd..402ef7a 100644 --- a/docs/commands/Approve-FogPendingMac.md +++ b/docs/commands/Approve-FogPendingMac.md @@ -13,7 +13,7 @@ Approves a macaddress object ## SYNTAX ``` -Approve-FogPendingMac [[-macObject] ] [] +Approve-FogPendingMac [[-macObject] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -57,6 +57,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Deny-FogPendingMac.md b/docs/commands/Deny-FogPendingMac.md index da65d21..e8e192a 100644 --- a/docs/commands/Deny-FogPendingMac.md +++ b/docs/commands/Deny-FogPendingMac.md @@ -13,7 +13,7 @@ Deny a pending fog mac aka delete a fog mac address association entry ## SYNTAX ``` -Deny-FogPendingMac [-macObject] [] +Deny-FogPendingMac [-macObject] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -54,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Find-FogObject.md b/docs/commands/Find-FogObject.md index e347215..48274a7 100644 --- a/docs/commands/Find-FogObject.md +++ b/docs/commands/Find-FogObject.md @@ -14,7 +14,8 @@ Note that it will search all fields for the search string, not just the name. ## SYNTAX ``` -Find-FogObject [[-type] ] [[-stringToSearch] ] [] +Find-FogObject [[-type] ] [[-stringToSearch] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -86,6 +87,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogActiveTasks.md b/docs/commands/Get-FogActiveTasks.md index 1471cbd..d430a24 100644 --- a/docs/commands/Get-FogActiveTasks.md +++ b/docs/commands/Get-FogActiveTasks.md @@ -13,7 +13,7 @@ Gets the current active tasks ## SYNTAX ``` -Get-FogActiveTasks [] +Get-FogActiveTasks [-ProgressAction ] [] ``` ## DESCRIPTION @@ -30,6 +30,21 @@ This will list any active tasks and their properties ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogGroupAssociations.md b/docs/commands/Get-FogGroupAssociations.md index ead1a90..3811402 100644 --- a/docs/commands/Get-FogGroupAssociations.md +++ b/docs/commands/Get-FogGroupAssociations.md @@ -13,7 +13,7 @@ Gets the group association objects that can be used to find group memberships ## SYNTAX ``` -Get-FogGroupAssociations [] +Get-FogGroupAssociations [-ProgressAction ] [] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ Would give you the group associations of the current computer ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogGroupByName.md b/docs/commands/Get-FogGroupByName.md index f81222c..be625bb 100644 --- a/docs/commands/Get-FogGroupByName.md +++ b/docs/commands/Get-FogGroupByName.md @@ -13,7 +13,7 @@ Gets a fog group object by name ## SYNTAX ``` -Get-FogGroupByName [[-groupName] ] [] +Get-FogGroupByName [[-groupName] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -45,6 +45,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogGroups.md b/docs/commands/Get-FogGroups.md index cde7dc8..9f52ea1 100644 --- a/docs/commands/Get-FogGroups.md +++ b/docs/commands/Get-FogGroups.md @@ -13,7 +13,7 @@ Returns all fog groups ## SYNTAX ``` -Get-FogGroups [] +Get-FogGroups [-ProgressAction ] [] ``` ## DESCRIPTION @@ -28,6 +28,21 @@ $groups = Get-FogGroups ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHost.md b/docs/commands/Get-FogHost.md index ada093c..b454690 100644 --- a/docs/commands/Get-FogHost.md +++ b/docs/commands/Get-FogHost.md @@ -14,17 +14,18 @@ Gets the object of a specific fog host ### searchTerm (Default) ``` -Get-FogHost [-uuid ] [-hostName ] [-macAddr ] [] +Get-FogHost [-uuid ] [-hostName ] [-macAddr ] [-ProgressAction ] + [] ``` ### byID ``` -Get-FogHost -hostID [] +Get-FogHost -hostID [-ProgressAction ] [] ``` ### serialNumber ``` -Get-FogHost -serialNumber [] +Get-FogHost -serialNumber [-ProgressAction ] [] ``` ## DESCRIPTION @@ -141,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHostAssociatedSnapins.md b/docs/commands/Get-FogHostAssociatedSnapins.md index 467172c..941eb3e 100644 --- a/docs/commands/Get-FogHostAssociatedSnapins.md +++ b/docs/commands/Get-FogHostAssociatedSnapins.md @@ -13,7 +13,7 @@ Returns list of all snapins associated with a given hostid, defaults to current ## SYNTAX ``` -Get-FogHostAssociatedSnapins [[-hostId] ] [] +Get-FogHostAssociatedSnapins [[-hostId] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -51,6 +51,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHostGroup.md b/docs/commands/Get-FogHostGroup.md index 92c7f21..521a011 100644 --- a/docs/commands/Get-FogHostGroup.md +++ b/docs/commands/Get-FogHostGroup.md @@ -13,7 +13,7 @@ returns the group objects that a host belongs to ## SYNTAX ``` -Get-FogHostGroup [[-hostId] ] [] +Get-FogHostGroup [[-hostId] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -45,6 +45,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHostMacs.md b/docs/commands/Get-FogHostMacs.md index 2baa59a..2ddba0d 100644 --- a/docs/commands/Get-FogHostMacs.md +++ b/docs/commands/Get-FogHostMacs.md @@ -14,12 +14,12 @@ Returns the macs assigned to a given host ### byHostObject ``` -Get-FogHostMacs [-hostObject ] [] +Get-FogHostMacs [-hostObject ] [-ProgressAction ] [] ``` ### byHostID ``` -Get-FogHostMacs [-hostID ] [] +Get-FogHostMacs [-hostID ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -67,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHostPendingMacs.md b/docs/commands/Get-FogHostPendingMacs.md index 83e3643..9f4926b 100644 --- a/docs/commands/Get-FogHostPendingMacs.md +++ b/docs/commands/Get-FogHostPendingMacs.md @@ -13,7 +13,7 @@ Gets the pending macs for a given hosts ## SYNTAX ``` -Get-FogHostPendingMacs [[-hostID] ] [] +Get-FogHostPendingMacs [[-hostID] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -54,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogHosts.md b/docs/commands/Get-FogHosts.md index de419fb..cafa19c 100644 --- a/docs/commands/Get-FogHosts.md +++ b/docs/commands/Get-FogHosts.md @@ -13,7 +13,7 @@ Gets all fog hosts ## SYNTAX ``` -Get-FogHosts [] +Get-FogHosts [-ProgressAction ] [] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ returns an array object with all hosts in the fogserver. ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogImages.md b/docs/commands/Get-FogImages.md index 16344b2..14afd2c 100644 --- a/docs/commands/Get-FogImages.md +++ b/docs/commands/Get-FogImages.md @@ -13,7 +13,7 @@ Returns an object of the images defined in your fogserver ## SYNTAX ``` -Get-FogImages [] +Get-FogImages [-ProgressAction ] [] ``` ## DESCRIPTION @@ -30,6 +30,21 @@ Gets all the fog images and then lists them with just the image id and names ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogInventory.md b/docs/commands/Get-FogInventory.md index e717f38..16821a6 100644 --- a/docs/commands/Get-FogInventory.md +++ b/docs/commands/Get-FogInventory.md @@ -14,7 +14,7 @@ a json object that can be used to set fog inventory ## SYNTAX ``` -Get-FogInventory [[-hostObj] ] [-fromFog] [] +Get-FogInventory [[-hostObj] ] [-fromFog] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -73,6 +73,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogLog.md b/docs/commands/Get-FogLog.md index fe70492..8ef39b1 100644 --- a/docs/commands/Get-FogLog.md +++ b/docs/commands/Get-FogLog.md @@ -13,7 +13,7 @@ Get a auto updating fog log ## SYNTAX ``` -Get-FogLog [-static] [-userFogLog] [] +Get-FogLog [-static] [-userFogLog] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -68,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogMacAddresses.md b/docs/commands/Get-FogMacAddresses.md index 031db7a..b625302 100644 --- a/docs/commands/Get-FogMacAddresses.md +++ b/docs/commands/Get-FogMacAddresses.md @@ -13,7 +13,7 @@ Gets all mac addresses in fog ## SYNTAX ``` -Get-FogMacAddresses [] +Get-FogMacAddresses [-ProgressAction ] [] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ Gets all the mac addresses in fog and puts them in the $macs object ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogModules.md b/docs/commands/Get-FogModules.md index 5144ad6..02a56b6 100644 --- a/docs/commands/Get-FogModules.md +++ b/docs/commands/Get-FogModules.md @@ -13,7 +13,7 @@ Returns the modules in fog with their names, ids, descriptions, and if they're s ## SYNTAX ``` -Get-FogModules [] +Get-FogModules [-ProgressAction ] [] ``` ## DESCRIPTION @@ -39,6 +39,21 @@ Will display the modules that are set to be enabled by default in your fog serve ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogObject.md b/docs/commands/Get-FogObject.md index 86038c2..8fdc35d 100644 --- a/docs/commands/Get-FogObject.md +++ b/docs/commands/Get-FogObject.md @@ -13,7 +13,8 @@ Gets a fog object via the api ## SYNTAX ``` -Get-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] [] +Get-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -81,6 +82,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogServerSettings.md b/docs/commands/Get-FogServerSettings.md index cd80121..02c1069 100644 --- a/docs/commands/Get-FogServerSettings.md +++ b/docs/commands/Get-FogServerSettings.md @@ -13,7 +13,7 @@ Gets the server settings set for this module ## SYNTAX ``` -Get-FogServerSettings [] +Get-FogServerSettings [-ProgressAction ] [] ``` ## DESCRIPTION @@ -34,6 +34,21 @@ and returns the api key and server name values ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogServerSettingsFile.md b/docs/commands/Get-FogServerSettingsFile.md index c8b00c9..5b7cb6e 100644 --- a/docs/commands/Get-FogServerSettingsFile.md +++ b/docs/commands/Get-FogServerSettingsFile.md @@ -13,7 +13,7 @@ Returns the path to the fog server settings file for the current user based on t ## SYNTAX ``` -Get-FogServerSettingsFile [] +Get-FogServerSettingsFile [-ProgressAction ] [] ``` ## DESCRIPTION @@ -38,6 +38,21 @@ if your username was fog and you were on linux it wourld return /home/fog/.FogAp ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogSnapinAssociations.md b/docs/commands/Get-FogSnapinAssociations.md index 3cef649..18233d4 100644 --- a/docs/commands/Get-FogSnapinAssociations.md +++ b/docs/commands/Get-FogSnapinAssociations.md @@ -13,7 +13,7 @@ Helper function that returns a list of all snapin associations to any host on th ## SYNTAX ``` -Get-FogSnapinAssociations [] +Get-FogSnapinAssociations [-ProgressAction ] [] ``` ## DESCRIPTION @@ -32,6 +32,21 @@ Will return a full list of all snapin ids associated to host ids ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogSnapins.md b/docs/commands/Get-FogSnapins.md index 5c57d2d..555754c 100644 --- a/docs/commands/Get-FogSnapins.md +++ b/docs/commands/Get-FogSnapins.md @@ -13,7 +13,7 @@ Returns list of all snapins on fogserver ## SYNTAX ``` -Get-FogSnapins [] +Get-FogSnapins [-ProgressAction ] [] ``` ## DESCRIPTION @@ -31,6 +31,21 @@ Returns an array of objects with details of each snapin. ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Get-FogVersion.md b/docs/commands/Get-FogVersion.md new file mode 100644 index 0000000..2e4325e --- /dev/null +++ b/docs/commands/Get-FogVersion.md @@ -0,0 +1,58 @@ +--- +external help file: FogApi-help.xml +Module Name: FogApi +online version: https://fogapi.readthedocs.io/en/latest/commands/Get-FogVersion +schema: 2.0.0 +--- + +# Get-FogVersion + +## SYNOPSIS +Gets the version of FOG + +## SYNTAX + +``` +Get-FogVersion [-ProgressAction ] [] +``` + +## DESCRIPTION +Only works for 1.6 beta and above, 1.5.x is identified as 1.5.10 if null is returned + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-FogVersion; +``` + +Will return the full version string + +## PARAMETERS + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). + +## INPUTS + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS diff --git a/docs/commands/Get-LastImageTime.md b/docs/commands/Get-LastImageTime.md index 9edf0c6..77da702 100644 --- a/docs/commands/Get-LastImageTime.md +++ b/docs/commands/Get-LastImageTime.md @@ -14,17 +14,17 @@ Prompts for a serial number, finds the host by that serial number, and returns a ### bySN (Default) ``` -Get-LastImageTime [-serialNumber ] [] +Get-LastImageTime [-serialNumber ] [-ProgressAction ] [] ``` ### byHostId ``` -Get-LastImageTime [-hostId ] [] +Get-LastImageTime [-hostId ] [-ProgressAction ] [] ``` ### byHost ``` -Get-LastImageTime [-fogHost ] [-currentHost] [] +Get-LastImageTime [-fogHost ] [-currentHost] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -130,6 +130,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Install-FogService.md b/docs/commands/Install-FogService.md index ebe2fc8..d2b198d 100644 --- a/docs/commands/Install-FogService.md +++ b/docs/commands/Install-FogService.md @@ -13,7 +13,7 @@ Attempts to install the fog service ## SYNTAX ``` -Install-FogService [[-fogServer] ] [] +Install-FogService [[-fogServer] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -48,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Invoke-FogApi.md b/docs/commands/Invoke-FogApi.md index 13b24ce..eb25c38 100644 --- a/docs/commands/Invoke-FogApi.md +++ b/docs/commands/Invoke-FogApi.md @@ -13,7 +13,8 @@ a cmdlet function for making fogAPI calls via powershell ## SYNTAX ``` -Invoke-FogApi [[-uriPath] ] [[-Method] ] [[-jsonData] ] [] +Invoke-FogApi [[-uriPath] ] [[-Method] ] [[-jsonData] ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/New-FogHost.md b/docs/commands/New-FogHost.md index 09df657..f9dfbc3 100644 --- a/docs/commands/New-FogHost.md +++ b/docs/commands/New-FogHost.md @@ -14,12 +14,13 @@ Creates a new host in fog ### default (Default) ``` -New-FogHost -name -macs [-modules ] [] +New-FogHost -name -macs [-modules ] [-ProgressAction ] + [] ``` ### custom ``` -New-FogHost -customHost [] +New-FogHost -customHost [-ProgressAction ] [] ``` ## DESCRIPTION @@ -118,6 +119,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/New-FogObject.md b/docs/commands/New-FogObject.md index f0bcf6b..fa0b00c 100644 --- a/docs/commands/New-FogObject.md +++ b/docs/commands/New-FogObject.md @@ -13,7 +13,8 @@ Create a new fog object with the api ## SYNTAX ``` -New-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] [] +New-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -75,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Receive-FogImage.md b/docs/commands/Receive-FogImage.md index c199a0a..7c7a6b8 100644 --- a/docs/commands/Receive-FogImage.md +++ b/docs/commands/Receive-FogImage.md @@ -14,12 +14,13 @@ Starts or schedules a capture task on a given host ### now (Default) ``` -Receive-FogImage [-hostId ] [] +Receive-FogImage [-hostId ] [-ProgressAction ] [] ``` ### schedule ``` -Receive-FogImage [-hostId ] [-StartAtTime ] [] +Receive-FogImage [-hostId ] [-StartAtTime ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -82,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Remove-FogObject.md b/docs/commands/Remove-FogObject.md index 2fcd47a..16e4c9d 100644 --- a/docs/commands/Remove-FogObject.md +++ b/docs/commands/Remove-FogObject.md @@ -13,7 +13,8 @@ Removes/Deletes a object via fog api ## SYNTAX ``` -Remove-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] [] +Remove-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -75,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Remove-UsbMac.md b/docs/commands/Remove-UsbMac.md index 4f20e8b..9856093 100644 --- a/docs/commands/Remove-UsbMac.md +++ b/docs/commands/Remove-UsbMac.md @@ -13,7 +13,8 @@ A cmdlet that uses invoke-fogapi to remove a given list of usb mac address from ## SYNTAX ``` -Remove-UsbMac [[-usbMacs] ] [[-hostname] ] [[-macId] ] [] +Remove-UsbMac [[-usbMacs] ] [[-hostname] ] [[-macId] ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -73,6 +74,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Repair-FogSnapinAssociations.md b/docs/commands/Repair-FogSnapinAssociations.md index 9c61efb..89a9357 100644 --- a/docs/commands/Repair-FogSnapinAssociations.md +++ b/docs/commands/Repair-FogSnapinAssociations.md @@ -13,7 +13,7 @@ Finds any invalid snapin associations and removes them from the server ## SYNTAX ``` -Repair-FogSnapinAssociations [] +Repair-FogSnapinAssociations [-ProgressAction ] [] ``` ## DESCRIPTION @@ -55,6 +55,21 @@ Snapin Association repair complete! ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Reset-HostEncryption.md b/docs/commands/Reset-HostEncryption.md index 9855080..2912e95 100644 --- a/docs/commands/Reset-HostEncryption.md +++ b/docs/commands/Reset-HostEncryption.md @@ -13,7 +13,8 @@ Reset the host encryption data on a given host ## SYNTAX ``` -Reset-HostEncryption [[-fogHost] ] [-restartSvc] [] +Reset-HostEncryption [[-fogHost] ] [-restartSvc] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Resolve-HostID.md b/docs/commands/Resolve-HostID.md index 93bd554..653c866 100644 --- a/docs/commands/Resolve-HostID.md +++ b/docs/commands/Resolve-HostID.md @@ -13,7 +13,7 @@ Validate the input is a hostid integer ## SYNTAX ``` -Resolve-HostID [[-hostID] ] [] +Resolve-HostID [[-hostID] ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -45,6 +45,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Send-FogImage.md b/docs/commands/Send-FogImage.md index 4afda2d..12121c6 100644 --- a/docs/commands/Send-FogImage.md +++ b/docs/commands/Send-FogImage.md @@ -14,12 +14,13 @@ Start or schedule a deploy task for a fog host ### now (Default) ``` -Send-FogImage [-hostId ] [] +Send-FogImage [-hostId ] [-ProgressAction ] [] ``` ### schedule ``` -Send-FogImage [-hostId ] [-StartAtTime ] [] +Send-FogImage [-hostId ] [-StartAtTime ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -82,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Send-FogWolTask.md b/docs/commands/Send-FogWolTask.md new file mode 100644 index 0000000..aabdefc --- /dev/null +++ b/docs/commands/Send-FogWolTask.md @@ -0,0 +1,105 @@ +--- +external help file: FogApi-help.xml +Module Name: FogApi +online version: https://fogapi.readthedocs.io/en/latest/commands/Send-FogWolTask +schema: 2.0.0 +--- + +# Send-FogWolTask + +## SYNOPSIS +Sends a wake on task to a given host by host object gotten with get-foghost or by the name of the host + +## SYNTAX + +### byHostObject +``` +Send-FogWolTask [-hostObj ] [-ProgressAction ] [] +``` + +### byname +``` +Send-FogWolTask [-computername ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Creates a new fog task of id 14 for a wake on lan task. +Will cause fog to send a magic packet to the +mac addresses registered for the given host. + +## EXAMPLES + +### EXAMPLE 1 +``` +Send-FogWolTask -computername "some-computer" +``` + +Will send a magic computer to the computer some-computer from the fog server; + +### EXAMPLE 2 +``` +$sleepers = (Get-foghosts | ? name -in ((Get-ADComputer -Filter '*' -SearchBase 'ou=someOU,dc=company,dc=local').name)); $sleepers | % {Send-FogWolTask -hostObj $_} +``` + +Will find the names of the computers in the given ou via the distinguished name string in the searchbase param. +It will find the fog host objects that match those names and put them in the $sleepers variable +It will go through each of the $sleepers and send a wake on lan task + +## PARAMETERS + +### -hostObj +The foghost object gotten with get-foghost + +```yaml +Type: Object +Parameter Sets: byHostObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -computername +The name of the computer to get the fog host of + +```yaml +Type: Object +Parameter Sets: byname +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). + +## INPUTS + +## OUTPUTS + +## NOTES +Created per this forum post https://forums.fogproject.org/topic/16867/api-wake-on-lan?_=1686084315380 + +## RELATED LINKS diff --git a/docs/commands/Set-FogInventory.md b/docs/commands/Set-FogInventory.md index 7605728..5923648 100644 --- a/docs/commands/Set-FogInventory.md +++ b/docs/commands/Set-FogInventory.md @@ -13,7 +13,8 @@ Sets a fog hosts inventory ## SYNTAX ``` -Set-FogInventory [[-hostObj] ] [[-jsonData] ] [] +Set-FogInventory [[-hostObj] ] [[-jsonData] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Set-FogServerSettings.md b/docs/commands/Set-FogServerSettings.md index f160b84..4ca794b 100644 --- a/docs/commands/Set-FogServerSettings.md +++ b/docs/commands/Set-FogServerSettings.md @@ -14,13 +14,13 @@ Set fog server settings ### prompt (Default) ``` -Set-FogServerSettings [-interactive] [] +Set-FogServerSettings [-interactive] [-ProgressAction ] [] ``` ### default ``` Set-FogServerSettings [-fogApiToken ] [-fogUserToken ] [-fogServer ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -108,6 +108,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Set-FogServerSettingsFileSecurity.md b/docs/commands/Set-FogServerSettingsFileSecurity.md index bfb762c..13246d4 100644 --- a/docs/commands/Set-FogServerSettingsFileSecurity.md +++ b/docs/commands/Set-FogServerSettingsFileSecurity.md @@ -13,7 +13,8 @@ Set the settings file or given file to full control for owner only, no access fo ## SYNTAX ``` -Set-FogServerSettingsFileSecurity [[-settingsFile] ] [] +Set-FogServerSettingsFileSecurity [[-settingsFile] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Set-FogSnapins.md b/docs/commands/Set-FogSnapins.md index f0da558..120e0af 100644 --- a/docs/commands/Set-FogSnapins.md +++ b/docs/commands/Set-FogSnapins.md @@ -13,7 +13,8 @@ Sets a list of snapins to a host, appends to existing ones ## SYNTAX ``` -Set-FogSnapins [[-hostid] ] [[-pkgList] ] [-exactNames] [-repairBeforeAdd] [] +Set-FogSnapins [[-hostid] ] [[-pkgList] ] [-exactNames] [-repairBeforeAdd] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -93,6 +94,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Start-FogSnapin.md b/docs/commands/Start-FogSnapin.md index 203a4d0..1056920 100644 --- a/docs/commands/Start-FogSnapin.md +++ b/docs/commands/Start-FogSnapin.md @@ -14,12 +14,14 @@ Starts a single snapin task for a given machine ### byId (Default) ``` -Start-FogSnapin [-hostID ] [-snapinId ] [] +Start-FogSnapin [-hostID ] [-snapinId ] [-ProgressAction ] + [] ``` ### byName ``` -Start-FogSnapin [-hostID ] [-snapinname ] [] +Start-FogSnapin [-hostID ] [-snapinname ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -90,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Start-FogSnapins.md b/docs/commands/Start-FogSnapins.md index 0eb087d..d724d6e 100644 --- a/docs/commands/Start-FogSnapins.md +++ b/docs/commands/Start-FogSnapins.md @@ -13,7 +13,8 @@ Starts all associated snapins of a host ## SYNTAX ``` -Start-FogSnapins [[-hostid] ] [[-taskTypeid] ] [] +Start-FogSnapins [[-hostid] ] [[-taskTypeid] ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/Update-FogObject.md b/docs/commands/Update-FogObject.md index 634ce72..60f5ac1 100644 --- a/docs/commands/Update-FogObject.md +++ b/docs/commands/Update-FogObject.md @@ -14,7 +14,7 @@ Update/patch/edit api calls ``` Update-FogObject [[-type] ] [[-jsonData] ] [[-IDofObject] ] [[-uri] ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -93,6 +93,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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). diff --git a/docs/commands/index.md b/docs/commands/index.md deleted file mode 100644 index 38d768f..0000000 --- a/docs/commands/index.md +++ /dev/null @@ -1,93 +0,0 @@ -# FogAPI - -## [Add-FogHostMac](Add-FogHostMac.md) - -## [Add-FogResultData](Add-FogResultData.md) - -## [Approve-FogPendingMac](Approve-FogPendingMac.md) - -## [Deny-FogPendingMac](Deny-FogPendingMac.md) - -## [Find-FogObject](Find-FogObject.md) - -## [Get-FogActiveTasks](Get-FogActiveTasks.md) - -## [Get-FogGroupAssociations](Get-FogGroupAssociations.md) - -## [Get-FogGroupByName](Get-FogGroupByName.md) - -## [Get-FogGroups](Get-FogGroups.md) - -## [Get-FogHost](Get-FogHost.md) - -## [Get-FogHostAssociatedSnapins](Get-FogHostAssociatedSnapins.md) - -## [Get-FogHostGroup](Get-FogHostGroup.md) - -## [Get-FogHostMacs](Get-FogHostMacs.md) - -## [Get-FogHostPendingMacs](Get-FogHostPendingMacs.md) - -## [Get-FogHosts](Get-FogHosts.md) - -## [Get-FogImages](Get-FogImages.md) - -## [Get-FogInventory](Get-FogInventory.md) - -## [Get-FogLog](Get-FogLog.md) - -## [Get-FogMacAddresses](Get-FogMacAddresses.md) - -## [Get-FogModules](Get-FogModules.md) - -## [Get-FogObject](Get-FogObject.md) - -## [Get-FogSecsSinceEpoch](Get-FogSecsSinceEpoch.md) - -## [Get-FogServerSettings](Get-FogServerSettings.md) - -## [Get-FogServerSettingsFile](Get-FogServerSettingsFile.md) - -## [Get-FogSnapinAssociations](Get-FogSnapinAssociations.md) - -## [Get-FogSnapins](Get-FogSnapins.md) - -## [Get-LastImageTime](Get-LastImageTime.md) - -## [Install-FogService](Install-FogService.md) - -## [Invoke-FogApi](Invoke-FogApi.md) - -## [New-FogHost](New-FogHost.md) - -## [New-FogObject](New-FogObject.md) - -## [Receive-FogImage](Receive-FogImage.md) - -## [Remove-FogObject](Remove-FogObject.md) - -## [Remove-UsbMac](Remove-UsbMac.md) - -## [Repair-FogSnapinAssociations](Repair-FogSnapinAssociations.md) - -## [Reset-HostEncryption](Reset-HostEncryption.md) - -## [Resolve-HostID](Resolve-HostID.md) - -## [Send-FogImage](Send-FogImage.md) - -## [Set-FogInventory](Set-FogInventory.md) - -## [Set-FogServerSettings](Set-FogServerSettings.md) - -## [Set-FogServerSettingsFileSecurity](Set-FogServerSettingsFileSecurity.md) - -## [Set-FogSnapins](Set-FogSnapins.md) - -## [Start-FogSnapin](Start-FogSnapin.md) - -## [Start-FogSnapins](Start-FogSnapins.md) - -## [Update-FogObject](Update-FogObject.md) - - diff --git a/docs/en-us/FogApi-help.xml b/docs/en-us/FogApi-help.xml index 15d6c93..55f6610 100644 --- a/docs/en-us/FogApi-help.xml +++ b/docs/en-us/FogApi-help.xml @@ -83,6 +83,18 @@ False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -158,6 +170,18 @@ False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -216,6 +240,18 @@ None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -231,6 +267,18 @@ None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -282,6 +330,18 @@ None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -297,6 +357,18 @@ None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -357,6 +429,18 @@ Approve-FogPendingMac -macObject $pendingMac None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -372,6 +456,18 @@ Approve-FogPendingMac -macObject $pendingMac None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -444,6 +540,18 @@ Deny-FogPendingMac -macObject $pendingMac None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -471,6 +579,18 @@ Deny-FogPendingMac -macObject $pendingMac None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -524,9 +644,34 @@ Deny-FogPendingMac -macObject $pendingMac Get-FogActiveTasks + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -565,9 +710,34 @@ Deny-FogPendingMac -macObject $pendingMac Get-FogGroupAssociations + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -619,6 +789,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -634,6 +816,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -673,9 +867,34 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) Get-FogGroups + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -750,6 +969,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Get-FogHost @@ -765,6 +996,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Get-FogHost @@ -780,6 +1023,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -843,6 +1098,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -915,6 +1182,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) ((Get-FogHost).id) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -930,6 +1209,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) ((Get-FogHost).id) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -981,6 +1272,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) 0 + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -996,6 +1299,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) 0 + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1047,6 +1362,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) (Get-FogHost) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Get-FogHostMacs @@ -1062,6 +1389,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1089,6 +1428,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1140,6 +1491,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1155,6 +1518,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1201,9 +1576,34 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) Get-FogHosts + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1242,9 +1642,34 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) Get-FogImages + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1306,7 +1731,19 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) False - + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1333,6 +1770,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1401,6 +1850,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1428,6 +1889,18 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1474,9 +1947,34 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) Get-FogMacAddresses + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1515,9 +2013,34 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) Get-FogModules + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1600,6 +2123,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1639,6 +2174,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -1744,9 +2291,34 @@ $mods Get-FogServerSettings + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1785,9 +2357,34 @@ $mods Get-FogServerSettingsFile + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1826,9 +2423,34 @@ $mods Get-FogSnapinAssociations + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1867,9 +2489,34 @@ $mods Get-FogSnapins + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -1893,6 +2540,72 @@ $mods + + + Get-FogVersion + Get + FogVersion + + Gets the version of FOG + + + + Only works for 1.6 beta and above, 1.5.x is identified as 1.5.10 if null is returned + + + + Get-FogVersion + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + General notes + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-FogVersion; + + Will return the full version string + + + + + + Online Version: + https://fogapi.readthedocs.io/en/latest/commands/Get-FogVersion + + + Get-LastImageTime @@ -1920,6 +2633,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Get-LastImageTime @@ -1935,6 +2660,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Get-LastImageTime @@ -1961,6 +2698,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2012,6 +2761,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2084,6 +2845,18 @@ $mods ((Get-FogServerSettings).fogServer) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2099,6 +2872,18 @@ $mods ((Get-FogServerSettings).fogServer) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2174,6 +2959,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2213,6 +3010,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2295,6 +3104,18 @@ $mods ((Get-FogModules | Where-Object isDefault -eq '1') | Select-Object -ExpandProperty id) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + New-FogHost @@ -2310,6 +3131,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2361,6 +3194,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2436,6 +3281,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2475,6 +3332,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2538,6 +3407,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2565,6 +3446,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2654,6 +3547,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2693,6 +3598,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2768,6 +3685,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2807,6 +3736,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2846,9 +3787,34 @@ $mods Repair-FogSnapinAssociations + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + - + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + @@ -2914,6 +3880,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2941,6 +3919,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -2992,6 +3982,18 @@ $mods (Get-foghost).id + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3007,6 +4009,18 @@ $mods (Get-foghost).id + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3070,6 +4084,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3097,6 +4123,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3135,6 +4173,142 @@ $mods + + + Send-FogWolTask + Send + FogWolTask + + Sends a wake on task to a given host by host object gotten with get-foghost or by the name of the host + + + + Creates a new fog task of id 14 for a wake on lan task. Will cause fog to send a magic packet to the mac addresses registered for the given host. + + + + Send-FogWolTask + + hostObj + + The foghost object gotten with get-foghost + + Object + + Object + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Send-FogWolTask + + computername + + The name of the computer to get the fog host of + + Object + + Object + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + hostObj + + The foghost object gotten with get-foghost + + Object + + Object + + + None + + + computername + + The name of the computer to get the fog host of + + Object + + Object + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + + Created per this forum post https://forums.fogproject.org/topic/16867/api-wake-on-lan?_=1686084315380 + + + + + -------------------------- EXAMPLE 1 -------------------------- + Send-FogWolTask -computername "some-computer" + + Will send a magic computer to the computer some-computer from the fog server; + + + + -------------------------- EXAMPLE 2 -------------------------- + $sleepers = (Get-foghosts | ? name -in ((Get-ADComputer -Filter '*' -SearchBase 'ou=someOU,dc=company,dc=local').name)); $sleepers | % {Send-FogWolTask -hostObj $_} + + Will find the names of the computers in the given ou via the distinguished name string in the searchbase param. It will find the fog host objects that match those names and put them in the $sleepers variable It will go through each of the $sleepers and send a wake on lan task + + + + + + Online Version: + https://fogapi.readthedocs.io/en/latest/commands/Send-FogWolTask + + + Set-FogInventory @@ -3174,6 +4348,18 @@ $mods (Get-FogInventory -hostObj $hostObj) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3201,6 +4387,18 @@ $mods (Get-FogInventory -hostObj $hostObj) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3276,6 +4474,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Set-FogServerSettings @@ -3290,6 +4500,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3341,6 +4563,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3399,6 +4633,18 @@ $mods (Get-FogServerSettingsFile) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3414,6 +4660,18 @@ $mods (Get-FogServerSettingsFile) + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3499,6 +4757,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3550,6 +4820,18 @@ $mods False + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3613,6 +4895,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + Start-FogSnapin @@ -3640,6 +4934,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3679,6 +4985,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3749,6 +5067,18 @@ $mods 12 + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3776,6 +5106,18 @@ $mods 12 + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3863,6 +5205,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + @@ -3914,6 +5268,18 @@ $mods None + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + diff --git a/invoke-modulebuild.ps1 b/invoke-modulebuild.ps1 new file mode 100644 index 0000000..d4c59f8 --- /dev/null +++ b/invoke-modulebuild.ps1 @@ -0,0 +1,123 @@ + +<#PSScriptInfo + +.VERSION 1.0.0.0 + +.GUID 5568f4d3-8d91-4e84-ab28-1c82dc444a61 + +.AUTHOR JJ Fullmer + +.COMPANYNAME Arrowhead Dental Lab + +.COPYRIGHT 2024 + +.TAGS + +.LICENSEURI + +.PROJECTURI + +.ICONURI + +.EXTERNALMODULEDEPENDENCIES + +.REQUIREDSCRIPTS + +.EXTERNALSCRIPTDEPENDENCIES + +.RELEASENOTES + + 1.0.0.0 + Initial version + +.PRIVATEDATA + +#> + +<# + +.DESCRIPTION + builds just the module into a single psm1 + +#> +[CmdletBinding()] +Param() + +$moduleName = 'FogApi' +$modulePath = "$PSScriptRoot\$moduleName"; + +mkdir $modulePath -EA 0; +# mkdir "$modulePath\tools" -EA 0; +# mkdir "$modulePath\docs" -EA 0; +mkdir "$modulePath\lib" -EA 0; +mkdir "$modulePath\bin" -EA 0; +mkdir "$modulePath\Public" -EA 0; +mkdir "$modulePath\Private" -EA 0; +mkdir "$modulePath\Classes" -EA 0; + + +$PublicFunctions = Get-ChildItem "$modulePath\Public" -Recurse -Filter '*.ps1' -EA 0; +$Classes = Get-ChildItem "$modulePath\Classes" -Recurse -Filter '*.ps1' -EA 0; +$PrivateFunctions = Get-ChildItem "$modulePath\Private" -Recurse -Filter '*.ps1' -EA 0; +# mkdir "$PSSCriptRoot\ModuleBuild" -EA 0; +$buildPth = ".\_module_build\$moduleName"; +$moduleFile = "$buildPth\$moduleName.psm1"; + +# Create the build output folder +if (Test-Path $buildPth) { + Remove-Item $buildPth -force -recurse; +} +mkdir $buildPth | Out-Null; + +New-Item $moduleFile -Force | Out-Null; +Copy-Item "$docsPth\en-us" "$buildPth\en-us" -Recurse -Exclude '*.md'; +Add-Content -Path $moduleFile -Value "`$PSModuleRoot = `$PSScriptRoot"; +if ((Get-ChildItem "$modulePath\lib").count -gt 0) { + Copy-Item "$modulePath\lib" "$buildPth\lib" -Recurse; + Add-Content -Path $moduleFile -Value "`$script:lib = `"`$PSModuleRoot\lib`""; +} +if ((Get-ChildItem "$modulePath\bin").count -gt 0) { + Copy-Item "$modulePath\bin" "$buildPth\bin" -Recurse; + Add-Content -Path $moduleFile -Value "`$script:bin = `"`$PSModuleRoot\bin`""; +} +# Copy-Item "$modulePath\tools" "$buildPth\tools" -Recurse; +Add-Content -Path $moduleFile -Value "`$script:tools = `"`$PSModuleRoot\tools`""; + + +#Build the psm1 file + + +#Add Classes +if ($null -ne $Classes) { + + $Classes | ForEach-Object { + Add-Content -Path $moduleFile -Value (Get-Content $_.FullName); + } + +} +# Add-PublicFunctions +Add-Content -Path $moduleFile -Value $heading + # $PublicFunctions; + $PublicFunctions | ForEach-Object { # Replace the comment block with external help link + $rawContent = (Get-Content $_.FullName -Raw); + $commentStartIdx = $rawContent.indexOf('<#'); + if ($commentStartIdx -ge 0) { + $commentEndIdx = $rawContent.IndexOf('#>'); + $commentLength = $commentEndIdx - ($commentStartIdx-2); #-2 to adjust for the # in front of > and the index starting at 0 + $comment = $rawContent.Substring($commentStartIdx,$commentLength); + $newComment = "# .ExternalHelp $moduleName-help.xml" + $Function = $rawContent.Replace($comment,$newComment); + } else { + $Function = $rawContent; + } + Add-Content -Path $moduleFile -Value $Function + } +#Add Private Functions +if ($null -ne $PrivateFunctions) { + $PrivateFunctions | ForEach-Object { + Add-Content -Path $moduleFile -Value (Get-Content $_.FullName); + } +} + +$manifest = "$PSScriptRoot\$moduleName\$moduleName.psd1" +Copy-Item $manifest "$buildPth\$moduleName.psd1"; \ No newline at end of file