Merge pull request #463 from TheJumpCloud/SA-3118_Get_JCSystemApp

Sa 3118 get jc system app
TheJumpCloud · Feb 7, 2023 · 5cdab54 · 5cdab54
2 parents 5218306 + 93c5cdb
commit 5cdab54
Show file tree

Hide file tree

Showing 10 changed files with 1,012 additions and 23 deletions.
diff --git a/.circleci/workflows.yml b/.circleci/workflows.yml
@@ -32,7 +32,7 @@ parameters:
     description: "Release Type. Accepted values [ Major, Minor, Patch ]"
     type: enum
     enum: ["Major", "Minor", "Patch"]
-    default: "Patch"
+    default: "Minor"
   RequiredModulesRepo:
     description: "PowerShell Repository for JumpCloud SDKs"
     type: enum
@@ -49,7 +49,7 @@ parameters:
   PublishToPSGallery:
     description: "When `true` and when run against Master branch, this workflow will publish the latest code to PSGallery"
     type: boolean
-    default: false
+    default: true
   ManualModuleVersion:
     description: "When `true` the pipeline will use the Module Version specified in JumpCloud Module JumpCloud.psd1 file"
     type: boolean
@@ -101,18 +101,18 @@ workflows:
             - Initial Setup
             - Build Modules
           context: aws-credentials
-      - Module Validation Tests:
+      - Invoke Git Commit:
           requires:
             - Initial Setup
             - Build Help and Test Files
             - Build Nuspec
-            - Invoke Git Commit
-          context: aws-credentials
-      - Invoke Git Commit:
+      - Module Validation Tests:
           requires:
             - Initial Setup
             - Build Help and Test Files
             - Build Nuspec
+            - Invoke Git Commit
+          context: aws-credentials
       - Pester Tests Windows:
           requires:
             - Initial Setup
@@ -149,6 +149,7 @@ workflows:
     jobs:
       - Prepare for release
       - draft-github-release:
+          context: github-credentials-sa-releases
           requires:
             - Prepare for release
       - Approve Module:
@@ -310,7 +311,7 @@ commands:
     steps:
       - add_ssh_keys:
           fingerprints:
-            - "89:e7:20:1b:b1:a2:c2:2e:b8:d6:34:2f:73:80:a6:70"
+            - "c9:0f:56:c9:00:42:98:3c:03:59:24:1e:a7:e7:08:7f"
       - checkout
       - run:
           name: Set URLs
@@ -413,7 +414,7 @@ commands:
       - checkout
       - add_ssh_keys:
           fingerprints:
-            - "89:e7:20:1b:b1:a2:c2:2e:b8:d6:34:2f:73:80:a6:70"
+            - "c9:0f:56:c9:00:42:98:3c:03:59:24:1e:a7:e7:08:7f"
       - attach_workspace:
           at: .
       - run:
@@ -427,7 +428,7 @@ commands:
       - checkout
       - add_ssh_keys:
           fingerprints:
-            - "89:e7:20:1b:b1:a2:c2:2e:b8:d6:34:2f:73:80:a6:70"
+            - "c9:0f:56:c9:00:42:98:3c:03:59:24:1e:a7:e7:08:7f"
       - attach_workspace:
           at: .
       - run:
@@ -607,3 +608,4 @@ commands:
           root: .
           paths:
             - .
