List App Volumes Application Entitlements on a Windows Endpoint

You can use the list-entitlements command of App Volumes agent (svservice.exe) to view the App Volumes applications that are entitled to the current session on a Windows endpoint, and the delivery state of each application. The command runs locally on the Windows endpoint, so you can check which applications were delivered to a computer and which failed without reviewing the agent logs or the App Volumes Manager admin UI.

The command only reports the delivery state of applications. It does not change assignments or retry failed deliveries.

Note: You run this command on the Windows endpoint where the App Volumes agent is installed and where applications are being delivered.

Criteria for using the list-entitlements Command

You must be aware of the following criteria when using the command:

• App Volumes agent, version 2609 or later, must be installed on the Windows endpoint.

• The App Volumes agent service (svservice) must be running. The list-entitlements command requires the service to retrieve the entitlement state.

• The svservice.exe file is located in C:\Program Files\Omnissa\AppVolumes\Agent. You can run the command from any directory by using the full path, or navigate to the directory first.

• The command can be run by both administrators and standard users. However, the /allusers switch and running the command in session 0 require administrator privileges, because they return a snapshot of all active user sessions.

• The output includes only the applications entitled to the session of the user who runs the command and the applications assigned to the computer. To list entitlements across all active user sessions, use the /allusers switch or run the command in session 0.

• The command cannot be run while an application is being captured on the computer.

svservice list-entitlements

When the following command runs on the Windows endpoint, App Volumes agent displays a report of the application entitlements in the console:

svservice.exe list-entitlements

To save the entitlements as raw JSON in a file instead, use the /json option:

svservice.exe list-entitlements /json <json_path>

json_path - path of the file to which the JSON output is written. When the /json option is used, the entitlement report is written to the file and a confirmation message is printed to the console, but the report itself is not displayed in the console.

To list the entitlements of all active user sessions, use the /allusers switch. This switch requires administrator privileges.

svservice.exe list-entitlements /allusers

You can combine the /allusers and /json options to save the entitlements of all active user sessions as JSON:

svservice.exe list-entitlements /allusers /json <json_path>

Delivery States in the Output

The output groups applications by delivery state. Every application that is entitled to the session appears in the Entitled group. An application that has any delivery activity also appears in exactly one of the In Progress, Attached, or Failed groups. An application with no delivery activity appears only in the Entitled group.

Output Fields

The applications in the In Progress, Attached, and Failed groups are listed with the following fields:

The following fields appear only in the /allusers or session 0 report:

Considerations When Reading the Output

• On-demand applications - An on-demand application that is not yet launched appears only in the Entitled group. If the delivery fails after the application is launched, the application appears in the Failed group even though its shortcut is still present. If a retry succeeds, the application moves through the In Progress group to the Attached group.

• Command-line-delivered applications - Applications delivered by using command-line delivery are not listed until they are launched. The agent is not aware of these applications until launch, so they appear in the report only after they have been launched, regardless of whether the delivery succeeded or failed.

• Writable Volumes - Writable Volumes are included in the output. The system Writable Volume, which is internal to the agent, is excluded.

• Multiple versions - For an application with multiple versions, all versions are listed in the output, because all versions are announced by the App Volumes Manager.

• Service restart or upgrade - When svservice restarts or App Volumes agent is upgraded, the history of failed deliveries is cleared. The current state of the applications is shown again after the next synchronization.

• Changes during the report - If the delivery state of an application changes while the report is being generated, the output can be slightly inconsistent.

Example Output

Console output

When you run the command without the /json option, the output appears in the console as a human-readable report grouped by delivery state:

svservice.exe list-entitlements

Entitled: 6
  Microsoft365Apps.msi
  AdobeAcrobatPro.msi
  GoogleChromeEnterprise.msi
  SlackDesktop.msi
  VisualStudioCode.msi
  VLCmediaPlayer.msi

