Public/Get-Jamf.ps1
|
<# .SYNOPSIS Retrieve data from Jamf Pro. .DESCRIPTION The Get-Jamf cmdlet allows you to retrieve data from Jamf Pro, a comprehensive management solution for macOS and iOS devices. This cmdlet provides various options for fetching specific information from Jamf Pro based on your requirements. You can specify the component, select fields, and provide additional parameters to customize your data retrieval. Note: Ensure that you have proper permissions and access to Jamf Pro. .PARAMETER Component Specifies the component or resource name in Jamf Pro from which to retrieve data. This parameter is mandatory. .PARAMETER Select Specifies the fields to use to retrieved data. The UPPERCASE values are to indicate the parameters for -Param. The 'all' selection is available to some components to retrieve all available fields, no -Param option is required in this case. This parameter is mandatory. .PARAMETER Params Specifies additional parameters required for filtering or customizing the data retrieval. Parameters are indicated by UPPERCASE from -Select .EXAMPLE Get-Jamf -Component computers -Select all Retrieves all available information for computers in Jamf Pro. .EXAMPLE Get-Jamf -Component computers -Select NAME -Param 'MacBookPro69' Retrieves the computer object details for the computer names 'MacBookPro69' .EXAMPLE Get-Jamf -Component local-admin-password -Select 'CLIENTMANAGEMENTID/account/USERNAME/audit' -Param 69, 'myUser' #> function Get-Jamf { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter( Position = 0, Mandatory)] [ValidateSet('accounts','activationcode','admin-accounts','adue-session-token-settings','advanced-mobile-device-searches','advanced-user-content-searches','advancedcomputersearches','advancedmobiledevicesearches','advancedusersearches','alerts','allowedfileextensions','api-integrations','api-role-privileges','api-roles','app-request','app-store-country-codes','auth','azure-ad-migration','branding-images','buildings','byoprofiles','cache-settings','categories','check-in','classes','classic-ldap','cloud-azure','cloud-idp','cloud-information','cloud-ldaps','computer-groups','computer-inventory-collection-settings','computer-prestages','computerapplications','computerapplicationusage','computercheckin','computercommands','computerextensionattributes','computergroups','computerhardwaresoftwarereports','computerhistory','computerinventorycollection','computerinvitations','computermanagement','computerreports','computers','computers-inventory','computers-inventory-detail','conditional-access','csa','csv-template','dashboard','departments','device-communication-settings','device-enrollments','directorybindings','diskencryptionconfigurations','distributionpoints','dockitems','ebooks','engage','enrollment','enrollment-customization','enrollment-customizations','extensionAttributes','groups','gsxconnection','healthcarelistener','healthcarelistenerrule','history','ibeacons','icon','infrastructuremanager','inventory-information','inventory-preload','jamf-connect','jamf-package','jamf-pro-information','jamf-pro-server-url','jamf-pro-version','jamf-protect','jsonwebtokenconfigurations','jssuser','ldap','ldapservers','licensedsoftware','local-admin-password','locales','macapplications','macos-managed-software-updates','managed-software-updates','managedpreferenceprofiles','mdm','mobile-device-enrollment-profile','mobile-device-groups','mobile-device-prestages','mobile-devices','mobiledeviceapplications','mobiledevicecommands','mobiledeviceconfigurationprofiles','mobiledeviceenrollmentprofiles','mobiledeviceextensionattributes','mobiledevicegroups','mobiledevicehistory','mobiledeviceinvitations','mobiledeviceprovisioningprofiles','mobiledevices','networksegments','notifications','obj','osxconfigurationprofiles','packages','parent-app','patch-policies','patch-software-title-configurations','patchavailabletitles','patches','patchexternalsources','patchinternalsources','patchpolicies','patchreports','patchsoftwaretitles','peripherals','peripheraltypes','pki','policies','policy-properties','printers','reenrollment','remote-administration-configurations','removablemacaddresses','restrictedsoftware','savedsearches','scripts','self-service','servers','sites','smtpserver','softwareupdateservers','sso','static-user-groups','subscriptions','supervision-identities','teacher-app','time-zones','user','userextensionattributes','usergroups','users','volume-purchasing-locations','volume-purchasing-subscriptions','vppaccounts','vppassignments','vppinvitations','webhooks')] [ValidateNotNullOrEmpty()] [String]$Component, [Parameter( Position = 2, Mandatory = $false, ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] [String[]]$Params ) DynamicParam { $ValidOptions = @( Get-ValidOption -Method 'get' -Component $Component ) Get-DynamicParam -Name Select -ValidateSet $ValidOptions.Option -Mandatory -Position 1 -HelpMessage "Specify the selection method of the 'component path'" } BEGIN { if ( $TokenJamfPSPro.Server -and $TokenJamfPSPro.credential ) { Connect-JamfPro -Server $TokenJamfPSPro.Server -Credential $TokenJamfPSPro.credential } else { Connect-JamfPro } $Path = $ValidOptions | Where-Object {$_.Option -eq $PSBoundParameters.Select} $ReplaceMatches = $Path.URL | Select-String -Pattern '{.*?}' -AllMatches $ReplacementCounter = 0 } PROCESS { if ( $ReplaceMatches.Matches.count -gt 1 ) { Write-Debug "Multi param path" Write-Debug "Path: $($Path.URL)" Write-Debug "Matches: $($ReplaceMatches.Matches.value)" foreach ( $replace in $ReplaceMatches.Matches.value ) { if ( $ReplacementCounter -eq 0 ) { $RestURL = $Path.URL -replace $replace, $Params[$ReplacementCounter] $ReplacementCounter++ } else { $RestURL = $RestURL -replace $replace, $Params[$ReplacementCounter] $ReplacementCounter++ } } $BaseURL = 'https:/', $TokenJamfPSPro.Server, $Path.API -join '/' $RestPath = 'https:/', $TokenJamfPSPro.Server, $Path.API, $RestURL -join '/' if ($PSCmdlet.ShouldProcess("$RestURL",'Get')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'get' if ( $Result.IsSuccessStatusCode -eq $true ) { return $Result | Select-Object * -ExcludeProperty IsSuccessStatusCode } else { Write-Error (Get-ErrorMessage $Result) } } } elseif ( $Params.count -gt 1 ) { Write-Debug "Multi params" Write-Debug "Path: $($Path.URL)" Write-Debug "Matches: $($ReplaceMatches.Matches.value)" $Results = New-Object System.Collections.Generic.List[System.Object] foreach ( $Param in $Params ) { $RestURL = $Path.URL -replace '{.*?}', $Param $BaseURL = 'https:/', $TokenJamfPSPro.Server, $Path.API -join '/' $RestPath = 'https:/', $TokenJamfPSPro.Server, $Path.API, $RestURL -join '/' if ($PSCmdlet.ShouldProcess("$RestURL",'Get')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'get' if ( $Result.IsSuccessStatusCode -eq $true ) { $Results.Add( ($Result | Select-Object * -ExcludeProperty IsSuccessStatusCode) ) } else { Write-Error (Get-ErrorMessage $Result) } } } return $Results } else { Write-Debug "Single param" Write-Debug "Path: $($Path.URL)" Write-Debug "Matches: $($ReplaceMatches.Matches.value)" $RestURL = $Path.URL -replace '{.*?}', $Params $BaseURL = 'https:/', $TokenJamfPSPro.Server, $Path.API -join '/' $RestPath = 'https:/', $TokenJamfPSPro.Server, $Path.API, $RestURL -join '/' if ($PSCmdlet.ShouldProcess("$RestURL",'Get')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'get' if ( $Result.IsSuccessStatusCode -eq $true ) { return $Result | Select-Object * -ExcludeProperty IsSuccessStatusCode } else { Write-Error (Get-ErrorMessage $Result) } } } } } |