+# VS Code Extension Version: 1.5.1
diff --git a/PowerShell/JumpCloud Module/Docs/Get-JCSystemApp.md b/PowerShell/JumpCloud Module/Docs/Get-JCSystemApp.md
@@ -0,0 +1,170 @@
+---
+external help file: JumpCloud-help.xml
+Module Name: JumpCloud
+online version: https://github.com/TheJumpCloud/support/wiki/
+schema: 2.0.0
+---
+
+# Get-JCSystemApp
+
+## SYNOPSIS
+
+Returns the applications/programs/linux packages installed on JumpCloud managed system(s). This function queries separate system insights tables to get data for macOS/windows/linux devices.
+
+## SYNTAX
+
+### All (Default)
+```
+Get-JCSystemApp [-SystemID <String>] [-SystemOS <String>] [-name <String>] [-version <String>]
+ [<CommonParameters>]
+```
+
+### Search
+```
+Get-JCSystemApp [-SystemID <String>] [-SystemOS <String>] [-name <String>] [-version <String>] [-Search]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Get-JCSystem app function helps admins identify what applications/programs or linux packages exist on their JumpCloud managed systems.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS C:\> Get-JCSystemApp -SystemId '6363237ec991136ae59892e4'
+```
+
+Returns the applications installed in the system with the given -SystemId
+
+### Example 2
+
+```powershell
+PS C:\> Get-JCSystemApp -SystemOs 'macOS'
+```
+
+Returns the 'macOS' systems and all the applications installed for each system
+
+### Example 3
+
+```powershell
+PS C:\> Get-JCSystemApp -SystemOs 'macOS' -Name 'Jumpcloud'
+```
+
+### Example 4
+
+```powershell
+PS C:\> Get-JCSystemApp -SystemOs 'macOS' -Name 'Jumpcloud' -Version 'v1.16.2'
+```
+
+Returns the 'macOS' systems that have a 'Jumpcloud' tray application with the version 'v1.16.2'
+
+### Example 5
+
+```powershell
+PS C:\> Get-JCSystemApp -Name 'jumpcloud' -Search
+```
+
+Returns any 'jumpcloud' software installed in all the OS systems (Windows/Linux/macOS)
+
+## PARAMETERS
+
+### -name
+
+The name of the application you want to search for ex. (Jumpcloud, Slack). Name will always query the "name" property from system insights. Note, for macOS systems, ".app" will be applied. This field is case sensitive.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Search
+
+Search for a specific application by from all systems in the org ex.
+(Get-JCSystemApp -Search -Name "Jumpcloud")
+THIS PARAMETER DOES NOT TAKE INPUT
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: Search
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SystemID
+
+The System Id of the JumpCloud system you want to search for applications
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SystemOS
+
+The type (windows, mac, linux) of the JumpCloud Command you wish to search ex.
+(Windows, macOs, Linux))
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: Windows, macOS, Linux
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -version
+
+The version of the application you want to search for ex. 1.1.2. Note: on Windows/ Linux devices, this parameter will filter on the 'version' property, for macOS applications this parameter will filter on the 'bundleShortVersion' property.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String
+
+## OUTPUTS
+
+### System.Object
+## NOTES
+
+## RELATED LINKS
diff --git a/PowerShell/JumpCloud Module/Docs/JumpCloud.md b/PowerShell/JumpCloud Module/Docs/JumpCloud.md
@@ -2,7 +2,7 @@
 Module Name: JumpCloud
 Module Guid: 31c023d1-a901-48c4-90a3-082f91b31646
 Download Help Link: https://github.com/TheJumpCloud/support/wiki
-Help Version: 2.1.3
+Help Version: 2.2.0
 Locale: en-US
 ---
 
@@ -86,6 +86,9 @@ Return JumpCloud radius server information.
 ### [Get-JCSystem](Get-JCSystem.md)
 Returns all JumpCloud Systems within a JumpCloud tenant or a single JumpCloud System using the -ByID Parameter.
 
+### [Get-JCSystemApp](Get-JCSystemApp.md)
+Returns the applications/programs/linux packages installed on JumpCloud managed system(s). This function queries separate system insights tables to get data for macOS/windows/linux devices.
+
 ### [Get-JCSystemGroupMember](Get-JCSystemGroupMember.md)
 Returns the System Group members of a JumpCloud System Group.
 

