macadmins / macadmins/jamf-pro-sdk-python

[Bug] Create/Update Advanced Computer Search Methods Sending Empty Criteria

Open
#55 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
69
Forks
16
PR merge metrics
No merged PRs in 30d

Description

tl;dr when attempting to create or update an advanced computer search (using the create_advanced_computer_search or update_advanced_computer_search_by_id methods, respectively), the operation is completed successfully, except for the search criteria. Name and display fields are set as configured, but any criteria sent are seemingly ignored, and the search is created/updated with no criteria. This effectively places every device into the results for the advanced computer search.

Reproduction details below will be for creating a search, but the result is the same when attempting to update an existing search.

Steps to Reproduce
from jamf_pro_sdk import JamfProClient, SessionConfig
from jamf_pro_sdk.models.classic import computer_groups, advanced_computer_searches
from jamf_pro_sdk.models.classic.criteria import ClassicCriterion
from jamf_pro_sdk.clients.auth import ApiClientCredentialsProvider

jamfClient = JamfProClient(
	server=jamfURL,
	credentials=ApiClientCredentialsProvider(jamfClientID, jamfClientSecret),
	session_config=SessionConfig(**{"timeout": 30, "max_retries": 3}),
)

notUpdatedSearchData = advanced_computer_searches.ClassicAdvancedComputerSearch(
	name="macOS Version Not Current",
	criteria=[
		ClassicCriterion(
			name='Managed',
			priority=0,
			and_or='and',
			search_type='is',
			value='Managed',
			opening_paren=False,
			closing_paren=False
		),
		ClassicCriterion(
			name='Operating System Version',
			priority=1,
			and_or='and',
			search_type='less than',
			value='15.1',
			opening_paren=False,
			closing_paren=False
		)
	],
	display_fields=[
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="JSS Computer ID"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Last Check-in"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Serial Number"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Operating System Version"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Username"
		),
	],
)

searchID = jamfClient.classic_api.create_advanced_computer_search(data=notUpdatedSearchData)
searchData = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=searchID)
print(searchData)

Expected Result

Expected an advanced computer search to be created with the following criteria:
image

Actual Result

Advanced computer search created with no criteria:
image

id=6 name='macOS Version Not Current' site=ClassicSite(id=-1, name='None') criteria=[] display_fields=[ClassicAdvancedComputerSearchDisplayField(name='Username'), ClassicAdvancedComputerSearchDisplayField(name='Operating System Version'), ClassicAdvancedComputerSearchDisplayField(name='JSS Computer ID'), ClassicAdvancedComputerSearchDisplayField(name='Serial Number'), ClassicAdvancedComputerSearchDisplayField(name='Last Check-in')] 

(omitted computers from above output)

Additional Data

If I retrieve the criteria from an existing advanced computer search (with correct criteria) and feed that directly into the create method, I would definitely expect this criteria to be valid and accepted. Even doing this, the new search is created with no criteria:

knownGoodSearchCriteria = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=5).criteria
print(knownGoodSearchCriteria)

####
[ClassicCriterion(name='Managed', priority=0, and_or='and', search_type='is', value='Managed', opening_paren=False, closing_paren=False), ClassicCriterion(name='Operating System Version', priority=1, and_or='and', search_type='less than', value='15.1', opening_paren=False, closing_paren=False)]
####

notUpdatedSearchData = advanced_computer_searches.ClassicAdvancedComputerSearch(
	name="macOS Version Not Current",
	criteria=knownGoodSearchCriteria,
	display_fields=[
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="JSS Computer ID"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Last Check-in"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Serial Number"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Operating System Version"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Username"
		),
	],
)

searchID = jamfClient.classic_api.create_advanced_computer_search(data=notUpdatedSearchData)
searchData = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=searchID)

print(searchData)

####
id=7 name='macOS Version Not Current' site=ClassicSite(id=-1, name='None') criteria=[] display_fields=[ClassicAdvancedComputerSearchDisplayField(name='Username'), ClassicAdvancedComputerSearchDisplayField(name='JSS Computer ID'), ClassicAdvancedComputerSearchDisplayField(name='Last Check-in'), ClassicAdvancedComputerSearchDisplayField(name='Serial Number'), ClassicAdvancedComputerSearchDisplayField(name='Operating System Version')]
####

(again omitted computers)

System Information

macOS 15.1
Python 3.12.1
SDK 0.6a2
Jamf Pro 11.10.2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the create_advanced_computer_search and update_advanced_computer_search_by_id entry points, then trace how ClassicAdvancedComputerSearch.criteria is serialized for the Jamf Pro request. Reproduce the issue with the provided criteria examples and verify that creating and updating a search preserve the criteria when retrieving it by ID.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.