Public/New-Jamf.ps1
|
<# .SYNOPSIS Create a new resource or record in Jamf Pro. .DESCRIPTION The New-Jamf cmdlet allows you to create a new resource or record in a Jamf Pro system, which is a comprehensive management solution for macOS and iOS devices. You can use this cmdlet to add new assets, configurations, or other entities to your Jamf Pro environment. Ensure that you have the necessary permissions and access to perform this action. .PARAMETER Component Specifies the component or resource name in Jamf Pro from which to create data. This parameter is mandatory. .PARAMETER Select Specifies the fields to use to submit data to. The UPPERCASE values are to indicate the parameters for -Param. This parameter is mandatory. .PARAMETER Params Specifies additional parameters required for filtering or customizing the data retrieval. Parameters are indicated by UPPERCASE from -Select .PARAMETER Content The content to send to jamf this can be in json, PSObject or jamf simple xml format. .EXAMPLE New-Jamf -Component computers -Select 'ID/recalculate-smart-groups' -Param 420 Recalculates the smart group for the given computer id and then returns the count of smart groups the computer falls into. .EXAMPLE $NewScript = [PSCustomObject]@{ 'script' = @{ 'name' = 'Supa script'; 'category' = 'Testing'; 'info' = 'Script information'; 'notes' = 'Created 20230420'; 'priority' = 'Before'; 'parameters' = @{ 'parameter4' = 'Some input'; } 'os_requirements' = '10.15'; 'script_contents' = '#!/bin/ echo "Are you there?' } } New-Jamf -Component scripts -Select ID -Params 999 -Content $NewScript Creates a script 'Supa script', an ID must be supplied but will use next ID. #> function New-Jamf { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter( Position = 0, Mandatory)] [ValidateSet('accounts','advanced-mobile-device-searches','advanced-user-content-searches','advancedcomputersearches','advancedmobiledevicesearches','advancedusersearches','allowedfileextensions','api-integrations','api-roles','app-request','auth','azure-ad-migration','branding','buildings','categories','check-in','classes','cloud-azure','cloud-idp','cloud-ldaps','computer-inventory-collection-settings','computer-prestages','computercommands','computerextensionattributes','computergroups','computerinvitations','computers-inventory','computers','csa','current','departments','deploy-package','device-communication-settings','device-enrollments','directorybindings','diskencryptionconfigurations','distributionpoints','dockitems','ebooks','engage','enrollment-customization','enrollment-customizations','enrollment','fileuploads','healthcarelistenerrule','history','ibeacons','icon','initialize','initialize-database-connection','invalidateToken','inventory-preload','issueTomcatSslCertificate','jamf-connect','jamf-management-framework','jamf-pro-server-url','jamf-protect','jsonwebtokenconfigurations','keepAlive','ldap-keystore','ldapservers','licensedsoftware','macapplications','macos-managed-software-updates','managedpreferenceprofiles','mdm','mobile-device-apps','mobile-device-groups','mobile-device-prestages','mobile-devices','mobiledeviceapplications','mobiledevicecommands','mobiledeviceconfigurationprofiles','mobiledeviceenrollmentprofiles','mobiledeviceextensionattributes','mobiledevicegroups','mobiledeviceinvitations','mobiledeviceprovisioningprofiles','mobiledevices','networksegments','osxconfigurationprofiles','packages','parent-app','patch-management-accept-disclaimer','patch-policies','patch-software-title-configurations','patches','patchexternalsources','patchpolicies','patchsoftwaretitles','peripherals','peripheraltypes','pki','policies','printers','reenrollment','remote-administration-configurations','removablemacaddresses','restrictedsoftware','scripts','search-mobile-devices','self-service','sites','smart-computer-groups','smart-mobile-device-groups','smart-user-groups','softwareupdateservers','sso','supervision-identities','system','teacher-app','tokens','updateSession','userextensionattributes','usergroups','users','validate-csv','volume-purchasing-locations','volume-purchasing-subscriptions','vppaccounts','vppassignments','vppinvitations','webhooks')] [ValidateNotNullOrEmpty()] [String]$Component, [Parameter( Position = 2, Mandatory = $false, ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] [String[]]$Params, [Parameter( Position = 3, Mandatory = $false)] [ValidateNotNullOrEmpty()] $Content ) DynamicParam { $ValidOptions = @( Get-ValidOption -Method 'post' -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 ( $Content ) { # Convert content to Simple XML if ( $Content.GetType().Name -eq 'XmlDocument' ) { Write-Debug "Content type: XML" $Content = $Content.InnerXml } elseif ( $Content.GetType().Name -eq 'PSCustomObject' ) { Write-Debug "Content type: PSObject" $Content = ( ConvertTo-SimpleXml $Content ) } elseif ( $Content.GetType().Name -eq 'String' ) { Write-Debug "Content type: String" try { $Content = ( [xml]$Content ).InnerXml Write-Debug "Content in XML format" } catch { try { $Content = ConvertFrom-Json -InputObject $Content Write-Debug "Content in Json format" } catch { Write-Debug "Could not format content" break } } } $AppType = 'application/xml' } else { $AppType = 'application/json' } if ( $ReplaceMatches.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 ) { $RestURL = $Path.URL -replace $replace, $Params[$replacementCounter] $replacementCounter++ } $BaseURL = 'https:/', $TokenJamfPSPro.Server, $Path.API -join '/' $RestPath = 'https:/', $TokenJamfPSPro.Server, $Path.API, $RestURL -join '/' if ($PSCmdlet.ShouldProcess("$Component",'Create')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'post' -Body $Content -AppType $AppType if ( $Result.IsSuccessStatusCode -eq $true ) { return [pscustomobject]@{ Action = 'Created' Path = $RestURL Content = $Content Result = $Result } } 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("$Component",'Create')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'post' -Body $Content -AppType $AppType if ( $Result.IsSuccessStatusCode -eq $true) { $Results.Add( [pscustomobject]@{ Action = 'Created' Path = $RestURL Content = $Content Result = $Result } ) } 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("$Component",'Create')){ $Result = Invoke-JamfAPICall -Path $RestPath -BaseURL $BaseURL -Method 'post' -Body $Content -AppType $AppType if ( $Result.IsSuccessStatusCode -eq $true ) { return [pscustomobject]@{ Action = 'Created' Path = $RestURL Content = $Content Result = $Result } } else { Write-Error (Get-ErrorMessage $Result) } } } } } |