PSGetModuleInfo.xml
|
<Objs Version="1.1.0.1" xmlns="http://schemas.microsoft.com/powershell/2004/04">
<Obj RefId="0"> <TN RefId="0"> <T>Microsoft.PowerShell.Commands.PSRepositoryItemInfo</T> <T>System.Management.Automation.PSCustomObject</T> <T>System.Object</T> </TN> <MS> <S N="Name">FogApi</S> <Version N="Version">1.5</Version> <S N="Type">Module</S> <S N="Description">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_x000D__x000A_ To Install this module follow these steps_x000D__x000A_ * Easiest method: Install from PSGallery https://www.powershellgallery.com/packages/FogApi Install-Module -name fogApi _x000D__x000A_ _x000D__x000A_ * Manual Method:_x000D__x000A_ * download the zip of this repo https://github.com/FOGProject/fog-community-scripts/archive/master.zip and extract it_x000D__x000A_ * Or clone the repo using your favorite git tool, you just need the FogApi Folder this readme is in_x000D__x000A_ * Copy the FogApi folder this Readme file is in to..._x000D__x000A_ * For Windows Powershell v3-v5.1_x000D__x000A_ * C:\Program Files\WindowsPowershell\Modules_x000D__x000A_ * For Windows Powershell v6+_x000D__x000A_ * C:\Program Files\PowerShell\6-preview\Modules_x000D__x000A_ * 6-Preview may need to be replaced with whatever current version you have installed_x000D__x000A_ * For Linux Powershell v6+_x000D__x000A_ * /opt/microsoft/powershell/6.1.0-preview.2/Modules_x000D__x000A_ * 6.1.0-preview.2 may need to be replaced with whatever current version you have installed_x000D__x000A_ * For Mac Powershell v6+ (untested)_x000D__x000A_ * /usr/local/microsoft/powershell/6.x/Modules_x000D__x000A_ * 6.x should be replaced with whatever most current version you are using_x000D__x000A_ * I haven't tested this on a mac, the module folder may be somewhere else_x000D__x000A_ this is based on where it is in other powershell 6 installs_x000D__x000A_ * Open a powershell command prompt (I always run as admin, unsure if it's required)_x000D__x000A_ * Run Import-Module FogApi_x000D__x000A_ _x000D__x000A_ The module is now installed. _x000D__x000A_ The first time you try to run a command the settings.json file will automatically open_x000D__x000A_ in notepad on windows, nano on linux, or TextEdit on Mac_x000D__x000A_ You can also open the settings.json file and edit it manually before running your first command._x000D__x000A_ The default settings are explanations of where to find the proper settings since json can't have comments_x000D__x000A_ _x000D__x000A_ Once the settings are set you can have a jolly good time utilzing the fog documentation _x000D__x000A_ found here https://news.fogproject.org/simplified-api-documentation/ that was used to model the parameters_x000D__x000A_ _x000D__x000A_ i.e._x000D__x000A_ _x000D__x000A_ Get-FogObject has a type param that validates to object, objectactivetasktype, and search as those are the options given in the documentation._x000D__x000A_ Each of those types validates (which means autocompletion) to the core types listed in the documentation._x000D__x000A_ 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._x000D__x000A_ _x000D__x000A_ see also the fogforum thread for the module https://forums.fogproject.org/topic/12026/powershell-api-module/2</S> <S N="Author">JJ Fullmer</S> <S N="CompanyName">DarkSideMilk</S> <S N="Copyright">(c) 2018 JJ Fullmer. All rights reserved.</S> <DT N="PublishedDate">2018-06-06T20:57:45-06:00</DT> <Obj N="InstalledDate" RefId="1"> <DT>2018-06-11T15:48:35.6807688-06:00</DT> <MS> <Obj N="DisplayHint" RefId="2"> <TN RefId="1"> <T>Microsoft.PowerShell.Commands.DisplayHintType</T> <T>System.Enum</T> <T>System.ValueType</T> <T>System.Object</T> </TN> <ToString>DateTime</ToString> <I32>2</I32> </Obj> </MS> </Obj> <Nil N="UpdatedDate" /> <URI N="LicenseUri">https://github.com/FOGProject/fog-community-scripts/blob/master/LICENSE</URI> <URI N="ProjectUri">https://github.com/FOGProject/fog-community-scripts/tree/master/PowershellModules/FogApi</URI> <URI N="IconUri">https://fogproject.org/images/favicon.ico</URI> <Obj N="Tags" RefId="3"> <TN RefId="2"> <T>System.Object[]</T> <T>System.Array</T> <T>System.Object</T> </TN> <LST> <S>Fog</S> <S>Restful</S> <S>API</S> <S>imaging</S> <S>fogproject</S> <S>PSModule</S> </LST> </Obj> <Obj N="Includes" RefId="4"> <TN RefId="3"> <T>System.Collections.Hashtable</T> <T>System.Object</T> </TN> <DCT> <En> <S N="Key">Function</S> <Obj N="Value" RefId="5"> <TNRef RefId="2" /> <LST> <S>Get-DynmicParam</S> <S>Set-DynamicParams</S> <S>Get-FogServerSettings</S> <S>Set-FogServerSettings</S> <S>Invoke-FogApi</S> <S>Get-FogObject</S> <S>New-FogObject</S> <S>Update-FogObject</S> <S>Remove-FogObject</S> <S>Install-FogService</S> </LST> </Obj> </En> <En> <S N="Key">RoleCapability</S> <Obj N="Value" RefId="6"> <TNRef RefId="2" /> <LST /> </Obj> </En> <En> <S N="Key">Command</S> <Obj N="Value" RefId="7"> <TNRef RefId="2" /> <LST> <S>Get-DynmicParam</S> <S>Set-DynamicParams</S> <S>Get-FogServerSettings</S> <S>Set-FogServerSettings</S> <S>Invoke-FogApi</S> <S>Get-FogObject</S> <S>New-FogObject</S> <S>Update-FogObject</S> <S>Remove-FogObject</S> <S>Install-FogService</S> </LST> </Obj> </En> <En> <S N="Key">DscResource</S> <Obj N="Value" RefId="8"> <TNRef RefId="2" /> <LST /> </Obj> </En> <En> <S N="Key">Workflow</S> <Obj N="Value" RefId="9"> <TNRef RefId="2" /> <LST /> </Obj> </En> <En> <S N="Key">Cmdlet</S> <Obj N="Value" RefId="10"> <TNRef RefId="2" /> <LST /> </Obj> </En> </DCT> </Obj> <Nil N="PowerShellGetFormatVersion" /> <S N="ReleaseNotes">Release Versions:_x000D__x000A_ 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_x000D__x000A_ 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_x000D__x000A_ The auto complete works for positional parameters but the function doesn't seem to think there's a vaule for the parameter. _x000D__x000A_ 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._x000D__x000A_ v 1.2 - Initial Release, allow for easy manipulation of FOG server data with powershell objects'</S> <Obj N="Dependencies" RefId="11"> <TNRef RefId="2" /> <LST /> </Obj> <S N="RepositorySourceLocation">https://www.powershellgallery.com/api/v2/</S> <S N="Repository">PSGallery</S> <S N="PackageManagementProvider">NuGet</S> <Obj N="AdditionalMetadata" RefId="12"> <TN RefId="4"> <T>System.Management.Automation.PSCustomObject</T> <T>System.Object</T> </TN> <MS> <S N="copyright">(c) 2018 JJ Fullmer. All rights reserved.</S> <S N="description">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_x000D__x000A_ To Install this module follow these steps_x000D__x000A_ * Easiest method: Install from PSGallery https://www.powershellgallery.com/packages/FogApi Install-Module -name fogApi _x000D__x000A_ _x000D__x000A_ * Manual Method:_x000D__x000A_ * download the zip of this repo https://github.com/FOGProject/fog-community-scripts/archive/master.zip and extract it_x000D__x000A_ * Or clone the repo using your favorite git tool, you just need the FogApi Folder this readme is in_x000D__x000A_ * Copy the FogApi folder this Readme file is in to..._x000D__x000A_ * For Windows Powershell v3-v5.1_x000D__x000A_ * C:\Program Files\WindowsPowershell\Modules_x000D__x000A_ * For Windows Powershell v6+_x000D__x000A_ * C:\Program Files\PowerShell\6-preview\Modules_x000D__x000A_ * 6-Preview may need to be replaced with whatever current version you have installed_x000D__x000A_ * For Linux Powershell v6+_x000D__x000A_ * /opt/microsoft/powershell/6.1.0-preview.2/Modules_x000D__x000A_ * 6.1.0-preview.2 may need to be replaced with whatever current version you have installed_x000D__x000A_ * For Mac Powershell v6+ (untested)_x000D__x000A_ * /usr/local/microsoft/powershell/6.x/Modules_x000D__x000A_ * 6.x should be replaced with whatever most current version you are using_x000D__x000A_ * I haven't tested this on a mac, the module folder may be somewhere else_x000D__x000A_ this is based on where it is in other powershell 6 installs_x000D__x000A_ * Open a powershell command prompt (I always run as admin, unsure if it's required)_x000D__x000A_ * Run Import-Module FogApi_x000D__x000A_ _x000D__x000A_ The module is now installed. _x000D__x000A_ The first time you try to run a command the settings.json file will automatically open_x000D__x000A_ in notepad on windows, nano on linux, or TextEdit on Mac_x000D__x000A_ You can also open the settings.json file and edit it manually before running your first command._x000D__x000A_ The default settings are explanations of where to find the proper settings since json can't have comments_x000D__x000A_ _x000D__x000A_ Once the settings are set you can have a jolly good time utilzing the fog documentation _x000D__x000A_ found here https://news.fogproject.org/simplified-api-documentation/ that was used to model the parameters_x000D__x000A_ _x000D__x000A_ i.e._x000D__x000A_ _x000D__x000A_ Get-FogObject has a type param that validates to object, objectactivetasktype, and search as those are the options given in the documentation._x000D__x000A_ Each of those types validates (which means autocompletion) to the core types listed in the documentation._x000D__x000A_ 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._x000D__x000A_ _x000D__x000A_ see also the fogforum thread for the module https://forums.fogproject.org/topic/12026/powershell-api-module/2</S> <S N="requireLicenseAcceptance">True</S> <S N="releaseNotes">Release Versions:_x000D__x000A_ 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_x000D__x000A_ 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_x000D__x000A_ The auto complete works for positional parameters but the function doesn't seem to think there's a vaule for the parameter. _x000D__x000A_ 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._x000D__x000A_ v 1.2 - Initial Release, allow for easy manipulation of FOG server data with powershell objects'</S> <S N="isLatestVersion">True</S> <S N="isAbsoluteLatestVersion">True</S> <S N="versionDownloadCount">7</S> <S N="downloadCount">9</S> <S N="packageSize">28191</S> <S N="published">6/6/2018 8:57:45 PM -06:00</S> <S N="created">6/6/2018 8:57:45 PM -06:00</S> <S N="tags">Fog Restful API imaging fogproject PSModule PSFunction_Get-DynmicParam PSCommand_Get-DynmicParam PSFunction_Set-DynamicParams PSCommand_Set-DynamicParams PSFunction_Get-FogServerSettings PSCommand_Get-FogServerSettings PSFunction_Set-FogServerSettings PSCommand_Set-FogServerSettings PSFunction_Invoke-FogApi PSCommand_Invoke-FogApi PSFunction_Get-FogObject PSCommand_Get-FogObject PSFunction_New-FogObject PSCommand_New-FogObject PSFunction_Update-FogObject PSCommand_Update-FogObject PSFunction_Remove-FogObject PSCommand_Remove-FogObject PSFunction_Install-FogService PSCommand_Install-FogService PSIncludes_Function</S> <S N="developmentDependency">False</S> <S N="updated">2018-06-11T21:48:23Z</S> <S N="NormalizedVersion">1.5.0</S> <S N="IsPrerelease">false</S> <S N="ItemType">Module</S> <S N="FileList">FogApi.nuspec|FogApi.psd1|FogApi.psm1|Readme.md|settings.json</S> <S N="GUID">7aa922fa-bb4f-46a0-a478-684e9535c65d</S> <S N="PowerShellVersion">3.0</S> <S N="CompanyName">FOG Project</S> </MS> </Obj> <S N="InstalledLocation">C:\Program Files\WindowsPowerShell\Modules\FogApi\1.5</S> </MS> </Obj> </Objs> |