FogApi

1.6

   To install this module you need at least powershell v3, was created with 5.1 and intended to be cross platform compatible with powershell v6
   To Install this module follow these steps
   * Easiest method: Install from PSGallery https://www.powershellgallery.com/packages/FogApi Install-Module -name fogApi
   
   * Manual Method:
   * download the zip o
   To install this module you need at least powershell v3, was created with 5.1 and intended to be cross platform compatible with powershell v6
   To Install this module follow these steps
   * Easiest method: Install from PSGallery https://www.powershellgallery.com/packages/FogApi Install-Module -name fogApi
   
   * Manual Method:
   * download the zip of this repo https://github.com/FOGProject/fog-community-scripts/archive/master.zip and extract it
       * Or clone the repo using your favorite git tool, you just need the FogApi Folder this readme is in
   * Copy the FogApi folder this Readme file is in to...
       * For Windows Powershell v3-v5.1
           * C:\Program Files\WindowsPowershell\Modules
       * For Windows Powershell v6+
           * C:\Program Files\PowerShell\6-preview\Modules
               * 6-Preview may need to be replaced with whatever current version you have installed
       * For Linux Powershell v6+
           * /opt/microsoft/powershell/6.1.0-preview.2/Modules
               * 6.1.0-preview.2 may need to be replaced with whatever current version you have installed
       * For Mac Powershell v6+ (untested)
           * /usr/local/microsoft/powershell/6.x/Modules
               * 6.x should be replaced with whatever most current version you are using
               * I haven't tested this on a mac, the module folder may be somewhere else
               this is based on where it is in other powershell 6 installs
   * Open a powershell command prompt (I always run as admin, unsure if it's required)
   * Run Import-Module FogApi
   
   The module is now installed.
   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
   
   i.e.
   
   Get-FogObject has a type param that validates to object, objectactivetasktype, and search as those are the options given in the documentation.
   Each of those types validates (which means autocompletion) to the core types listed in the documentation.
   So if you typed in Get-FogObject -Type object -coreObject  h and then started hitting tab, it would loop through the possible core objects you can get from the api that start with 'h' such as history, host, etc.
   
   see also the fogforum thread for the module https://forums.fogproject.org/topic/12026/powershell-api-module/2

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 1.6

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

Author(s)

JJ Fullmer

Copyright

(c) 2018 JJ Fullmer. All rights reserved.

Owners

Tags

Fog Restful API imaging fogproject

Functions

Get-DynmicParam Set-DynamicParams Get-FogServerSettings Set-FogServerSettings Invoke-FogApi Get-FogObject New-FogObject Update-FogObject Remove-FogObject Install-FogService

Dependencies

This module has no dependencies.

Release Notes

Release Versions:
               v 1.5 - Added dynamic parameters and added get-fogserversettings and set-fogserversettings to allow for setting the api keys and server name in the shell
                           One known issue with the dynamic parameters is that they currently are not working as expected with positions they have to be named. i.e. you have to say get-fogobject -type object -coreObject host not Get-FogObject object host like I wanted
                           The auto complete works for positional parameters but the function doesn't seem to think there's a vaule for the parameter.
               v 1.3 - added better description and links, fixed new-fogobject to not require id for all POST api calls as there is no id yet for new items.
               v 1.2 - Initial Release, allow for easy manipulation of FOG server data with powershell objects'

Version History

Version Downloads Last updated
2103.2.12 1,874 3/26/2021
2004.2.2.7 58 12/3/2020
2004.2.2.4 12 11/17/2020
2002.2.1.2 65 4/21/2020
1903.0.0.22 80 9/25/2019
1.6 (current version) 265 6/11/2018
1.2 13 6/5/2018
Show less