StageNow

https://techdocs.zebra.com/stagenow/5-17/
Admin
StageNow is a Zebra Technologies tool designed for staging and configuring Zebra devices, offering...
Tokens:250,638
Snippets:3,393
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and Start Application

Source: https://techdocs.zebra.com/stagenow/5-17/csp/app

Installs an application from a specified APK path and then starts its main activity. This involves two separate characteristics: one for installation and another for starting the activity.

```xml
<wap-provisioningdoc>
    <characteristic version="4.2" type="AppMgr">
        <parm name="Action" value="Install" />
        <parm name="APK" value="/sdcard/myapp.apk" />
    </characteristic>
    <characteristic version="4.3" type="Intent">
        <parm name="Action" value="StartActivity" />
        <parm name="ActionName" value="android.intent.action.MAIN" />
        <parm name="Package" value="com.mypackage" />
        <parm name="Class" value="com.mypackage.myactivity" />
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Output for "Install Apps from Unknown Sources" Query

Source: https://techdocs.zebra.com/stagenow/5-17/csp/devadmin

Example output for a query of the 'Install Apps from Unknown Sources' setting, showing its current value. This query is not supported on Android 11 or later.

```xml
<wap-provisioningdoc>
    <characteristic type="DevAdmin" version="4.3">
        <parm name="UnknownSourcesStatus" value="1"/>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Client Certificate and Private Key (.PFX)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

Installs a client certificate and its private key from a .PFX file. Requires specifying the private key password.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="certName2"/>
            <parm name="CertType" value="8"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileClient" value="/path/to/cert.pem"/>
            <parm name="CertAdjustClock" value="false"/>
            <parm name="PrivateKeyPassword" value="pass"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Client Certificate (.PEM)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

Installs a client certificate from a .PEM file. Ensure the correct alias, type, and method are specified.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="certName2"/>
            <parm name="CertType" value="6"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileClient" value="/path/to/cert.pem"/>
            <parm name="CertAdjustClock" value="false"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Client Certificate and Private Key (.P12)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

Installs a client certificate and private key from a .P12 file. The private key password must be provided.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="certName2"/>
            <parm name="CertType" value="9"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileClient" value="/path/to/cert.pem"/>
            <parm name="CertAdjustClock" value="false"/>
            <parm name="PrivateKeyPassword" value="pass"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Browser Settings Output Example

Source: https://techdocs.zebra.com/stagenow/5-17/csp/browser

This is an example of the output received when querying all browser settings. It includes various parameters and their current values.

```xml
<wap-provisioningdoc>
    <characteristic type="BrowserMgr" version="4.3">
        <parm name="SetDefaultHomepage" value="http://www.google.com"/>
        <parm name="SetRememberPasswords" value="1"/>
        <parm name="SetSaveFormData" value="1"/>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Application

Source: https://techdocs.zebra.com/stagenow/5-17/csp/app

Silently installs an APK file from a specified path. Requires the 'Install' action and the 'APK' parameter.

```xml
<wap-provisioningdoc>
    <characteristic version="4.2" type="AppMgr">
        <parm name="Action" value="Install" />
        <parm name="APK" value="/enterprise/usr/persist/Clock.apk" />
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Example Network List File Content

Source: https://techdocs.zebra.com/stagenow/5-17/csp/networkconnectionmgr

This is an example of the content for a networkNamesListFile. The file should contain a prioritized list of cellular (WWAN) and Wi-Fi (WLAN) networks, with each entry on a new line. Entries must start with an access technology identifier followed by network information.

```text
WLAN_SSID1
WWAN_TestNetwork_001-01
WLAN_SSID2
WWAN_TestNet2_001-02
```

--------------------------------

### Install Client Certificate and Private Key (.PKCS12)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

Installs a client certificate and private key using the PKCS12 format. This method requires the private key password.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="certName2"/>
            <parm name="CertType" value="9"/>
            <parm name="CertMethod" value="10"/>
            <parm name="CertFileClient" value="/path/to/cert.pem"/>
            <parm name="CertAdjustClock" value="false"/>
            <parm name="PrivateKeyPassword" value="pass"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Client Certificate and Private Key (.PFX)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/cert

Installs a client certificate along with its private key from a .PFX file. This method supports PKCS12 encoded files (.P12, .PKCS12) and requires the private key password.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="mxtest"/>
            <parm name="CertType" value="8"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileClient" value="/enterprise/usr/persist/test.pfx"/>
            <parm name="CertAdjustClock" value="false"/>
            <parm name="PrivateKeyPassword" value="mobility"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install Client Certificate (.PEM)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/cert

Installs a client certificate from a .PEM file. This is typically used to replace an existing public certificate when the private key remains unchanged.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="mxtest"/>
            <parm name="CertType" value="6"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileClient" value="/enterprise/usr/persist/test.pem"/>
            <parm name="CertAdjustClock" value="false"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Install CA Certificate (.PEM)

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

Installs a CA certificate from a .PEM file. Specify the certificate alias, type, method, and file path.

