Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Adds a persistent CustomInventory row to the database, meaning that the data will not be flushed out the next time that the CustomInventory package is run.

Info

...

Please note

Please note, that this is an expensive call, seen from the Frontend/database perspective. Calling this function repeatedly from a package could result in overall slower performance. This function should be used with care. 

Syntax

(blue star) CMS_AddCustomInventory(category, entry, value, valuetype)

(blue star) [bool]CMS_AddCustomInventory -category <string> -entry <string> -value <string> -valuetype <string>

Parameters

category (String)

Category name

entry (String)

variable name

value (string)

value (string)

...

If you want to use 'now' as the value, you can either insert;

  • an empty string ("")

  • or the value ("0")

valuetype (string)

The type of the value

Valid valuetypes are;

  • "S" for string

  • "I" for integer

  • "T" for time

Return value

(blue star) Boolean, TRUE if function completed successfully.

(blue star) Boolean, TRUE if function completed successfully. 

Example

(blue star) VBScript
Code Block
theme
languagevbEclipse
titleVBScript
If bStatus Then bStatus = CMS_AddCustomInventory("Customer Inventory", "Install time packages", "112", "I")
If bStatus Then bStatus = CMS_AddCustomInventory("Bitlocker", "TPM Chip - Enabled", "True", "S")
If bStatus Then bStatus = CMS_AddCustomInventory("Bitlocker", "TPM Chip - Manufactured", "1694973146", "T")
(blue star) PowerShell
Code Block
languagepowershell
CMS_AddCustomInventory 'Customer Inventory' 'Install time packages' '112' 'I'

CMS_AddCustomInventory -category 'Bitlocker' -entry 'TPM Chip - Enabled' -value 'True' -valuetype 'S'

if (CMS_AddCustomInventory('Bitlocker' 'TPM Chip - Manufactured' '1694973146' 'T') {
  $cs.Job_WriteLog("Added", "Bitlocker entry added to Custom inventory")
}

Scripting Guidelines

Related functions

CMS_RemoveCustomInventory