Format XML Tags for Protection Keys

The table that follows describes all possible format XML tags that can be used with the AdminApi.adminGet method to request information for protection keys and the possible output values for each tag.

For an example of how these tags can be used, see Retrieve All Data for a Specific Key ID.

Tag	Description and Output Values
`<addresses>`	Address of the protection key. Possible output values are: >For a local key: Local >For a remote key: IP address of the machine where the key is located. Multiple addresses may be listed. (For example, for a machine with multiple network cards)
`<alert>`	SL keys only. If the key was cloned, this tag contains the following message: Duplicate key found at ...
`<architecture>`	Architecture of the operating system on the machine. For example: Intel64 Family 6 Model 94 Stepping 3
`<blinkstate>`	HL keys only. Whether the key is blinking. Possible output values are: 0 - Cannot blink (for example: HL Chip) 1 - Blinking is off (steady light) 2 - Currently blinking
`<case_color>`	HL keys only. The color of the case of the key. Possible output values are 0 (red), 1 (blue), 2 (green), 3 (orange), 4 (ice), 5 (purple), 6 (lime), 7 (pink), 8 (black), 9 (light grey), 10 (yellow), 11 (light blue)
`<case_gen>`	HL keys only. The generation of the case of the key.
`<case_read>`	HL keys only. Two bytes that represent the generation of the case. A third bye represents the color of the case.
`<case>`	HL keys only. A one-byte value that contains the size and color of the key.
`<cloned>`	Whether the protection key was flagged as a cloned key. Possible output values are: 0 - Not cloned. 1 - Cloned.
`<clonedfrgid>`	Whether the Secure Storage (Fridge) ID is cloned. Possible output values are: 0 - No 1 - Yes
`<configuration>`	Key configuration. For details, see the description of the info parameter (keyConfiguration) in the AdminApi.adminGet method.
`<detachable>`	SL keys only. Whether the licenses in a protection key are detachable. Possible output values are: 0 - No 1 - Yes
`<disabled>`	Whether the protection key is disabled. Possible output values are: 0 - Not disabled 1 - Disabled An SL key may be disabled if cloning is detected. An HL key may be disabled if attempted tampering is detected.
`<disk_size>`	Size (in bytes) of the storage in a Sentinel HL Drive key.
`<firmware>`	Firmware version of the key. For example: 4.30
`<fqdn_duplicates>`	List of duplicate FQDNs.
`<fqdn_has_duplicates>`	Whether a protection key has been flagged as a cloned key when using the FQDN clone protection scheme. Possible output values are: 0 - No (not cloned). 1 - Yes (cloned).
`<fqdn>`	Value for the FQDN scheme for clone protection.
`<cloud_based>`	Whether the SL key supports cloud licensing. Possible values are: 0 - The key does not support cloud licensing. 1 - The key is on the local machine and supports cloud licensing. 2 - The key is on a remote machine and supports cloud licensing.
`<has_products>`	Whether the machine currently has at least one protection key that contains at least one Product license with at least one Feature. Possible output values are: 0 - No 1 - Yes
`<haspc2v>`	Whether the C2V action is available for this protection key in Sentinel Admin Control Center - Sentinel Keys page. Possible output values are: 0 - No 1 - Yes The value “1” can only be returned if the configuration parameter Generate C2V file for HASP key is selected in Admin Control Center.
`<haspid>`	Key ID of the protection key.
`<haspname>`	Friendly key name assigned to the Key ID. If none given, returns the numeric Key ID of the protection key.
`<hostname>`	Name of the machine to which the protection key is connected. For example: BEI-4X0XDC2
`<hw_version>`	HL key's hardware version. For example: 7.0
`<hwinfo>`	HL key's hardware version (in detail). For example: 7,0,0,0
`<index>`	Index of the row for this key in the table of Sentinel keys in Admin Control Center.
`<iscommuter>`	Whether the protection key is a detachable license. Possible output values are: 0 - Regular protection key. 1 - Detachable license that is attached to the local machine.
`<islocal>`	Whether the protection key is a local key or a remote key. Possible output values are: 0 - Remote 1 - Local
`<key_disabled>`	Whether an HL key is disabled for attempted tampering with the key or with the protected application. Possible output values are: 0 - Not disabled 1 - Disabled
`<led>`	HL keys only. Color of the LED. Values are: 0 – No LED, 1-Green, 2-Red, 3-Blue. (Currently, only red LEDs are used.)
`<local>`	One of the following: >If <islocal> = 0, contains the IP address of the remote machine where the key is connected >If <islocal> = 1, contains Local
`<localname>`	One of the following: If <islocal> = 0, contains the name of the remote machine where the key is connected If <islocal> = 1, contains Local
`<loginlimit>`	Maximum number of logins allowed (concurrency).
`<mass>`	HL key's mass storage (flash) information, expressed as a 1-byte value. This is the result of a (memory & 0xF) operation. Possible output values are: 0 (No flash memory available), 1 (128 MB), 2 (256 MB), 3 (512 MB), 4 (1 GB), 5 (2 GB), 6 (4 GB), 7 (8 GB), 8 (16 GB).
`<noid>`	Whether the protection key has a Key ID. Possible output values are: 0 - A Key ID exists for the key. 1 - A Key ID does not exist for the key (an HL Basic key).
`<oldkey>`	Whether the HL key is supported by the current License Manager. Possible output values are: 0 - The key is supported. 1 - The key is no longer supported.
`<osname>`	Name of the operating system on the machine. For example: Windows 10 Enterprise
`<osversion>`	Version of the operating system (as a string) on the machine. For example: Build 19043
`<rehost_type>`	SL AdminMode keys only. Whether rehosting is enabled for the key. Possible output values are: 0 - Rehosting is disabled. 1 - Rehosting is enabled.
`<serverruntime>`	Machine uptime, expressed as: d days h hours m minutes. For example: 30 days 12 hours 9 minutes
`<sessioncount>`	Number of active sessions for the key.
`<typename>`	Type of protection key. For details, see the description of the info parameter (keytype) in the AdminApi.adminGet method.
`<uptime>`	Machine uptime in seconds.
`<vbuildnumber>`	Build number of the Sentinel License Manager
`<vbuildservid>`	Build agent of the Sentinel License Manager
`<vendor_dll_status>`	Status of Vendor library in \Common Files\Aladdin Shared\HASP) . Possible return values are: 0 – The library does not exist or returned an error code. 1 - The library exists.
`<vendorid>`	Vendor ID (numeric value.)
`<vendorname>`	Name for the Vendor ID. If none, returns the Vendor ID (numeric value).
`<vmaj>`	Version - major version number of Sentinel License Manager
`<vmin>`	Version - minor version number of Sentinel License Manager

Format XML Tags for Protection Keys

Related Topics