```xml
<wap-provisioningdoc>
    <characteristic type="CertMgr" version="4.2" >
        <parm name="CertAction" value="1"/>
        <characteristic type="cert-details">
            <parm name="CertAlias" value="certName2"/>
            <parm name="CertType" value="5"/>
            <parm name="CertMethod" value="2"/>
            <parm name="CertFileCA" value="/path/to/cert.pem"/>
            <parm name="CertAdjustClock" value="false"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Add Personal Network with WEP

Source: https://techdocs.zebra.com/stagenow/5-17/csp/wifi

This example demonstrates adding a personal Wi-Fi network using WEP security. It requires the SSID, WEP key, and WEP key index.

```xml
<wap-provisioningdoc>
    <characteristic type="Wi-Fi" version="4.4" >
        <parm name="UseRegulatory" value="0"/>
        <parm name="UseDiagnosticOptions" value="0"/>
        <parm name="UseAdvancedOptions" value="0"/>
        <parm name="NetworkAction" value="Add"/>
        <characteristic type="network-profile">
            <parm name="SSID" value="Zebra"/>
            <parm name="SecurityMode" value="1"/>
            <parm name="WPAMode" value="4"/>
            <characteristic type="auth-details">
                <characteristic type="encryption-details">
                    <parm name="EncryptionWEP" value="1"/>
                </characteristic>
            </characteristic>
            <characteristic type="key-details">
                <parm name="KeyType" value="Passphrase"/>
                <parm name="ProtectKey" value="0"/>
                <parm name="PassphraseWEPClear" value="KsdU6X3u"/>
                <parm name="WepKeyIndex" value="1"/>
            </characteristic>
            <parm name="UseDHCP" value="1"/>
            <parm name="UseProxy" value="0"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Get All Settings

Source: https://techdocs.zebra.com/stagenow/5-17/csp/ui

Retrieves all current UI settings.

```APIDOC
## Get All Settings

### Description
Retrieves all current UI settings including locale, input method details, and feature usage statuses.

### Method
POST

### Endpoint
/device/config

### Request Body
```xml
<wap-provisioningdoc>
    <characteristic-query type="UiMgr"/>
</wap-provisioningdoc>
```

### Response
#### Success Response (200)
Returns a XML document containing the current UI settings.

#### Response Example
```xml
<wap-provisioningdoc>
  <characteristic type="UiMgr" version="4.3" >
        <parm name="CurrentLocale" value="en"/>
        <parm name="HomeKeyUsage" value="1"/>
        <parm name="ClipboardUsage" value ="1"/>
        <parm name="AutoCorrectUsage" value ="1"/> 
        <parm name="InputMethodAction" value="1"/>
        <parm name="BluetoothPairingPopupUsage" value="1"/>
        <characteristic type="InputMethodDetails">
          <parm name="InputMethodOption" value="4"/>
          <parm name="InputMethodPackageName" value="PackageName1"/>
          <parm name="InputMethodClassName" value="ClassName1"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>
```
```

--------------------------------

### Query "Install Apps from Unknown Sources" Setting

Source: https://techdocs.zebra.com/stagenow/5-17/csp/devadmin

Retrieves the current status of the 'Install Apps from Unknown Sources' setting. This query is not supported on Android 11 or later.

```xml
<wap-provisioningdoc>
    <characteristic type="DevAdmin">
        <parm-query name="UnknownSourcesStatus"/>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### Default Homepage Setting Output Example

Source: https://techdocs.zebra.com/stagenow/5-17/csp/browser

This output shows the specific value for the default homepage setting after a query.

```xml
<wap-provisioningdoc>
    <characteristic type="BrowserMgr" version="4.3">
        <parm name="SetDefaultHomepage" value="http://www.google.com"/>
    </characteristic>
</wap-provisioningdoc>
```

--------------------------------

### OS Update .upl File Example

Source: https://techdocs.zebra.com/stagenow/5-17/csp/power

Use this format for a .upl file to specify multiple .zip files for sequential OS updates. Ensure package file names are preceded by 'package:'.

```text
//Contents of the "osupdate.upl" text file:

package:M99N0KXXVPUCP14500.zip
package:CFE-M99-L-N0-010101_G_00_02.zip

// Note that package file names are preceded by the notation "package:"
```

--------------------------------

### Allow Application Installs from Unknown Sources

Source: https://techdocs.zebra.com/stagenow/5-17/csp/devadmin

Enables or disables the ability to install applications from sources other than the Google Play Store.

```APIDOC
## Allow Application Installs from Unknown Sources

```xml
<wap-provisioningdoc>
    <characteristic type="DevAdmin" version="4.3" >
        <parm name="UnknownSourcesStatus" value="1"/>
    </characteristic>
</wap-provisioningdoc>
```
```

--------------------------------

### SetDefaultLauncher

Source: https://techdocs.zebra.com/stagenow/5-17/csp/app

Sets a System or User app as the default launcher. The app must be installed and designed as an Android Launcher. An error is returned if the app is not installed.

```APIDOC
## SetDefaultLauncher

### Description
Sets a System or User app with the specified Package Name as the new default launcher. The specified app must already be installed on the device and generally should be designed to be a Android Launcher according to Android specifications. If no app with the specified Package Name is installed on the device, an error is returned in the Result XML document.

### Requirements
- OSX: 1.3+
- MX: 4.1+
```
Tokens:
Raw