Class: WMI::OfficeSoftwareProtectionProduct

Inherits:
Base
  • Object
show all
Defined in:
lib/OfficeSoftwareProtectionProduct.rb

Overview

This class exposes product-specific properties and methods of the Software Licensing service.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#AddRef, #AssociatorsAsync_, #Associators_, #Clone_, #CompareTo_, #DeleteAsync_, #Delete_, #Derivation_, #ExecMethodAsync_, #ExecMethod_, #GetIDsOfNames, #GetObjectText_, #GetText_, #GetTypeInfo, #GetTypeInfoCount, #InstancesAsync_, #Instances_, #Invoke, #Methods_, #Path_, #Properties_, #PutAsync_, #Put_, #Qualifiers_, #QueryInterface, #ReferencesAsync_, #References_, #Refresh_, #Release, #Security_, #SetFromText_, #SpawnDerivedClass_, #SpawnInstance_, #SubclassesAsync_, #Subclasses_, #SystemProperties_

Instance Attribute Details

- (string) ApplicationID (readonly)

ID of current product’s Application

Returns:

  • (string)

    ApplicationID



92
93
94
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 92

def ApplicationID
  @ApplicationID
end

- (string) Description (readonly)

Product Description

Returns:

  • (string)

    Description



97
98
99
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 97

def Description
  @Description
end

- (string) DiscoveredKeyManagementServiceMachineName (readonly)

Last discovered KMS host name through DNS.

Returns:

  • (string)

    DiscoveredKeyManagementServiceMachineName



102
103
104
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 102

def DiscoveredKeyManagementServiceMachineName
  @DiscoveredKeyManagementServiceMachineName
end

- (uint32) DiscoveredKeyManagementServiceMachinePort (readonly)

Last discovered KMS host port through DNS.

Returns:

  • (uint32)

    DiscoveredKeyManagementServiceMachinePort



107
108
109
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 107

def DiscoveredKeyManagementServiceMachinePort
  @DiscoveredKeyManagementServiceMachinePort
end

- (datetime) EvaluationEndDate (readonly)

The expiration date of this product’s application. After this date, the LicenseStatus will be Unlicensed, and cannot be Activated.

Returns:

  • (datetime)

    EvaluationEndDate



112
113
114
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 112

def EvaluationEndDate
  @EvaluationEndDate
end

- (uint32) ExtendedGrace (readonly)

Extended grace time in minutes before the parent application becomes unlicensed.

Returns:

  • (uint32)

    ExtendedGrace



117
118
119
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 117

def ExtendedGrace
  @ExtendedGrace
end

- (uint32) GenuineStatus (readonly)

Genuine status for this product.

Returns:

  • (uint32)

    GenuineStatus



122
123
124
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 122

def GenuineStatus
  @GenuineStatus
end

- (uint32) GracePeriodRemaining (readonly)

Remaining time in minutes before the parent application becomes unlicensed. For KMS clients, this is the remaining time before re-Activation is required.

Returns:

  • (uint32)

    GracePeriodRemaining



127
128
129
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 127

def GracePeriodRemaining
  @GracePeriodRemaining
end

- (string) ID (readonly)

Product Identifier

Returns:

  • (string)

    ID



132
133
134
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 132

def ID
  @ID
end

- (uint32) IsKeyManagementServiceMachine (readonly)

Indicates if KMS is enabled on the computer: 1 if true, 0 if false.

Returns:

  • (uint32)

    IsKeyManagementServiceMachine



137
138
139
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 137

def IsKeyManagementServiceMachine
  @IsKeyManagementServiceMachine
end

- (uint32) KeyManagementServiceCurrentCount (readonly)

The count of currently active KMS clients on the KMS host. -1 indicates the host is not enabled as a KMS, or has not received any client licensing-requests.

Returns:

  • (uint32)

    KeyManagementServiceCurrentCount



142
143
144
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 142

def KeyManagementServiceCurrentCount
  @KeyManagementServiceCurrentCount
end

- (uint32) KeyManagementServiceFailedRequests (readonly)

