-
Notifications
You must be signed in to change notification settings - Fork 0
Listing and Showing Resources
The list command makes it simple to print a quick view of all your profiles, scripts, or apps as well as their sync
status.
iructl profile list [OPTIONS]iructl script list [OPTIONS]iructl app list [OPTIONS]
If you would like to limit the list to remote or local resources only you can pass the --local or --remote flags
respectively. Similarly, if you want to only show resources with a specific status you can use the --include or
--exclude flags. Include and exclude can be used multiple times to specify more than one status. Available statuses
include: no_changes, new_remote, updated_remote, new_local, updated_local, conflict
The list output format can also be modified. By default, a simple human readable table is shown. However, if you
prefer more structured output, use the --format option to choose plist, json, or yaml. This can be especially
useful when piping iructl output to other command line tools.
Use the show command to display the full metadata and content of a custom resource.
iructl profile show [OPTIONS] PROFILEiructl script show [OPTIONS] SCRIPTiructl app show [OPTIONS] APP
The first argument should be the ID or path of a profile, script, or app.
By default, the local resource is shown in a human readable table format. This can be modified by passing the --remote
flag to show the Iru tenant's version. The --format option can be passed with plist, json, or yaml to display
the content and metadata in a specific structured format.
Additionally, for profiles you can pass the --profile flag to show only the profile mobileconfig content. For scripts,
you can pass --audit or --remediation to show their respective content. For apps, pass --script with audit,
preinstall, or postinstall to show a single script's content.
$ iructl profile show a5f20d99-315e-40b5-a3d5-7cd96f5f2ae4
Custom Profile Details (Local)
┌────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ ID │ a5f20d99-315e-40b5-a3d5-7cd96f5f2ae4 │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Name │ New Profile │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ MDM Identifier │ com.kandji.profile.custom.a5f20d99-315e-40b5-a3d5-7cd96f5f2ae4 │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Active │ False │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Runs On │ Mac, iPhone, iPad, TV, and Vision │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Created At │ 2025-04-22T14:48:36.481752Z │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Updated At │ 2025-04-22T14:48:36.481768Z │
├────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Profile │ <?xml version="1.0" encoding="UTF-8"?> │
│ │ <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.d… │
│ │ <plist version="1.0"> │
│ │ <dict> │
│ │ <key>PayloadContent</key> │
│ │ <array> │
│ │ <dict/> │
│ │ </array> │
│ │ <key>PayloadDisplayName</key> │
│ │ <string>New Profile</string> │
│ │ <key>PayloadIdentifier</key> │
│ │ <string>com.kandji.profile.custom.a5f20d99-315e-40b5-a3d5-7cd96f5f2ae4</string> │
│ │ <key>PayloadScope</key> │
│ │ <string>System</string> │
│ │ <key>PayloadType</key> │
│ │ <string>Configuration</string> │
│ │ <key>PayloadUUID</key> │
│ │ <string>e6291f0f-f825-51b8-9c95-faad71e73540</string> │
│ │ <key>PayloadVersion</key> │
│ │ <integer>1</integer> │
│ │ </dict> │
│ │ </plist> │
│ │ │
└────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘
$ iructl script show cb3260ce-006a-4985-b06e-d7ea52c09151
Custom Script Details (Local)
┌──────────────────────────┬────────────────────────────────────────────────────────┐
│ ID │ cb3260ce-006a-4985-b06e-d7ea52c09151 │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Name │ New Script │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Active │ False │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Execution Frequency │ Once │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Restart │ False │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Show in Self Service │ False │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Self Service Category ID │ │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Self Service Recommended │ │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Created At │ 2025-04-23T15:00:47.370018Z │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Updated At │ 2025-04-23T15:00:47.370018Z │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Audit Script │ #!/bin/zsh -f │
│ │ │
│ │ echo "Hello, World!" │
│ │ exit 0 │
│ │ │
├──────────────────────────┼────────────────────────────────────────────────────────┤
│ Remediation Script │ │
└──────────────────────────┴────────────────────────────────────────────────────────┘
$ iructl app show "apps/Example App"
Custom App Details (Local)
┌──────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ ID │ 8c709445-6e5f-44b3-8997-0c18346efa56 │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Name │ Example App │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Active │ False │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Install Type │ package │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Install Enforcement │ install_once │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Restart │ False │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ File Name │ ExampleApp.pkg │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ File SHA256 │ 07715b2ad9a33a0ab0f99892b40dc8a20e3f11dcd9e858bb92087cf56217fbed │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Show in Self Service │ False │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Self Service Category ID │ │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Self Service Recommended │ │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Created At │ - │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Updated At │ - │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Audit Script │ │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Preinstall Script │ │
├──────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ Postinstall Script │ │
└──────────────────────────┴──────────────────────────────────────────────────────────────────┘
Getting Started
Working with Resources
- Populating Your Local Repository
- Editing Resources
- Self Service
- Pushing and Syncing
- Listing and Showing Resources
- Deleting Resources
- Blueprint Assignment
Reference
Python API Client