Sample payload for Citrix software install records
Summarize
Summary of Sample payload for Citrix software install records
This content provides guidance on using a sample payload to populate Citrix software install records and license consumption data in ServiceNow. It supports Citrix virtual applications and virtual desktops with concurrent and user/device licensing models. The payload is intended for integration with third-party discovery sources to update thecmdbsamswinstalland related license consumption tables.
Show less
Key Features
- The payload uses two key CI identifiers:
- Citrix License Server (cmdbciappllicenseserver): Populates Client Access License (CAL) entries and updates license consumption tables.
- Citrix Delivery Controller (cmdbciappldeliverycontroler): Creates software install records and populates seven related Citrix tables.
- License consumption is tracked in two tables based on license type:
- sampconcurrentlicenseconsumption: Requires
productcodeandnumber(usage counts). - sampuserdevicelicenseconsumption: Requires
productcode,consumer, andconsumertype(user or device).
- sampconcurrentlicenseconsumption: Requires
- The payload includes relationships between license consumption tables and the parent Citrix License Server CI.
- After sending the payload, scheduled jobs must be executed:
- SAM - Create Citrix CAL entries: Updates the sampswclientaccess table with client access records per product.
- SAM - Create Citrix Software installs: Creates software installation records in cmdbsamswinstall based on Citrix Delivery Controller data.
Practical Application for ServiceNow Customers
- Use the sample payload format to accurately populate Citrix software install and license consumption records, ensuring licensing data aligns with purchased entitlements.
- Include all key attributes for the relevant license consumption tables to enable correct reconciliation and license position calculations.
- Configure and schedule the provided ServiceNow jobs after payload processing to complete client access and software install record creation workflows.
- Reference the “Related Entries” in the Citrix Delivery Controller CI to determine key attributes needed for the seven Citrix tables during payload construction.
A sample payload for the Citrix publisher pack that populates the Software Installation [cmdb_sam_sw__install] table with software install records from third-party discovery sources.
The IRE API relies on two CI identifier rules for creating Citrix software install records. The Citrix License server [cmdb_ci_appl_license_server] identifier populates the CAL entries and the Citrix Delivery Controller [cmdb_ci_appl_delivery_controler] identifier creates the software install records.
The CAL entries are used during reconciliation to compare against the purchased rights in entitlements to get the correct license position for Citrix products. The Citrix License server identifier provides information on the samp_concurrent_license_consumption and the samp_user_device_license_consumption tables. Based on your licensing entitlements, you need to populate either of these two tables.
- samp_concurrent_license_consumption: product_code and number
- samp_user_device_license_consumption: product_code, consumer, and consumer_type
{ 'items': [{'className':'cmdb_ci_appl_license_server',
'related': [
{
'className':'samp_concurrent_license_consumption',
'values':{
'product_code':'MW2ZPSE0001',
'in_use_count':511,
'overdraft':11,
'pooled_available':0,
'total_count':500
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'XDT_PLT_CCS',
'consumer':'consumer1',
'consumer_type':'user'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'XDT_PLT_CCS',
'consumer':'Device1',
'consumer_type':'device'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'XDT_PLT_CCS',
'consumer':'consumer2',
'consumer_type':'user'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'XDT_PLT_CCS',
'consumer':'consumer3',
'consumer_type':'user'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'XDT_PLT_CCS',
'consumer':'consumer4',
'consumer_type':'user'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'MW2ZPSE0001',
'consumer':'consumer5',
'consumer_type':'user'
}
},
{
'className':'samp_user_device_license_consumption',
'values':{
'product_code':'MW2ZPSE0001',
'consumer':'Device1',
'consumer_type':'device'
}
}
],
'values': {
'name': 'ACME License Server 2',
'tcp_port': 22,
'install_directory': 'Documents'
}
},
{
'className':'cmdb_ci_win_server',
'values': {'name':'samlabvm450'}
}
],
'relations':[{
'type':'Runs on::Runs',
'parent':0,
'child':1
}]
}