The total count of failed KMS requests.

Returns:

  • (uint32)

    KeyManagementServiceFailedRequests



147
148
149
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 147

def KeyManagementServiceFailedRequests
  @KeyManagementServiceFailedRequests
end

- (uint32) KeyManagementServiceLicensedRequests (readonly)

The count of KMS requests from clients with License Status=1 (Licensed).

Returns:

  • (uint32)

    KeyManagementServiceLicensedRequests



152
153
154
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 152

def KeyManagementServiceLicensedRequests
  @KeyManagementServiceLicensedRequests
end

- (string) KeyManagementServiceMachine (readonly)

The name of the KMS host. Returns null if SetKeyManagementServiceMachine has not been called.

Returns:

  • (string)

    KeyManagementServiceMachine



157
158
159
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 157

def KeyManagementServiceMachine
  @KeyManagementServiceMachine
end

- (uint32) KeyManagementServiceNonGenuineGraceRequests (readonly)

The count of KMS requests from clients with License Status=4 (NonGenuineGrace).

Returns:

  • (uint32)

    KeyManagementServiceNonGenuineGraceRequests



162
163
164
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 162

def KeyManagementServiceNonGenuineGraceRequests
  @KeyManagementServiceNonGenuineGraceRequests
end

- (uint32) KeyManagementServiceNotificationRequests (readonly)

The count of KMS requests from clients with License Status=5 (Notification).

Returns:

  • (uint32)

    KeyManagementServiceNotificationRequests



167
168
169
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 167

def KeyManagementServiceNotificationRequests
  @KeyManagementServiceNotificationRequests
end

- (uint32) KeyManagementServiceOOBGraceRequests (readonly)

The count of KMS requests from clients with License Status=2 (OOBGrace).

Returns:

  • (uint32)

    KeyManagementServiceOOBGraceRequests



172
173
174
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 172

def KeyManagementServiceOOBGraceRequests
  @KeyManagementServiceOOBGraceRequests
end

- (uint32) KeyManagementServiceOOTGraceRequests (readonly)

The count of KMS requests from clients with License Status=3 (OOTGrace).

Returns:

  • (uint32)

    KeyManagementServiceOOTGraceRequests



177
178
179
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 177

def KeyManagementServiceOOTGraceRequests
  @KeyManagementServiceOOTGraceRequests
end

- (uint32) KeyManagementServicePort (readonly)

The TCP port used by clients to send KMS-activation requests. Returns 0 if SetKeyManagementServicePort has not been called.

Returns:

  • (uint32)

    KeyManagementServicePort



182
183
184
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 182

def KeyManagementServicePort
  @KeyManagementServicePort
end

- (string) KeyManagementServiceProductKeyID (readonly)

KMS product key ID. Returns null if not applicable.

Returns:

  • (string)

    KeyManagementServiceProductKeyID



187
188
189
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 187

def KeyManagementServiceProductKeyID
  @KeyManagementServiceProductKeyID
end

- (uint32) KeyManagementServiceTotalRequests (readonly)

The total count of valid KMS requests.

Returns:

  • (uint32)

    KeyManagementServiceTotalRequests



192
193
194
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 192

def KeyManagementServiceTotalRequests
  @KeyManagementServiceTotalRequests
end

- (uint32) KeyManagementServiceUnlicensedRequests (readonly)

The count of KMS requests from clients with License Status=0 (Unlicensed).

Returns:

  • (uint32)

    KeyManagementServiceUnlicensedRequests



197
198
199
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 197

def KeyManagementServiceUnlicensedRequests
  @KeyManagementServiceUnlicensedRequests
end

- (string) LicenseDependsOn (readonly)

The dependency identifier for the family of SKUs used to determine license relationships for add-ons.

Returns:

  • (string)

    LicenseDependsOn



202
203
204
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 202

def LicenseDependsOn
  @LicenseDependsOn
end

- (string) LicenseFamily (readonly)

The family identifier for the SKU used to determine license relationships for add-ons.

Returns:

  • (string)

    LicenseFamily



