push release notes for new release

darksidemilk · Nov 17, 2020 · a9756af · a9756af
1 parent 6030341
commit a9756af
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 76 deletions.
diff --git 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
@@ -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 → docs/commands/Get-FogHostMacs.md b/docs/commands/Get-MacsForHost.md → docs/commands/Get-FogHostMacs.md
@@ -1,19 +1,19 @@
 ---
 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
 
 ## SYNTAX
 
 ```
-Get-MacsForHost [[-hostObject] <Object>] [<CommonParameters>]
+Get-FogHostMacs [[-hostObject] <Object>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION

diff --git 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
@@ -762,6 +762,72 @@ $groupAssocs | ? hostId -eq ((Get-FogHost).id)</dev:code>
       </maml:navigationLink>
     </command:relatedLinks>
   </command:command>
+  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
+    <command:details>
+      <command:name>Get-FogHostMacs</command:name>
+      <command:verb>Get</command:verb>
+      <command:noun>FogHostMacs</command:noun>
+      <maml:description>
+        <maml:para>Returns the macs assigned to a given host</maml:para>
+      </maml:description>
+    </command:details>
+    <maml:description>
+      <maml:para>Gets all macs and finds the ones with a matching hostid of the given object Use Get-FogHost to get the host object</maml:para>
+    </maml:description>
+    <command:syntax>
+      <command:syntaxItem>
+        <maml:name>Get-FogHostMacs</maml:name>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
+          <maml:name>hostObject</maml:name>
+          <maml:Description>
+            <maml:para>The host object you get with Get-Foghost</maml:para>
+          </maml:Description>
+          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
+          <dev:type>
+            <maml:name>Object</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>(Get-FogHost)</dev:defaultValue>
+        </command:parameter>
+      </command:syntaxItem>
+    </command:syntax>
+    <command:parameters>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
+        <maml:name>hostObject</maml:name>
+        <maml:Description>
+          <maml:para>The host object you get with Get-Foghost</maml:para>
+        </maml:Description>
+        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
+        <dev:type>
+          <maml:name>Object</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>(Get-FogHost)</dev:defaultValue>
+      </command:parameter>
+    </command:parameters>
+    <command:inputTypes />
+    <command:returnValues />
+    <maml:alertSet>
+      <maml:alert>
+        <maml:para></maml:para>
+      </maml:alert>
+    </maml:alertSet>
+    <command:examples>
+      <command:example>
+        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
+        <dev:code>Get-MacsForHost (Get-FogHost)</dev:code>
+        <dev:remarks>
+          <maml:para>Will return the macs assigned to the computer running the command</maml:para>
+        </dev:remarks>
+      </command:example>
+    </command:examples>
+    <command:relatedLinks>
+      <maml:navigationLink>
+        <maml:linkText>Online Version:</maml:linkText>
+        <maml:uri>https://fogapi.readthedocs.io/en/latest/commands/Get-FogHostMacs</maml:uri>
+      </maml:navigationLink>
+    </command:relatedLinks>
+  </command:command>
   <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
     <command:details>
       <command:name>Get-FogHosts</command:name>
@@ -1179,72 +1245,6 @@ Set-FogInventory -jsonData $json</dev:code>
       </maml:navigationLink>
     </command:relatedLinks>
   </command:command>
-  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
-    <command:details>
-      <command:name>Get-MacsForHost</command:name>
-      <command:verb>Get</command:verb>
-      <command:noun>MacsForHost</command:noun>
-      <maml:description>
-        <maml:para>Returns the macs assigned to a given host</maml:para>
-      </maml:description>
-    </command:details>
-    <maml:description>
-      <maml:para>Gets all macs and finds the ones with a matching hostid of the given object Use Get-FogHost to get the host object</maml:para>
-    </maml:description>
-    <command:syntax>
-      <command:syntaxItem>
-        <maml:name>Get-MacsForHost</maml:name>
-        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
-          <maml:name>hostObject</maml:name>
-          <maml:Description>
-            <maml:para>The host object you get with Get-Foghost</maml:para>
-          </maml:Description>
-          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
-          <dev:type>
-            <maml:name>Object</maml:name>
-            <maml:uri />
-          </dev:type>
-          <dev:defaultValue>(Get-FogHost)</dev:defaultValue>
-        </command:parameter>
-      </command:syntaxItem>
-    </command:syntax>
-    <command:parameters>
-      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
-        <maml:name>hostObject</maml:name>
-        <maml:Description>
-          <maml:para>The host object you get with Get-Foghost</maml:para>
-        </maml:Description>
-        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
-        <dev:type>
-          <maml:name>Object</maml:name>
-          <maml:uri />
-        </dev:type>
-        <dev:defaultValue>(Get-FogHost)</dev:defaultValue>
-      </command:parameter>
-    </command:parameters>
-    <command:inputTypes />
-    <command:returnValues />
-    <maml:alertSet>
-      <maml:alert>
-        <maml:para></maml:para>
-      </maml:alert>
-    </maml:alertSet>
-    <command:examples>
-      <command:example>
-        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
-        <dev:code>Get-MacsForHost (Get-FogHost)</dev:code>
-        <dev:remarks>
-          <maml:para>Will return the macs assigned to the computer running the command</maml:para>
-        </dev:remarks>
-      </command:example>
-    </command:examples>
-    <command:relatedLinks>
-      <maml:navigationLink>
-        <maml:linkText>Online Version:</maml:linkText>
-        <maml:uri>https://fogapi.readthedocs.io/en/latest/commands/Get-MacsForHost</maml:uri>
-      </maml:navigationLink>
-    </command:relatedLinks>
-  </command:command>
   <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
     <command:details>
       <command:name>Get-PendingMacsForHost</command:name>

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,14 +15,14 @@ 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'
     - 'Get-FogMacAddresses': 'commands/Get-FogMacAddresses.md'
     - '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'