In Progress: 2
  Package Name: Microsoft365Apps.msi
  Package Type: MSIX App
  Application Product GUID: {11111111-2222-3333-4444-555555555555}
  Application Package GUID: {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}
  Status: Downloading

  Package Name: GoogleChromeEnterprise.msi
  Package Type: MSIX App
  Application Product GUID: {12345678-90ab-cdef-1234-567890abcdef}
  Application Package GUID: {fedcba98-7654-3210-fedc-ba9876543210}
  Status: Virtualizing

Attached: 1
  Package Name: VisualStudioCode.msi
  Package Type: Thinapp App
  Application Product GUID: {34567890-12ab-cdef-3456-789012abcdef}
  Application Package GUID: {dcba9876-5432-10fe-dcba-9876543210fe}

Failed: 2
  Package Name: SlackDesktop.msi
  Package Type: AV App
  Application Product GUID: {23456789-01ab-cdef-2345-678901abcdef}
  Application Package GUID: {edcba987-6543-210f-edcb-a9876543210f}
  Failure Reason: Download failed

  Package Name: VLCmediaPlayer.msi
  Package Type: AV App
  Application Product GUID: {56789012-34ab-cdef-5678-901234abcdef}
  Application Package GUID: {ba987654-3210-fedc-ba98-76543210fedc}
  Failure Reason: Volume mount failed

JSON output

When you use the /json option, the raw JSON report is written to the specified file path. Each status group is an object with count and applications fields:

svservice.exe list-entitlements /json C:\temp\entitlements.json

{
  "entitled": {
    "count": 6,
    "applications": [
      "Microsoft365Apps.msi",
      "AdobeAcrobatPro.msi",
      "GoogleChromeEnterprise.msi",
      "SlackDesktop.msi",
      "VisualStudioCode.msi",
      "VLCmediaPlayer.msi"
    ]
  },
  "inProgress": {
    "count": 2,
    "applications": [
      {
        "packageName": "Microsoft365Apps.msi",
        "packageType": "MSIX App",
        "applicationProductGuid": "{11111111-2222-3333-4444-555555555555}",
        "applicationPackageGuid": "{aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}",
        "status": "Downloading"
      },
      {
        "packageName": "GoogleChromeEnterprise.msi",
        "packageType": "MSIX App",
        "applicationProductGuid": "{12345678-90ab-cdef-1234-567890abcdef}",
        "applicationPackageGuid": "{fedcba98-7654-3210-fedc-ba9876543210}",
        "status": "Virtualizing"
      }
    ]
  },
  "attached": {
    "count": 1,
    "applications": [
      {
        "packageName": "VisualStudioCode.msi",
        "packageType": "Thinapp App",
        "applicationProductGuid": "{34567890-12ab-cdef-3456-789012abcdef}",
        "applicationPackageGuid": "{dcba9876-5432-10fe-dcba-9876543210fe}"
      }
    ]
  },
  "failed": {
    "count": 2,
    "applications": [
      {
        "packageName": "SlackDesktop.msi",
        "packageType": "AV App",
        "applicationProductGuid": "{23456789-01ab-cdef-2345-678901abcdef}",
        "applicationPackageGuid": "{edcba987-6543-210f-edcb-a9876543210f}",
        "failureReason": "Download failed"
      },
      {
        "packageName": "VLCmediaPlayer.msi",
        "packageType": "AV App",
        "applicationProductGuid": "{56789012-34ab-cdef-5678-901234abcdef}",
        "applicationPackageGuid": "{ba987654-3210-fedc-ba98-76543210fedc}",
        "failureReason": "Volume mount failed"
      }
    ]
  }
}

/allusers console output

When you run the command with the /allusers switch, the output is divided into sections by session, each showing the session ID and user name:

svservice.exe list-entitlements /allusers

=== Session 1 (alice) ===

Entitled: 3
  Microsoft365Apps.msi
  GoogleChromeEnterprise.msi
  VLCmediaPlayer.msi

In Progress: 1
  Package Name: Microsoft365Apps.msi
  Package Type: MSIX App
  Application Product GUID: {11111111-2222-3333-4444-555555555555}
  Application Package GUID: {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}
  Status: Downloading

