Server Response to the Device Poll (Windows Embedded CE 6.0)

1/6/2010

The server sends back a poll response with information about all packages that the target device is supposed to have, including optional packages. The response also contains changes, if any, to client configuration settings. These settings can include the poll server, poll interval, failure retry count, failure retry interval, and others.

In addition to sending the package list, if the server requires any reports from the target device such as software inventory, machine inventory, or file collection reports, the server specifies that information in the server response to target device poll.

Server Response to Target Device Poll XML Elements

The following table shows the server response to the target device Poll XML elements.

Element Description

PollResponse

Root element of the Poll Response document.

Settings

Top-level element of the section that groups the settings to be applied to the management client.

ClientSettings

These settings define values that the client uses to communicate with the server.

PollServer

Name of the management server.

PollInterval

How frequently the client polls the server.

FailureRetryCount

Number of times the client will reattempt a failed action.

FailureRetryInterval

Delay between retry attempts.

SoftwareInventorySettings

Top-level element of the section that defines the settings used to produce software inventory reports.

FileFilterItem

Top-level element of the section that defines the parameters used to implement a single software inventory directive.

FileFilterItem Element (Poll Response)

A description of the item to search for, using limited wildcard (*) regular expression matching.

Path

Path used to search for the request item.

Recursive

Specifies whether the client should recursively search all subdirectories of the provided Path.

ExcludeCompressed

Specifies whether the client should exclude compressed items from the result set.

ExcludeEncrypted

Specifies whether the client should exclude encrypted items from the result set.

FileCollectionSettings

Top-level element of the section that defines the settings used to produce File Collection reports.

Enabled

Specifies whether file collection functionality is enabled.

Interval

Interval at which the client should generate a file collection report or reports.

MachineInventorySettings

Top-level element of the section that defines the settings used to produce machine inventory reports.

ApplicablePackages

Top-level element of the section that groups the list of package IDs applicable to this specific client.

Package

Top-level element of the section that describes a particular package.

Response to Target Device Poll Schema

The following schema shows the response from the server to a target device Poll request.

<PollResponse xmlns="Default XML namespace for the XML document">
  <Settings>
    <ClientSettings version="1.0">
      <PollServer>"Name of the management server"</PollServer>
      <PollInterval>"How frequently the client polls server"</PollInterval>
      <FailureRetryCount>"Times the client will retry if action fails"</FailureRetryCount>
      <FailureRetryInterval>"Delay between retry attempts"</FailureRetryInterval>
    </ClientSettings>
    <SoftwareInventorySettings version="1.0">
      <Enabled>"Whether or not software inventory functionality is enabled"</Enabled>
      <Interval>"Interval at which client should generate software inventory reports"</Interval>
      <FileFilterItem>
        <Filter>"Item to search for"</Filter>
        <Path>"Path to search for the item"</Path>
        <Recursive>"Whether to do a recursive search of path subdirectories"</Recursive>
        <ExcludeCompressed>"Whether to exclude compressed items"</ExcludeCompressed>
        <ExcludeEncrypted>"Whether to exclude encrypted items"</ExcludeEncrypted>
      </FileFilterItem>
    </SoftwareInventorySettings>
    <FileCollectionSettings version="1.0">
      <Enabled>"Whether or not file collection is enabled"</Enabled>
      <Interval>"Interval at which client should generate file collection reports"</Interval>
      <FileFilterItem>
        <Filter>"Item to search for"</Filter>
        <Path>"Path to search for the item"</Path>
        <Recursive>"Whether to do a recursive search of path subdirectories"</Recursive>
        <ExcludeCompressed>"Whether to exclude compressed items"</ExcludeCompressed>
        <ExcludeEncrypted>"Whether to exclude encrypted items"</ExcludeEncrypted>
      </FileFilterItem>
    </FileCollectionSettings>
    <MachineInventorySettings version="1.0">
      <Enabled>"Whether or not machine inventory functionality is enabled"</Enabled>
      <Interval>"Interval at which client should generate machine inventory reports"</Interval>
    </MachineInventorySettings>
  </Settings>
  <ApplicablePackages>
    <Package ID="Package unique ID"/>
  </ApplicablePackages>
</PollResponse>

Response to Target Device Poll Example

The following code example shows a server response to a target device poll request.

<PollResponse>
  <Settings>
    <ClientSettings version="1.0">
      <PollServer>APollServer</PollServer>
      <PollInterval>0000-00-00 01:00:00</PollInterval>
      <FailureRetryCount>5</FailureRetryCount>
      <FailureRetryInterval>0000-00-00 01:00:00</FailureRetryInterval>
    </ClientSettings>
    <SoftwareInventorySettings version="1.0">
      <Enabled>false</Enabled>
      <Interval>0000-00-00 00:05:00</Interval>
      <FileFilterItem>
        <Filter>explorer.exe</Filter>
        <Path>\Windows</Path>
        <Recursive>false</Recursive>
        <ExcludeCompressed>false</ExcludeCompressed>
        <ExcludeEncrypted>false</ExcludeEncrypted>
      </FileFilterItem>
    </SoftwareInventorySettings>
    <FileCollectionSettings version="1.0">
      <Enabled>true</Enabled>
      <Interval>0000-00-01 00:00:00</Interval>
      <FileFilterItem>
        <Filter>explorer.exe</Filter>
        <Path>\windows\</Path>
        <Recursive>false</Recursive>
        <ExcludeCompressed>false</ExcludeCompressed>
        <ExcludeEncrypted>false</ExcludeEncrypted>
      </FileFilterItem>
    </FileCollectionSettings>
    <MachineInventorySettings version="1.0">
      <Enabled>false</Enabled>
      <Interval>0000-00-00 00:07:00</Interval>
    </MachineInventorySettings>
  </Settings>
  <ApplicablePackages>
    <Package ID="9A437CA5-5B17-4486-9E87-260742074A72"/>
  </ApplicablePackages>
</PollResponse>

See Also

Concepts

Device Management Operation

Other Resources

Device Management Client Application Development