Class: WMI::OfficeSoftwareProtectionProduct
- Inherits:
-
Base
- Object
- Base
- WMI::OfficeSoftwareProtectionProduct
- Defined in:
- lib/OfficeSoftwareProtectionProduct.rb
Overview
This class exposes product-specific properties and methods of the Software Licensing service.
Instance Attribute Summary (collapse)
-
- (string) ApplicationID
readonly
ID of current product’s Application.
-
- (string) Description
readonly
Product Description.
-
- (string) DiscoveredKeyManagementServiceMachineName
readonly
Last discovered KMS host name through DNS.
-
- (uint32) DiscoveredKeyManagementServiceMachinePort
readonly
Last discovered KMS host port through DNS.
-
- (datetime) EvaluationEndDate
readonly
The expiration date of this product’s application.
-
- (uint32) ExtendedGrace
readonly
Extended grace time in minutes before the parent application becomes unlicensed.
-
- (uint32) GenuineStatus
readonly
Genuine status for this product.
-
- (uint32) GracePeriodRemaining
readonly
Remaining time in minutes before the parent application becomes unlicensed.
-
- (string) ID
readonly
Product Identifier.
-
- (uint32) IsKeyManagementServiceMachine
readonly
Indicates if KMS is enabled on the computer: 1 if true, 0 if false.
-
- (uint32) KeyManagementServiceCurrentCount
readonly
The count of currently active KMS clients on the KMS host.
-
- (uint32) KeyManagementServiceFailedRequests
readonly
The total count of failed KMS requests.
-
- (uint32) KeyManagementServiceLicensedRequests
readonly
The count of KMS requests from clients with License Status=1 (Licensed).
-
- (string) KeyManagementServiceMachine
readonly
The name of the KMS host.
-
- (uint32) KeyManagementServiceNonGenuineGraceRequests
readonly
The count of KMS requests from clients with License Status=4 (NonGenuineGrace).
-
- (uint32) KeyManagementServiceNotificationRequests
readonly
The count of KMS requests from clients with License Status=5 (Notification).
-
- (uint32) KeyManagementServiceOOBGraceRequests
readonly
The count of KMS requests from clients with License Status=2 (OOBGrace).
-
- (uint32) KeyManagementServiceOOTGraceRequests
readonly
The count of KMS requests from clients with License Status=3 (OOTGrace).
-
- (uint32) KeyManagementServicePort
readonly
The TCP port used by clients to send KMS-activation requests.
-
- (string) KeyManagementServiceProductKeyID
readonly
KMS product key ID.
-
- (uint32) KeyManagementServiceTotalRequests
readonly
The total count of valid KMS requests.
-
- (uint32) KeyManagementServiceUnlicensedRequests
readonly
The count of KMS requests from clients with License Status=0 (Unlicensed).
-
- (string) LicenseDependsOn
readonly
The dependency identifier for the family of SKUs used to determine license relationships for add-ons.
-
- (string) LicenseFamily
readonly
The family identifier for the SKU used to determine license relationships for add-ons.
-
- (boolean) LicenseIsAddon
readonly
Returns True if the product is identified as an add-on license.
-
- (uint32) LicenseStatus
readonly
License status of this product’s application.
-
- (uint32) LicenseStatusReason
readonly
A diagnostic code which indicates why a computer is in a specific licensing state.
-
- (string) MachineURL
readonly
Software licensing server URL for the binding certificate.
-
- (string) Name
readonly
Product Name.
-
- (string) OfflineInstallationId
readonly
An identifier for this product’s application that can be used for telephone or offline activation.
-
- (string) PartialProductKey
readonly
Last five characters of this product’s key.
-
- (string) ProcessorURL
readonly
Software licensing server URL for the process certificate.
-
- (string) ProductKeyID
readonly
Product key ID.
-
- (string) ProductKeyURL
readonly
Software licensing server URL for the product certificate.
-
- (uint32) RequiredClientCount
readonly
The minimum number of clients required to connect to a KMS host in order to enable volume licensing.
-
- (string) TokenActivationAdditionalInfo
readonly
Additional information for token-based activation.
-
- (string) TokenActivationCertificateThumbprint
readonly
Thumbprint of the certificate that activated the product.
-
- (uint32) TokenActivationGrantNumber
readonly
Grant number in the token-based activation license that activated the product.
-
- (string) TokenActivationILID
readonly
ID of the token-based activation license that activated the product.
-
- (uint32) TokenActivationILVID
readonly
Version of the token-based activation license that activated the product.
-
- (datetime) TrustedTime
readonly
The trusted time for the product.
-
- (string) UseLicenseURL
readonly
Software licensing server URL for the user license.
-
- (uint32) VLActivationInterval
readonly
The frequency, in minutes, of how often a client will contact the KMS host before the product is licensed.
-
- (uint32) VLRenewalInterval
readonly
The frequency, in minutes, of how often a client will contact the KMS host after the product is licensed.
Instance Method Summary (collapse)
-
- (uint32) Activate
Activates the current product.
-
- (uint32) ClearKeyManagementServiceMachine
Clears any previously configured KMS host name.
-
- (uint32) ClearKeyManagementServicePort
Clears any previously specified port number.
-
- (uint32) DepositOfflineConfirmationId(ConfirmationId, InstallationId)
Activates a product by depositing an Offline Confirmation Identifier for this product when performing telephone or offline activation.
-
- (uint32) DepositTokenActivationResponse(CertChain, Challenge, Response)
Deposits token-based activation response.
-
- (uint32) GenerateTokenActivationChallenge
Returns token-based activation challenge.
-
- (uint32) GetPolicyInformationDWord(PolicyName)
Gets license policy Information of type DWORD.
-
- (uint32) GetPolicyInformationString(PolicyName)
Gets policy information of type string.
-
- (uint32) GetTokenActivationGrants
Returns token-based activation grants.
-
- (uint32) SetKeyManagementServiceMachine(MachineName)
Sets the KMS host name to use for volume activation.
-
- (uint32) SetKeyManagementServicePort(PortNumber)
Sets the TCP port used by a client to make requests of a KMS host.
-
- (uint32) UninstallProductKey
Uninstalls a product key for the current product.
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
92 93 94 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 92 def ApplicationID @ApplicationID end |
- (string) Description (readonly)
Product Description
97 98 99 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 97 def Description @Description end |
- (string) DiscoveredKeyManagementServiceMachineName (readonly)
Last discovered KMS host name through DNS.
102 103 104 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 102 def DiscoveredKeyManagementServiceMachineName @DiscoveredKeyManagementServiceMachineName end |
- (uint32) DiscoveredKeyManagementServiceMachinePort (readonly)
Last discovered KMS host port through DNS.
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.
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.
117 118 119 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 117 def ExtendedGrace @ExtendedGrace end |
- (uint32) GenuineStatus (readonly)
Genuine status for this product.
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.
127 128 129 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 127 def GracePeriodRemaining @GracePeriodRemaining end |
- (string) ID (readonly)
Product Identifier
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.
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.
142 143 144 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 142 def KeyManagementServiceCurrentCount @KeyManagementServiceCurrentCount end |
- (uint32) KeyManagementServiceFailedRequests (readonly)
The total count of failed KMS requests.
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).
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.
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).
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).
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).
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).
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.
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.
187 188 189 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 187 def KeyManagementServiceProductKeyID @KeyManagementServiceProductKeyID end |
- (uint32) KeyManagementServiceTotalRequests (readonly)
The total count of valid KMS requests.
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).
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.
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.
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.
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.
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.
222 223 224 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 222 def LicenseStatusReason @LicenseStatusReason end |
- (string) MachineURL (readonly)
Software licensing server URL for the binding certificate
227 228 229 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 227 def MachineURL @MachineURL end |
- (string) Name (readonly)
Product 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.
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.
242 243 244 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 242 def PartialProductKey @PartialProductKey end |
- (string) ProcessorURL (readonly)
Software licensing server URL for the process certificate
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.
252 253 254 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 252 def ProductKeyID @ProductKeyID end |
- (string) ProductKeyURL (readonly)
Software licensing server URL for the product certificate
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.
262 263 264 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 262 def RequiredClientCount @RequiredClientCount end |
- (string) TokenActivationAdditionalInfo (readonly)
Additional information for token-based activation.
267 268 269 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 267 def TokenActivationAdditionalInfo @TokenActivationAdditionalInfo end |
- (string) TokenActivationCertificateThumbprint (readonly)
Thumbprint of the certificate that activated the product.
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.
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.
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.
287 288 289 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 287 def TokenActivationILVID @TokenActivationILVID end |
- (datetime) TrustedTime (readonly)
The trusted time for the product.
292 293 294 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 292 def TrustedTime @TrustedTime end |
- (string) UseLicenseURL (readonly)
Software licensing server URL for the user license
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.
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.
307 308 309 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 307 def VLRenewalInterval @VLRenewalInterval end |
Instance Method Details
- (uint32) Activate
Activates the current product.
13 14 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 13 def Activate end |
- (uint32) ClearKeyManagementServiceMachine
Clears any previously configured KMS host name.
50 51 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 50 def ClearKeyManagementServiceMachine end |
- (uint32) ClearKeyManagementServicePort
Clears any previously specified port number.
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.
21 22 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 21 def DepositOfflineConfirmationId ConfirmationId, InstallationId end |
- (uint32) DepositTokenActivationResponse(CertChain, Challenge, Response)
Deposits token-based activation response.
86 87 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 86 def DepositTokenActivationResponse CertChain, Challenge, Response end |
- (uint32) GenerateTokenActivationChallenge
Returns token-based activation challenge.
77 78 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 77 def GenerateTokenActivationChallenge end |
- (uint32) GetPolicyInformationDWord(PolicyName)
Gets license policy Information of type DWORD.
29 30 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 29 def GetPolicyInformationDWord PolicyName end |
- (uint32) GetPolicyInformationString(PolicyName)
Gets policy information of type string.
37 38 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 37 def GetPolicyInformationString PolicyName end |
- (uint32) GetTokenActivationGrants
Returns token-based activation grants.
70 71 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 70 def GetTokenActivationGrants end |
- (uint32) SetKeyManagementServiceMachine(MachineName)
Sets the KMS host name to use for volume activation.
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.
57 58 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 57 def SetKeyManagementServicePort PortNumber end |
- (uint32) UninstallProductKey
Uninstalls a product key for the current product.
7 8 |
# File 'lib/OfficeSoftwareProtectionProduct.rb', line 7 def UninstallProductKey end |