FogApi

2409.9.16


# 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 GU

# 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 #}`

## Year/Month

This versioning shows you first the Year and month this version of the module was published, giving you an idea of when it was last updated.
i.e. 2208 would be august 2022.

## Major

The Major version follows the typical major versioning where any major changes will increment this version number, especially possible breaking changes or structural changes, etc.

## Minor/Revision

Any time I publish a new version that isn't a major change I'll increment the revision. This may also be incremented for each build test and increment by more than one for each published version

# Usage

You can use Set-fogserverSettings to set your fogserver hostname and api keys.
The first time you try to run a command the settings.json file will automatically open
in notepad on windows, nano on linux, or TextEdit on Mac
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 can''t have comments

Once the settings are set you can have a jolly good time utilzing the fog documentation
found here https://news.fogproject.org/simplified-api-documentation/ that was used to model the parameters

See https://github.com/darksidemilk/FogApi/blob/master/README.md for more examples and see https://fogapi.readthedocs.io/en/latest/commands/ for a list of all the commands

# Additional info

See also the fogforum thread for the module https://forums.fogproject.org/topic/12026/powershell-api-module/2
Full change log available at https://fogapi.readthedocs.io/en/latest/ReleaseNotes/
Show more

Minimum PowerShell version

3.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name FogApi -RequiredVersion 2409.9.16

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name FogApi -Version 2409.9.16

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

2018-2024

Package Details

Author(s)

  • JJ Fullmer

Tags

fog fogapi imaging provisioning fogproject

Functions

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-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

Dependencies

This module has no dependencies.

Release Notes


# 2409.9.16

add publishing chocolatey package to release flow (#22)

* Updated docs to be more unified in their appearance where information is purposely duplicated.

* Added icon to module files and included staically.io cdn version of icon in manifest. Unified the manifest description with the Readme as the manifest description is  used in choco package description.
Want to be sure any new user gets the same information now matter how they find the module.

* Added chocolatey packaging that includes the psgetmoduleinfo.xml to install the module in an alternative method outside of psget and psresourceget while maintaining compatibility with psget and psresourceget.
Also reordered some functions in the build script and made other various improvements to the build process.

* Added comment in the set-fogserversettings function help and a warning when running in linux about paste issues that sometimes occur when running set-fogserversettings -interactive.

* Updated and unified various docs, added icon packaging with best practicies for chocolatey and psgallery. Updated chocolatey packaging and build functions. Updated docs for set-fogserversettings.md and added psresourceget methods to invoke-modulebuild for test builds to use the same methodology as prod builds

* use '-' instead of '*' in markdown formats

* verbage fix and add forums link

* unify the overview docs

* Fix choco template issue of typo of folder name sources vs files

* Shortened the manifest and nuspec description

* Update files section of nuspec to properly include the module files

* Added gpu properties to get-foginventory for upcoming add of gpu info to fog inventory records and fixed missing functions in in get-winbcdpxeid

* Added nuspec and psgetmodule info templates

* Updates to release note formatting, manifest description format, and build script improvements

* Updated Send-FogImage with params for 1.6 and added switch options and autocomplete for available fog images. Also added a basic Set-FogHostImage function, needs to be further flushes out but the basic functionality is there.

* Filter out rdp display driver when getting host inventory details and append video memory in GB to each adapter name

* revert change of appending gpu ram as it doesn't work for all gpus equally

* Update tag-and-release.yml - Comment out the choco community publish, will continue to have the choco nupkg attached to the release until the first version is approved.


Full change log history available at https://fogapi.readthedocs.io/en/latest/ReleaseNotes/

FileList

Version History

Version Downloads Last updated
2411.9.17 1,284 11/17/2024
2409.9.16 (current version) 5,036 9/14/2024
2409.9.4 852 9/4/2024
2408.9.3 566 8/30/2024
2408.9.2 575 8/22/2024
2311.6.4 17,243 11/17/2023
2310.6.3 563 10/11/2023
2310.6.2 13 10/11/2023
2304.5.41 3,934 4/12/2023
2302.5.40 10 4/12/2023
2302.5.33 330 3/29/2023
2302.5.26 46 3/1/2023
2209.4.5 222 10/21/2022
2209.4.1 350 10/12/2022
2208.3.3 593 8/24/2022
2208.3.1 20 8/23/2022
2103.2.13 18 8/23/2022
2103.2.12 1,926 3/26/2021
2004.2.2.7 74 12/3/2020
2004.2.2.4 27 11/17/2020
2002.2.1.2 80 4/21/2020
1903.0.0.22 96 9/25/2019
1.6 285 6/11/2018
1.2 31 6/5/2018
Show more