From a9756af38233e5a022620c34409af756ebf785a5 Mon Sep 17 00:00:00 2001 From: JJ Fullmer Date: Tue, 17 Nov 2020 11:56:34 -0700 Subject: [PATCH] push release notes for new release --- FogApi/FogApi.psd1 | 12 +- docs/ReleaseNotes.md | 4 + ...{Get-MacsForHost.md => Get-FogHostMacs.md} | 6 +- docs/commands/index.md | 4 +- docs/en-us/FogApi-help.xml | 132 +++++++++--------- mkdocs.yml | 2 +- 6 files changed, 84 insertions(+), 76 deletions(-) rename docs/commands/{Get-MacsForHost.md => Get-FogHostMacs.md} (92%) diff --git a/FogApi/FogApi.psd1 b/FogApi/FogApi.psd1 index a0e4750..1ce9ebe 100644 --- a/FogApi/FogApi.psd1 +++ b/FogApi/FogApi.psd1 @@ -12,7 +12,7 @@ RootModule = 'FogApi.psm1' # Version number of this module. -ModuleVersion = '2004.2.2.3' +ModuleVersion = '2004.2.2.4' # Supported PSEditions # CompatiblePSEditions = @() @@ -124,9 +124,9 @@ PowerShellVersion = '3.0' FunctionsToExport = 'Add-FogHostMac', 'Approve-FogPendingMac', 'Deny-FogPendingMac', 'Get-FogActiveTasks', 'Get-FogAssociatedSnapins', 'Get-FogGroupAssociations', 'Get-FogGroupByName', 'Get-FogGroups', - 'Get-FogHost', 'Get-FogHostGroup', 'Get-FogHosts', 'Get-FogInventory', - 'Get-FogLog', 'Get-FogMacAddresses', 'Get-FogObject', - 'Get-FogServerSettings', 'Get-FogSnapins', 'Get-MacsForHost', + 'Get-FogHost', 'Get-FogHostGroup', 'Get-FogHostMacs', 'Get-FogHosts', + 'Get-FogInventory', 'Get-FogLog', 'Get-FogMacAddresses', + 'Get-FogObject', 'Get-FogServerSettings', 'Get-FogSnapins', 'Get-PendingMacsForHost', 'Install-FogService', 'Invoke-FogApi', 'New-FogObject', 'Remove-FogObject', 'Remove-UsbMac', 'Reset-HostEncryption', 'Set-FogInventory', 'Set-FogServerSettings', @@ -172,6 +172,10 @@ PrivateData = @{ # ReleaseNotes of this module ReleaseNotes = ' +# 2004.2.2.4 + + Changed get-macsforhost to Get-FoghostMacs. Added output if get-foghost returns multiple hosts + # 2004.2.2.3 fix release note formatting error diff --git a/docs/ReleaseNotes.md b/docs/ReleaseNotes.md index 60e2fcf..0c0415f 100644 --- a/docs/ReleaseNotes.md +++ b/docs/ReleaseNotes.md @@ -1,4 +1,8 @@ +# 2004.2.2.4 + + Changed get-macsforhost to Get-FoghostMacs. Added output if get-foghost returns multiple hosts + # 2004.2.2.3 fix release note formatting error diff --git a/docs/commands/Get-MacsForHost.md b/docs/commands/Get-FogHostMacs.md similarity index 92% rename from docs/commands/Get-MacsForHost.md rename to docs/commands/Get-FogHostMacs.md index fe9ca07..28eff2e 100644 --- a/docs/commands/Get-MacsForHost.md +++ b/docs/commands/Get-FogHostMacs.md @@ -1,11 +1,11 @@ --- external help file: FogApi-help.xml Module Name: FogApi -online version: https://fogapi.readthedocs.io/en/latest/commands/Get-MacsForHost +online version: https://fogapi.readthedocs.io/en/latest/commands/Get-FogHostMacs schema: 2.0.0 --- -# Get-MacsForHost +# Get-FogHostMacs ## SYNOPSIS Returns the macs assigned to a given host @@ -13,7 +13,7 @@ Returns the macs assigned to a given host ## SYNTAX ``` -Get-MacsForHost [[-hostObject] ] [] +Get-FogHostMacs [[-hostObject] ] [] ``` ## DESCRIPTION diff --git a/docs/commands/index.md b/docs/commands/index.md index d8c69a7..7c0d0ba 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -20,6 +20,8 @@ ## [Get-FogHostGroup](Get-FogHostGroup.md) +## [Get-FogHostMacs](Get-FogHostMacs.md) + ## [Get-FogHosts](Get-FogHosts.md) ## [Get-FogInventory](Get-FogInventory.md) @@ -34,8 +36,6 @@ ## [Get-FogSnapins](Get-FogSnapins.md) -## [Get-MacsForHost](Get-MacsForHost.md) - ## [Get-PendingMacsForHost](Get-PendingMacsForHost.md) ## [Install-FogService](Install-FogService.md) diff --git a/docs/en-us/FogApi-help.xml b/docs/en-us/FogApi-help.xml index db3c3a7..eefaf88 100644 --- a/docs/en-us/FogApi-help.xml +++ b/docs/en-us/FogApi-help.xml @@ -762,6 +762,72 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id) + + + Get-FogHostMacs + Get + FogHostMacs + + Returns the macs assigned to a given host + + + + Gets all macs and finds the ones with a matching hostid of the given object Use Get-FogHost to get the host object + + + + Get-FogHostMacs + + hostObject + + The host object you get with Get-Foghost + + Object + + Object + + + (Get-FogHost) + + + + + + hostObject + + The host object you get with Get-Foghost + + Object + + Object + + + (Get-FogHost) + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-MacsForHost (Get-FogHost) + + Will return the macs assigned to the computer running the command + + + + + + Online Version: + https://fogapi.readthedocs.io/en/latest/commands/Get-FogHostMacs + + + Get-FogHosts @@ -1179,72 +1245,6 @@ Set-FogInventory -jsonData $json - - - Get-MacsForHost - Get - MacsForHost - - Returns the macs assigned to a given host - - - - Gets all macs and finds the ones with a matching hostid of the given object Use Get-FogHost to get the host object - - - - Get-MacsForHost - - hostObject - - The host object you get with Get-Foghost - - Object - - Object - - - (Get-FogHost) - - - - - - hostObject - - The host object you get with Get-Foghost - - Object - - Object - - - (Get-FogHost) - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-MacsForHost (Get-FogHost) - - Will return the macs assigned to the computer running the command - - - - - - Online Version: - https://fogapi.readthedocs.io/en/latest/commands/Get-MacsForHost - - - Get-PendingMacsForHost diff --git a/mkdocs.yml b/mkdocs.yml index c99ae76..fe8092d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ nav: - 'Get-FogGroups': 'commands/Get-FogGroups.md' - 'Get-FogHost': 'commands/Get-FogHost.md' - 'Get-FogHostGroup': 'commands/Get-FogHostGroup.md' + - 'Get-FogHostMacs': 'commands/Get-FogHostMacs.md' - 'Get-FogHosts': 'commands/Get-FogHosts.md' - 'Get-FogInventory': 'commands/Get-FogInventory.md' - 'Get-FogLog': 'commands/Get-FogLog.md' @@ -22,7 +23,6 @@ nav: - 'Get-FogObject': 'commands/Get-FogObject.md' - 'Get-FogServerSettings': 'commands/Get-FogServerSettings.md' - 'Get-FogSnapins': 'commands/Get-FogSnapins.md' - - 'Get-MacsForHost': 'commands/Get-MacsForHost.md' - 'Get-PendingMacsForHost': 'commands/Get-PendingMacsForHost.md' - 'Install-FogService': 'commands/Install-FogService.md' - 'Invoke-FogApi': 'commands/Invoke-FogApi.md'