207
208
209
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 207

def LicenseFamily
  @LicenseFamily
end

- (boolean) LicenseIsAddon (readonly)

Returns True if the product is identified as an add-on license.

Returns:

  • (boolean)

    LicenseIsAddon



212
213
214
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 212

def LicenseIsAddon
  @LicenseIsAddon
end

- (uint32) LicenseStatus (readonly)

License status of this product’s application. 0=Unlicensed, 1=Licensed, 2=OOBGrace, 3=OOTGrace, 4=NonGenuineGrace, 5=Notification.

Returns:

  • (uint32)

    LicenseStatus



217
218
219
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 217

def LicenseStatus
  @LicenseStatus
end

- (uint32) LicenseStatusReason (readonly)

A diagnostic code which indicates why a computer is in a specific licensing state.

Returns:

  • (uint32)

    LicenseStatusReason



222
223
224
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 222

def LicenseStatusReason
  @LicenseStatusReason
end

- (string) MachineURL (readonly)

Software licensing server URL for the binding certificate

Returns:

  • (string)

    MachineURL



227
228
229
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 227

def MachineURL
  @MachineURL
end

- (string) Name (readonly)

Product Name

Returns:

  • (string)

    Name



232
233
234
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 232

def Name
  @Name
end

- (string) OfflineInstallationId (readonly)

An identifier for this product’s application that can be used for telephone or offline activation. Returns null if a product key is not installed.

Returns:

  • (string)

    OfflineInstallationId



237
238
239
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 237

def OfflineInstallationId
  @OfflineInstallationId
end

- (string) PartialProductKey (readonly)

Last five characters of this product’s key. Returns null if a product key is not installed.

Returns:

  • (string)

    PartialProductKey



242
243
244
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 242

def PartialProductKey
  @PartialProductKey
end

- (string) ProcessorURL (readonly)

Software licensing server URL for the process certificate

Returns:

  • (string)

    ProcessorURL



247
248
249
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 247

def ProcessorURL
  @ProcessorURL
end

- (string) ProductKeyID (readonly)

Product key ID. Returns null if a product key is not installed.

Returns:

  • (string)

    ProductKeyID



252
253
254
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 252

def ProductKeyID
  @ProductKeyID
end

- (string) ProductKeyURL (readonly)

Software licensing server URL for the product certificate

Returns:

  • (string)

    ProductKeyURL



257
258
259
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 257

def ProductKeyURL
  @ProductKeyURL
end

- (uint32) RequiredClientCount (readonly)

The minimum number of clients required to connect to a KMS host in order to enable volume licensing.

Returns:

  • (uint32)

    RequiredClientCount



262
263
264
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 262

def RequiredClientCount
  @RequiredClientCount
end

- (string) TokenActivationAdditionalInfo (readonly)

Additional information for token-based activation.

Returns:

  • (string)

    TokenActivationAdditionalInfo



267
268
269
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 267

def TokenActivationAdditionalInfo
  @TokenActivationAdditionalInfo
end

- (string) TokenActivationCertificateThumbprint (readonly)

Thumbprint of the certificate that activated the product.

Returns:

  • (string)

    TokenActivationCertificateThumbprint



272
273
274
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 272

def TokenActivationCertificateThumbprint
  @TokenActivationCertificateThumbprint
end

- (uint32) TokenActivationGrantNumber (readonly)

Grant number in the token-based activation license that activated the product.

Returns:

  • (uint32)

    TokenActivationGrantNumber



277
278
279
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 277

def TokenActivationGrantNumber
  @TokenActivationGrantNumber
end

- (string) TokenActivationILID (readonly)

ID of the token-based activation license that activated the product.

Returns:

  • (string)

    TokenActivationILID



282
283
284
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 282

def TokenActivationILID
  @TokenActivationILID
end

- (uint32) TokenActivationILVID (readonly)

Version of the token-based activation license that activated the product.

Returns:

  • (uint32)

    TokenActivationILVID



287
288
289
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 287

def TokenActivationILVID
  @TokenActivationILVID
