Sample payload for Citrix software install records
Summarize
Summary of Sample payload for Citrix software install records
This guide provides a sample payload structure for integrating Citrix software install records into ServiceNow'sSoftware Installation [cmdbsamswinstall]table using the Citrix publisher pack. It supports Citrix virtual applications and virtual desktops, which use concurrent and user/device licensing models. The payload enables populating multiple related tables for accurate license management and reconciliation against purchased entitlements.
Show less
Key Features
- Citrix License Server Identifier [cmdbciappllicenseserver]: Used to populate license consumption entries in sampconcurrentlicenseconsumption and sampuserdevicelicenseconsumption tables based on your licensing entitlements.
- Citrix Delivery Controller Identifier [cmdbciappldeliverycontroler]: Used to create software install records across seven related Citrix tables, ultimately populating the Software Installation [cmdbsamswinstall] table.
- Payload Structure: Contains related entries and key attributes (such as productcode, consumer, and consumertype) to properly link license consumption and software install records with their parent configuration items.
- Scheduled Jobs:
- SAM - Create Citrix CAL entries: Processes payload data to update the Client Access [sampswclientaccess] table with user/device licensing counts.
- SAM - Create Citrix Software installs: Populates the Software Installation table with Citrix software install records.
Practical Application for ServiceNow Customers
By sending correctly structured payloads referencing the Citrix License Server and Delivery Controller identifiers, customers can automate the ingestion of Citrix licensing and software installation data from third-party discovery sources. This ensures that ServiceNow's Software Asset Management (SAM) accurately reflects Citrix license consumption and installation status, enabling better license reconciliation and compliance tracking.
It is essential to configure and schedule the associated SAM jobs to process these payloads after they are ingested, ensuring client access records and software install records are updated timely and correctly.
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
}]
}