SMS_AdvertisementStatusRootSummarizer

The SMS_AdvertisementStatusRootSummarizer WMI class tracks the progress of each advertisement and program as it is advertised and run on the client computers. The reported advertisement status is for all sites in the site hierarchy.

The following syntax is simplified from MOF code and includes all inherited properties.

Class SMS_AdvertisementStatusRootSummarizer : SMS_BaseClass
{
  string AdvertisementID;
  string AdvertisementName;
  uint32 AdvertisementsFailed;
  uint32 AdvertisementsReceived;
  string CollectionID;
  string CollectionName;
  string DisplaySchedule;
  datetime ExpirationTime;
  string PackageID;
  string PackageLanguage;
  string PackageManufacturer;
  string PackageName;
  string PackageVersion;
  datetime PresentTime;
  string ProgramName;
  uint32 ProgramsFailed;
  uint32 ProgramsStarted;
  uint32 ProgramsSucceeded;
  string SourceSite;
  uint32 TimeEnableFlag;
};

Properties

• AdvertisementID
  Data type: string
  Access type: Read-only
  Qualifiers: Key

  Unique identifier that SMS assigns to each advertisement.

• AdvertisementName
  Data type: string
  Access type: Read-only

  Name of the advertisement.

• AdvertisementsFailed
  Data type: uint32
  Access type: Read-only

  Total number of users, user groups, or client computers that experienced an error in processing the advertisement or its associated program, or that attempted to run the advertised program, but failed before the program could be started.

• AdvertisementsReceived
  Data type: uint32
  Access type: Read-only

  Total number of users, user groups, or client computers that are reporting successful receipt of the advertisement.

• CollectionID
  Data type: string
  Access type: Read-only

  Identifier of the collection to which this advertisement is advertised.

• CollectionName
  Data type: string
  Access type: Read-only

  Name of the collection to which this advertisement is advertised.

• DisplaySchedule
  Data type: string
  Access type: Read-only

  Interval string that specifies the schedule for which these statistics apply. The statistics are reset to zero each time the schedule elapses. The interval string is generated from an SMS_ScheduleToken instance using the WriteToString method.

• ExpirationTime
  Data type: datetimeAccess type: Read-only

  Date and time when the advertisement expires and is no longer available to clients. This can be local or Greenwich mean time, depending on whether the property ExpirationTimeIsGMT in SMS_Advertisement is set to TRUE (GMT) or FALSE (local).

• PackageID
  Data type: string
  Access type: Read-only

  Identifier of the package with which the advertised program is associated.

• PackageLanguage
  Data type: string
  Access type: Read-only

  Language of the package, such as English or German.

• PackageManufacturer
  Data type: string
  Access type: Read-only

  Manufacturer of the package.

• PackageName
  Data type: string
  Access type: Read-only

  Name of the package.

• PackageVersion
  Data type: string
  Access type: Read-only

  Version of the package.

• PresentTime
  Data type: datetimeAccess type: Read-only

  Date and time when the advertisement is presented to the clients. This can be local or Greenwich mean time, depending on whether the property PresentTimeIsGMT in SMS_Advertisement is set to TRUE (GMT) or FALSE (local).

• ProgramName
  Data type: string
  Access type: Read-only

  Name of the program (related to PackageID) that this advertisement advertises.

• ProgramsFailed
  Data type: uint32
  Access type: Read-only

  Total number of users, user groups, or client computers that reported errors while running the advertised program. A program is considered in error when it produces either:

  1. A non-zero exit code, or
  2. An install-status MIF file with a failure-status attribute. This file, if present, overrides an exit code.

• ProgramsStarted
  Data type: uint32
  Access type: Read-only

  Total number of users, user groups, or client computers in the site that were able to successfully start running the advertised program.

• ProgramsSucceeded
  Data type: uint32
  Access type: Read-only

  Total number of users, user groups, or client computers, or both, that are reporting that the program ran successfully. A program is considered successful when it produces either:

  1. A exit code of zero, or
  2. An install-status MIF file with a success-status attribute. This file, if present, overrides an exit code.

• SourceSite
  Data type: string
  Access type: Read-only

  Site code of the site from which the advertisement originated.

• TimeEnableFlag
  Data type: uint32
  Access type: Read-only

  Reserved for future use.

Methods

The following table lists the methods in SMS_AdvertisementStatusRootSummarizer.

Method	Description
DeleteStatistics	Reserved.

See Also

Determining Advertisement Status, SMS_AdvertisementStatusSummarizer, Status Classes