end

- (datetime) TrustedTime (readonly)

The trusted time for the product.

Returns:

  • (datetime)

    TrustedTime



292
293
294
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 292

def TrustedTime
  @TrustedTime
end

- (string) UseLicenseURL (readonly)

Software licensing server URL for the user license

Returns:

  • (string)

    UseLicenseURL



297
298
299
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 297

def UseLicenseURL
  @UseLicenseURL
end

- (uint32) VLActivationInterval (readonly)

The frequency, in minutes, of how often a client will contact the KMS host before the product is licensed.

Returns:

  • (uint32)

    VLActivationInterval



302
303
304
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 302

def VLActivationInterval
  @VLActivationInterval
end

- (uint32) VLRenewalInterval (readonly)

The frequency, in minutes, of how often a client will contact the KMS host after the product is licensed.

Returns:

  • (uint32)

    VLRenewalInterval



307
308
309
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 307

def VLRenewalInterval
  @VLRenewalInterval
end

Instance Method Details

- (uint32) Activate

Activates the current product.

Returns:

  • (uint32)


13
14
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 13

def Activate 
end

- (uint32) ClearKeyManagementServiceMachine

Clears any previously configured KMS host name.

Returns:

  • (uint32)


50
51
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 50

def ClearKeyManagementServiceMachine 
end

- (uint32) ClearKeyManagementServicePort

Clears any previously specified port number.

Returns:

  • (uint32)


63
64
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 63

def ClearKeyManagementServicePort 
end

- (uint32) DepositOfflineConfirmationId(ConfirmationId, InstallationId)

Activates a product by depositing an Offline Confirmation Identifier for this product when performing telephone or offline activation.

Parameters:

  • (string, #read) ConfirmationId
  • (string, #read) InstallationId

Returns:

  • (uint32)


21
22
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 21

def DepositOfflineConfirmationId ConfirmationId, InstallationId
end

- (uint32) DepositTokenActivationResponse(CertChain, Challenge, Response)

Deposits token-based activation response.

Parameters:

  • (string, #read) CertChain
  • (string, #read) Challenge
  • (string, #read) Response

Returns:

  • (uint32)


86
87
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 86

def DepositTokenActivationResponse CertChain, Challenge, Response
end

- (uint32) GenerateTokenActivationChallenge

Returns token-based activation challenge.

Parameters:

  • (string, #write) Challenge

Returns:

  • (uint32)


77
78
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 77

def GenerateTokenActivationChallenge 
end

- (uint32) GetPolicyInformationDWord(PolicyName)

Gets license policy Information of type DWORD.

Parameters:

  • (string, #read) PolicyName
  • (uint32, #write) PolicyValue

Returns:

  • (uint32)


29
30
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 29

def GetPolicyInformationDWord PolicyName
end

- (uint32) GetPolicyInformationString(PolicyName)

Gets policy information of type string.

Parameters:

  • (string, #read) PolicyName
  • (string, #write) PolicyValue

Returns:

  • (uint32)


37
38
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 37

def GetPolicyInformationString PolicyName
end

- (uint32) GetTokenActivationGrants

Returns token-based activation grants.

Parameters:

  • (string, #write) Grants

Returns:

  • (uint32)


70
71
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 70

def GetTokenActivationGrants 
end

- (uint32) SetKeyManagementServiceMachine(MachineName)

Sets the KMS host name to use for volume activation.

Parameters:

  • (string, #read) MachineName

Returns:

  • (uint32)


44
45
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 44

def SetKeyManagementServiceMachine MachineName
end

- (uint32) SetKeyManagementServicePort(PortNumber)

Sets the TCP port used by a client to make requests of a KMS host. If not specified, port 1688 is used.

Parameters:

  • (uint32, #read) PortNumber

Returns:

  • (uint32)


57
58
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 57

def SetKeyManagementServicePort PortNumber
end

- (uint32) UninstallProductKey

Uninstalls a product key for the current product.

Returns:

  • (uint32)


7
8
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 7

def UninstallProductKey 
end