Attached: 1
  Package Name: GoogleChromeEnterprise.msi
  Package Type: MSIX App
  Application Product GUID: {12345678-90ab-cdef-1234-567890abcdef}
  Application Package GUID: {fedcba98-7654-3210-fedc-ba9876543210}

Failed: 1
  Package Name: VLCmediaPlayer.msi
  Package Type: AV App
  Application Product GUID: {56789012-34ab-cdef-5678-901234abcdef}
  Application Package GUID: {ba987654-3210-fedc-ba98-76543210fedc}
  Failure Reason: Volume mount failed

=== Session 2 (bob) ===

Entitled: 3
  GoogleChromeEnterprise.msi
  SlackDesktop.msi
  TableauReader.msi

Attached: 1
  Package Name: GoogleChromeEnterprise.msi
  Package Type: MSIX App
  Application Product GUID: {12345678-90ab-cdef-1234-567890abcdef}
  Application Package GUID: {fedcba98-7654-3210-fedc-ba9876543210}

Failed: 1
  Package Name: SlackDesktop.msi
  Package Type: Thinapp App
  Application Product GUID: {23456789-01ab-cdef-2345-678901abcdef}
  Application Package GUID: {edcba987-6543-210f-edcb-a9876543210f}
  Failure Reason: Unassigned application

/allusers JSON output

When you combine the /allusers and /json options, the JSON report contains a sessions array, where each session includes the session ID, user name, and the same four status groups:

{
  "sessions": [
    {
      "sessionId": 1,
      "userName": "alice",
      "entitled": {
        "count": 3,
        "applications": [
          "Microsoft365Apps.msi",
          "GoogleChromeEnterprise.msi",
          "VLCmediaPlayer.msi"
        ]
      },
      "inProgress": {
        "count": 1,
        "applications": [
          {
            "packageName": "Microsoft365Apps.msi",
            "packageType": "MSIX App",
            "applicationProductGuid": "{11111111-2222-3333-4444-555555555555}",
            "applicationPackageGuid": "{aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}",
            "status": "Downloading"
          }
        ]
      },
      "attached": {
        "count": 1,
        "applications": [
          {
            "packageName": "GoogleChromeEnterprise.msi",
            "packageType": "MSIX App",
            "applicationProductGuid": "{12345678-90ab-cdef-1234-567890abcdef}",
            "applicationPackageGuid": "{fedcba98-7654-3210-fedc-ba9876543210}"
          }
        ]
      },
      "failed": {
        "count": 1,
        "applications": [
          {
            "packageName": "VLCmediaPlayer.msi",
            "packageType": "AV App",
            "applicationProductGuid": "{56789012-34ab-cdef-5678-901234abcdef}",
            "applicationPackageGuid": "{ba987654-3210-fedc-ba98-76543210fedc}",
            "failureReason": "Volume mount failed"
          }
        ]
      }
    },
    {
      "sessionId": 2,
      "userName": "bob",
      "entitled": {
        "count": 3,
        "applications": [
          "GoogleChromeEnterprise.msi",
          "SlackDesktop.msi",
          "TableauReader.msi"
        ]
      },
      "inProgress": {
        "count": 0,
        "applications": []
      },
      "attached": {
        "count": 1,
        "applications": [
          {
            "packageName": "GoogleChromeEnterprise.msi",
            "packageType": "MSIX App",
            "applicationProductGuid": "{12345678-90ab-cdef-1234-567890abcdef}",
            "applicationPackageGuid": "{fedcba98-7654-3210-fedc-ba9876543210}"
          }
        ]
      },
      "failed": {
        "count": 1,
        "applications": [
          {
            "packageName": "SlackDesktop.msi",
            "packageType": "Thinapp App",
            "applicationProductGuid": "{23456789-01ab-cdef-2345-678901abcdef}",
            "applicationPackageGuid": "{edcba987-6543-210f-edcb-a9876543210f}",
            "failureReason": "Unassigned application"
          }
        ]
      }
    }
  ]
}

Troubleshooting

For information about the svservice registry values, see Configuration of svservice.