diff --git a/PowerShell/JumpCloud Module/Docs/Set-JCSettingsFile.md b/PowerShell/JumpCloud Module/Docs/Set-JCSettingsFile.md
@@ -14,7 +14,7 @@ Updates the JumpCloud Module Settings File
 ## SYNTAX
 
 ```
-Set-JCSettingsFile [-moduleBannerMessageCount <PSObject>] [-parallelOverride <PSObject>] [<CommonParameters>]
+Set-JCSettingsFile [-parallelOverride <PSObject>] [-moduleBannerMessageCount <PSObject>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION

diff --git a/PowerShell/JumpCloud Module/JumpCloud.nuspec b/PowerShell/JumpCloud Module/JumpCloud.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>JumpCloud</id>
-    <version>2.1.3</version>
+    <version>2.2.0.7873-202302072022</version>
     <description>PowerShell functions to manage a JumpCloud Directory-as-a-Service</description>
     <authors>JumpCloud Solutions Architect Team</authors>
     <owners>JumpCloud</owners>

diff --git a/PowerShell/JumpCloud Module/JumpCloud.psd1 b/PowerShell/JumpCloud Module/JumpCloud.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: JumpCloud Solutions Architect Team
 #
-# Generated on: 1/6/2023
+# Generated on: 2/7/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'JumpCloud.psm1'
 
 # Version number of this module.
-ModuleVersion = '2.1.3'
+ModuleVersion = '2.2.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -80,15 +80,15 @@ FunctionsToExport = 'Add-JCAssociation', 'Add-JCCommandTarget',
                'Get-JCOrganization', 'Get-JCPolicy', 'Get-JCPolicyResult', 
                'Get-JCPolicyTargetGroup', 'Get-JCPolicyTargetSystem', 
                'Get-JCRadiusReplyAttribute', 'Get-JCRadiusServer', 'Get-JCSystem', 
-               'Get-JCSystemGroupMember', 'Get-JCSystemInsights', 'Get-JCSystemUser', 
-               'Get-JCUser', 'Get-JCUserGroupMember', 'Import-JCCommand', 
-               'Import-JCUsersFromCSV', 'Invoke-JCCommand', 'Invoke-JCDeployment', 
-               'New-JCCommand', 'New-JCDeploymentTemplate', 'New-JCImportTemplate', 
-               'New-JCRadiusServer', 'New-JCSystemGroup', 'New-JCUser', 
-               'New-JCUserGroup', 'Remove-JCAssociation', 'Remove-JCCommand', 
-               'Remove-JCCommandResult', 'Remove-JCCommandTarget', 
-               'Remove-JCRadiusReplyAttribute', 'Remove-JCRadiusServer', 
-               'Remove-JCSystem', 'Remove-JCSystemGroup', 
+               'Get-JCSystemApp', 'Get-JCSystemGroupMember', 'Get-JCSystemInsights', 
+               'Get-JCSystemUser', 'Get-JCUser', 'Get-JCUserGroupMember', 
+               'Import-JCCommand', 'Import-JCUsersFromCSV', 'Invoke-JCCommand', 
+               'Invoke-JCDeployment', 'New-JCCommand', 'New-JCDeploymentTemplate', 
+               'New-JCImportTemplate', 'New-JCRadiusServer', 'New-JCSystemGroup', 
+               'New-JCUser', 'New-JCUserGroup', 'Remove-JCAssociation', 
+               'Remove-JCCommand', 'Remove-JCCommandResult', 
+               'Remove-JCCommandTarget', 'Remove-JCRadiusReplyAttribute', 
+               'Remove-JCRadiusServer', 'Remove-JCSystem', 'Remove-JCSystemGroup', 
                'Remove-JCSystemGroupMember', 'Remove-JCSystemUser', 'Remove-JCUser', 
                'Remove-JCUserGroup', 'Remove-JCUserGroupMember', 
                'Send-JCPasswordReset', 'Set-JCCommand', 'Set-JCOrganization',