FogApi.psd1
|
# # Module manifest for module 'FogApi' # # Generated by: JJ Fullmer, FOG Project # # Generated on: 8/20/2025 # @{ # Script module or binary module file associated with this manifest. RootModule = 'FogApi.psm1' # Version number of this module. ModuleVersion = '2508.9.23' # Supported PSEditions CompatiblePSEditions = 'Desktop', 'Core' # ID used to uniquely identify this module GUID = '7aa922fa-bb4f-46a0-a478-684e9535c65d' # Author of this module Author = 'JJ Fullmer, FOG Project' # Company or vendor of this module CompanyName = 'FOG Project' # Copyright statement for this module Copyright = '2018-2025' # Description of the functionality provided by this module Description = ' # FOG Api Powershell Module This is a powershell module to simplify the use of the Fog Project API. This module is used to easily run Fog API commands on your fogserver from a powershell console or script. FOG is an opensource tool for imaging comptuters, this module uses the API on your internal fog server to perform almost any operation you can do in the GUI of Fog and provides you with the ability to extend things further. It can be used to create more automation or to simply have a command line method of controlling fog operations. This essentially gives you a crossplatform commandline interface for fog tasks and makes many things easier to automate. Docs for this module can be found at https://fogapi.readthedocs.io/en/latest/ For more information about FOG see - https://FOGProject.org - https://docs.fogproject.org - https://github.com/FOGProject - https://github.com/FOGProject/fogproject - https://forums.fogproject.org # Versioning The versioning of this module follows this pattern `{Year|Month}.{Major Version}.{Revision #}` See https://github.com/darksidemilk/FogApi?tab=readme-ov-file#versioning for more info # Usage You can use Set-fogserverSettings to set your fogserver hostname and api keys. Or, the first time you try to run a command the settings.json file will automatically open in an OS Specific editor. You can also open the settings.json file and edit it manually before running your first command. The default settings are explanations of where to find the proper settings since json cannot have comments Once the settings are set you can utilze the fog documentation found here https://news.fogproject.org/simplified-api-documentation/ that was used to model the parameters for Get-FogObject, Update-FogObject, and Remove-FogObject. You can also utilize simpler functions of common tasks, see the links below for more info. # Additional info - Examples and More: https://github.com/darksidemilk/FogApi/blob/master/README.md - All Commands - https://fogapi.readthedocs.io/en/latest/commands/ - FogForums module thread: https://forums.fogproject.org/topic/12026/powershell-api-module/2 - Full change log available at https://fogapi.readthedocs.io/en/latest/ReleaseNotes/ ' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # ClrVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module # RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = 'Add-FogHostMac', 'Add-FogResultData', 'Approve-FogPendingMac', 'Deny-FogPendingMac', 'Disable-FogApiHTTPS', 'Dismount-WinEfi', 'Enable-FogApiHTTPS', 'Find-FogObject', 'Get-FogActiveTasks', 'Get-FogGroupAssociations', 'Get-FogGroupByName', 'Get-FogGroups', 'Get-FogHost', 'Get-FogHostAssociatedSnapins', 'Get-FogHostGroup', 'Get-FogHostMacs', 'Get-FogHostPendingMacs', 'Get-FogHosts', 'Get-FogImages', 'Get-FogInventory', 'Get-FogLog', 'Get-FogMacAddresses', 'Get-FogModules', 'Get-FogObject', 'Get-FogScheduledTasks', 'Get-FogSecsSinceEpoch', 'Get-FogServerSettings', 'Get-FogServerSettingsFile', 'Get-FogSetting', 'Get-FogSettings', 'Get-FogSnapinAssociations', 'Get-FogSnapins', 'Get-FogVersion', 'Get-LastImageTime', 'Get-WinBcdPxeID', 'Get-WinEfiMountLetter', 'Install-FogService', 'Invoke-FogApi', 'Mount-WinEfi', 'New-FogHost', 'New-FogObject', 'Receive-FogImage', 'Remove-FogObject', 'Remove-UsbMac', 'Repair-FogSnapinAssociations', 'Reset-HostEncryption', 'Resolve-HostID', 'Send-FogImage', 'Send-FogWolTask', 'Set-FogHostImage', 'Set-FogInventory', 'Set-FogServerSettings', 'Set-FogServerSettingsFileSecurity', 'Set-FogSetting', 'Set-FogSnapins', 'Set-WinToBootToPxe', 'Start-FogSnapin', 'Start-FogSnapins', 'Test-FogVerAbove1dot6', 'Test-StringNotNullOrEmpty', 'Update-FogObject' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = 'Add-FogHost', 'Add-FogObject', 'Add-FogSnapins', 'Capture-FogImage', 'Deploy-FogImage', 'Get-FogAssociatedSnapins', 'Get-FogGroup', 'Get-FogHostInventory', 'Get-FogHostSnapinAssociations', 'Get-FogHostSnapins', 'Get-FogMacs', 'Get-MacsForHost', 'Get-WinInventoryForFog', 'Invoke-FogImageCapture', 'Pull-FogImage', 'Push-FogImage', 'Remove-FogMac', 'Save-FogImage', 'Set-FogObject' # DSC resources to export from this module # DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = 'fog', 'fogapi', 'imaging', 'provisioning', 'fogproject' # A URL to the license for this module. LicenseUri = 'https://github.com/darksidemilk/FogApi/blob/master/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/darksidemilk/FogApi' # A URL to an icon representing this module. IconUri = 'https://cdn.statically.io/gh/darksidemilk/FogApi/0ed5e87e/FogApi/icons/favicon.png' # ReleaseNotes of this module ReleaseNotes = ' # 2508.9.23 Fix #41 and add some other user experience improvements (#42) * Error in send-fogimage command Fixes #41 When powershell 5.1 is used, invoke-restmethod and invoke-webrequest don''t auto change the method from GET to POST when a body exists in the call. Added a check in invoke-fogapi for if body is not null and method is get, when true will change to a POST method. * Also added a failsafe try/catch in Get-FogScheduledTasks in case this still happens somehow. It will catch if the result is null. * Also found that active tasks weren''t always being force closed with -force. Changed the null/count check for active tasks to ensure they get canceled when -force is used with send-fogimage and ensured that both existing scheduled tasks and active tasks are checked for by separating their if/else branches. * Minor changes to setting fog settings. Fixing erroneous error when setting the security of the settings file as a standard user, set-acl was displaying an error even though it was being caught and falling back to icacls which works for a standard user. Also changed to using the internal Test-StringNotNullOrEmpty function for null checks when setting settings. * Add how to download and import a temp version of the dev branch module. * Add linux compatible dev import in readme. * Fixed a warning message typo * Pull help text from default settings file instead of hard coding it so only 1 place to update. Also testing for whitespace in apitokens and server name as a fallback for testing validity. Added a catch for if the fogserver name is specified as just a hostname, it will prepend http:// in this case and display a warning. * added a timer so linux users can read the warning before the editor opens to manually edit the settings file * display message about the wait before opening the commandline editor for linux users * default to vi instead of nano * added Quick vi/nano edit tips Full change log history available at https://fogapi.readthedocs.io/en/latest/ReleaseNotes/' # Prerelease string of this module # Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false # External dependent modules of this module # ExternalModuleDependencies = @() } # End of PSData hashtable # Title Title = 'FogApi' } # End of PrivateData hashtable # HelpInfo URI of this module HelpInfoURI = 'https://fogapi.readthedocs.io/en/latest/' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |