PayloadKit

Network Share Mounter

de.fau.rrze.NetworkShareMounter

Network Share Mounter settings

macOS

Configuration Keys (33)

Showing 33 of 33 keys

KeyTypeDescriptionDefaultRange

Managed network shares

arrayArray with managed network shares that are centrally deployed to users.Default: —Range: —
dict—Default: —Range: —

Server and share

required
stringThe share URL, e.g. smb://fileserver.example.com/share. Note: %USERNAME% is replaced at runtime with the user's macOS login name.Default: —Range: —
authTypestring

Authentication type

required
stringAuthentication method: krb (Kerberos/SSO), pwd (username + password), or guest. Default: krb.Default: "krb"Range: Kerberos (krb), Password (pwd), Guest (guest)
usernamestring

Username (Optional)

stringPre-defines a username for pwd-type shares. If omitted, the user is prompted.Default: —Range: —

Mount point name (Optional)

stringOverrides the local directory name used as the mount point. Only relevant when the mount location is not /Volumes. Leave blank to use the share name (recommended).Default: —Range: —

Externally managed Kerberos tickets

stringSet to true if Kerberos tickets for this share are managed externally (AD binding, Jamf Connect, Apple SSO Extension). NSM will mount the share without interfering with ticket management and will not prompt for a Kerberos profile. Only relevant for authType: krb.Default: "false"Range: Yes (true), No (false)

Per-share Kerberos realm (Optional)

stringPer-share Kerberos realm override. Used together with externalKerberosManagement to identify which external profile to assign. Defaults to the global kerberosRealm setting.Default: —Range: —
autoMountstring

Automatically mount

stringtrue (default): the share is mounted automatically at startup and on network changes. false: the share appears in the menu but is never mounted automatically - the user can mount it on demand.Default: "true"Range: Yes (true), No (false)

Kerberos Realm

stringKerberos/AD domain for user authentication (e.g. EXAMPLE.COM). When set, NSM manages Kerberos ticket acquisition and renewal automatically. Required for app-managed Kerberos SSO.Default: ""Range: —

Kerberos Profile Display Name

stringFriendly display name for the Kerberos authentication profile shown in the app's Settings. If not set, the realm name (e.g. EXAMPLE.COM) is used as-is.Default: —Range: —

Username Override

stringOverrides the %USERNAME% variable used in share paths. Use this when the local macOS login name differs from the AD or network username.Default: —Range: —

Single User Mode

booleanIf true, automatic Kerberos sign-in and ticket renewal only process the default account. If false, all configured accounts are processed.Default: falseRange: —

Password Expiration Countdown Start Day

integerPassive warning. Days before password expiry when a silent countdown item first appears in the menu bar. The user only sees it when they open the menu. Set to 0 to disable all password expiration features entirely. Mirrors the Apple Kerberos SSO Extension key of the same name.Default: 14Range: —

Password Expiration Notification Start Day

integerActive warning. Days before password expiry when an alert dialog is shown automatically, once per calendar day. Set this lower than ExpirationCountdownStartDay so the dialog only interrupts when expiry is genuinely imminent. Mirrors the Jamf Connect / Apple Kerberos SSO Extension key of the same name.Default: 14Range: —

Password Change URL

stringURL of a web-based password self-service portal (SSPR). If set, a Change Password button in the expiration dialog opens this URL in the default browser. If not set, the user can change their password directly within NSM (requires kerberosRealm).Default: —Range: —

Allow Password Change

booleanWhen true, a permanent Change Password... item is shown in the menu bar at all times, even before the expiry threshold is reached. It automatically transforms into the expiry countdown when the threshold is reached. If passwordChangeURL is also set, clicking the item opens that URL instead of the in-app dialog. Mirrors the Apple Kerberos SSO Extension key of the same name.Default: falseRange: —
autostartboolean

Enable Autostart

booleanWhen deployed as a locked MDM key, the value is enforced on every app launch. When deployed as an unlocked default, it is applied once on the first launch only - after that, the user retains control.Default: falseRange: —

Can Change Autostart

booleanControls only the autostart toggle in the app's Settings UI. Set to false to grey it out. Does not affect MDM enforcement. To enforce the autostart state on every launch, deploy autostart as a locked key instead.Default: trueRange: —
canQuitboolean

Allow to Quit App

booleanWhen true, the user can quit the app via the menu bar. Set to false to remove the Quit item entirely.Default: trueRange: —

Unmount Shares on Exit

booleanWhen true, all managed shares are automatically unmounted when the app quits.Default: trueRange: —
locationstring

Mount path

stringPath where network shares are mounted. The default is a localized folder in the user's home directory (e.g. ~/Network Shares). It is strongly recommended to leave this empty and use the default - changing it can break Finder integration.Default: ""Range: —

Use the new default mount location

booleanIf true, shares are mounted under /Volumes by default instead of the legacy per-user location. Ignored if 'location' is set.Default: falseRange: —

Use Localized Mount Folder Name

booleanIf false, always uses the English folder name 'Networkshares' for the legacy default mount path instead of a name localized to the user's language. Only relevant when 'useNewDefaultLocation' is false.Default: trueRange: —

Clean up obstructing files and directories

booleanWhen true, NSM removes files and empty directories from the mount location that would prevent a share from mounting. Read the documentation carefully before enabling - this modifies the user's file system.Default: falseRange: —
helpURLstring

Help URL

stringURL to your organization's internal helpdesk or IT documentation. When set, an About Network Share Mounter item appears in the menu bar, opening this URL in the default browser.Default: ""Range: —

Disable Auto Update Framework

booleanMaster switch. Set to true to completely disable the Sparkle update framework. When disabled, no update checks occur and the Check for Updates menu item is removed.Default: falseRange: —

Enable Automatic Update Checks

booleanWhen the framework is enabled, controls whether NSM actively checks for new versions in the background. Set to false to suppress checks while keeping the framework loaded.Default: trueRange: —

Automatically Install Updates

booleanWhen true, updates are downloaded and installed automatically without asking the user for confirmation. Only takes effect when SUEnableAutomaticChecks is also true.Default: trueRange: —

Send Diagnostic Data

booleanIf true, diagnostic and crash data is sent to help improve the app. Independent of 'disableDiagnostics', which only hides the section in Settings.Default: trueRange: —

Disable Diagnostics

booleanWhen true, hides the hidden "Diagnostics" trigger in Settings and General (five consecutive clicks) that lets users send NSM's unified-log activity to the developers for troubleshooting. Use this to prevent users from sending diagnostic data off-device, e.g. for data-privacy reasons.Default: falseRange: —

Enable AutoUpdater Framework

booleanDeprecated since version 4. Use 'disableAutoUpdateFramework' instead (inverted logic: enableAutoUpdater = true equals disableAutoUpdateFramework = false).Default: trueRange: —

Network shares (deprecated, legacy)

arrayLegacy array with all network shares. Example: smb://filer.your.domain/share. Note: %USERNAME% will be replaced with the login name of the current user. Still accepted for backward compatibility but should not be used in new profiles - use managedNetworkShares instead.Default: —Range: —
string
string—Default: —Range: —