Sample payload for Citrix software install records

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Sample payload for Citrix software install records

    This content provides a sample payload for the Citrix publisher pack that populates the Software Installation records in the ServiceNow IT Asset Management module using data from third-party discovery sources. It supports Citrix products such as virtual applications and virtual desktops, which utilize concurrent and user/device licensing models.

    Show full answer Show less

    Key Features

    • The payload interacts with two key identifiers: the Citrix License Server and the Citrix Delivery Controller.
    • CAL (Client Access License) entries are created for license reconciliation against purchased rights.
    • Two tables need to be populated based on licensing entitlements:
      • sampconcurrentlicenseconsumption: Requires productcode and number.
      • sampuserdevicelicenseconsumption: Requires productcode, consumer, and consumertype.
    • After sending the payload, scheduled jobs must be executed to update the relevant Client Access and Software Installation tables.

    Key Outcomes

    By correctly populating the specified tables with the payload, ServiceNow customers can expect:

    • Accurate license consumption tracking for Citrix products.
    • Creation of software install records in the Software Installation table.
    • Updated Client Access records reflecting user/device counts for better compliance and management.

    Ensure that the scheduled jobs are configured to run after payload processing to maintain consistency and accuracy in the records.

    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 Citrix publisher pack supports two products: virtual applications and virtual desktop. For these products, Citrix supports concurrent licensing and user/device licensing.
    Note:
    For information on license metrics, see Software License Metrics

    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.

    Send a payload to populate the samp_concurrent_license_consumption or the samp_user_device_license_consumption table. Ensure that you mention the key attributes for the tables in the payload:
    • samp_concurrent_license_consumption: product_code and number
    • samp_user_device_license_consumption: product_code, consumer, and consumer_type
    Note:
    The two tables are passed in one payload since both are related entries of the parent CI table, cmdb_ci_appl_license_server. In the payload, specify the relationship between the tables and the CI parent table.
    Once you send the payload, entries are created in the samp_concurrent_license_consumption and the samp_user_device_license_consumption tables. Now execute the scheduled job, SAM- Create Citrix CAL entries, to update the Client Access [samp_sw_client_access] table. Client access records are created for each product with user/device count. ​
    Note:
    Ensure that you configure the schedule job, SAM- Create Citrix CAL entries to execute after processing the payload successfully.
    Using the Citrix Delivery Controller [cmdb_ci_appl_delivery_controler] identifier, send a payload to populate all the 7 Citrix tables. Make sure that you mention the key attributes for the 7 tables in the payload.
    Note:
    Click Related Entries in the Citrix Delivery Controller identifier to look up the key attributes (Criterion attributes) for the Citrix tables.
    Once the entries are created in the tables, execute the scheduled job, SAM- Create Citrix Software installs. The Citrix sofware install records are created in the Software Installation [cmdb_sam_sw_install] table.
    { '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
                     }]
                }