20.3.1 Device registration
This API registers device information in the management server.
- Note
-
You can register multiple device information in the management server with just one request. When specified information regarding one of the devices to be registered contains an error, the registration of the erroneous device information is skipped, and the processing continues.
- Note
-
Device registration is executed asynchronously. For this reason, even when a response is successfully returned, it does not necessarily mean that the devices have already been registered in the management server.
- Note
-
The security judgment is performed when all of the following conditions are met. The violation level becomes Unknown when the information necessary for security status judgment is insufficient. Disable the security setting items of security policies as necessary.
-
The SystemInventory object exists.
-
The SecurityInventory object exists.
-
The device type is PC or Server, and the OS type is Windows or Mac OS.
-
Windows or Mac OS is specified as the OS code.
-
In case of Windows, an OS language is specified.
-
Execution permission
You need the following permission:
-
API permission
API version
v1
Request format
- Request line
POST /jp1itdm/api/v1/objects/devices HTTP/1.1
- Request header
Host:host-name-or-IP-address-of-management-server:port-number-of-management-server Accept-Language:language-code-in-the-message-of-response Accept:application/json Content-Type:application/json X-ITDM-Authorization1:Base64-encoded-user-ID X-ITDM-Authorization2:Base64-encoded-password
- Request message body
-
Specify information regarding the devices to be registered in JSON format. For details, see Data format of information regarding the devices to be registered in this section.
Data format of information regarding the devices to be registered
Information regarding the devices to be registered must be specified in the following format:
{ "Device-Inventory": [ { "Report": { "@Version": "0250", "ID": "identifier", "@CreationDate": "YYYY-MM-DDTHH:MM:SS.sssZ", "Agent": { "Type": "REST", "DeviceStatus": "device-status", "Status": "management-status-registered-device", "DistributionStatus": "0", "DiscoveryProtocol": "7", "LastAliveDate": "YYYY-MM-DDTHH:MM:SS.sssZ" }, "Inventory": { "Equipment": { "Type": "device-type", "UserType": "device-type-added-by-user" }, "SystemInventory": { "@LastUpdateTime": "YYYY-MM-DDTHH:MM:SS.sssZ", "BaseBoard": { "SerialNumber": "motherboard-serial-number" }, "BIOS": { "Manufacturer": "BIOS-manufacturer", "Name": "BIOS-name", "ReleaseDate": "BIOS-released-date", "SerialNumber": "BIOS-serial-number", "SMBIOSBIOSVersion": "BIOS-version-(SMBIOS)", "Version": "BIOS-version" }, "CDROMDriveList": { "CDROMDrive": [ { "Name": "CD-ROM-drive-name" }, ... ] }, "ComputerSystem": { "CurrentTimezone": "current-timezone", "Domain": "domain-workgroup", "DomainRole": "domain-role", "Manufacturer": "manufacturer", "Model": "model-name", "Name": "computer-name", "NumberOfProcessors": "number-of-processors", "TotalPhysicalMemory": "physical-memory", "UserName": "user-name" }, "ComputerSystemProduct": { "IdentifyingNumber": "machine-serial-number", "UUID": "machine-UUID" }, "DesktopMonitorList": { "DesktopMonitor": [ { "Name": "monitor-name" }, ... ] }, "DiskDriveList": { "DiskDrive": [ { "DeviceID": "device-ID-of-harddisk", "InterfaceType": "interface-type-of-harddisk", "Model": "model-name-of-harddisk", "Size": "harddisk-size" }, ... ] }, "KeyboardList": { "Keyboard": [ { "Description": "keyboard-name" }, ... ] }, "LogicalDiskList": { "LogicalDisk": [ { "DeviceID": "drive-letter", "DriveType": "drive-type", "FileSystem": "file-system", "FreeSpace": "drive-free-space", "Size": "drive-size" }, ... ] }, "DiskDriveToLogicalDiskList": { "DiskDriveToLogicalDisk": [ { "DiskDriveDeviceID": "harddisk-device-ID", "LogicalDiskDeviceID": "drive-letter" }, ... ] }, "BitLocker": { "DriveList": { "Drive": [ { "DriveLetter": "drive-letter", "ProtectionStatus": "BitLocker-protection-status", "LockStatus": "lock-status" }, ... ] } }, "NetworkAdapterList": { "NetworkAdapter": [ { "DeviceID": "device-ID-of-network-adapter", "Name": "name-of-network-adapter" }, ... ] }, "NetworkAdapterConfigurationList": { "NetworkAdapterConfiguration": [ { "DefaultIPGatewayList": { "DefaultIPGateway": [ { "_value": "default-gateway", "@Index": "index" } ] }, "DHCPEnabled": "DHCP-enable-or-disable", "DHCPLeaseExpires": "DHCP-lease-expires", "DHCPLeaseObtained": "DHCP-lease-obtained", "DHCPServer": "DHCP-server-address", "DNSServerSearchOrderList": { "DNSServerSearchOrder": [ { "_value": "DNS-server-address", "@Index": "index" }, ... ] }, "Index": "setting-ID-of-network-adapter-configuration-information", "IPAddressList": { "IPAddress": [ { "_value": "IP-address", "@Index": "index" }, ... ] }, "IPSubnetList": { "IPSubnet": [ { "_value": "subnet-mask", "@Index": "index" } ] }, "MACAddress": "MAC-address", "WINSPrimaryServer": "primary-WINS-server-address", "WINSSecondaryServer": "secondary-WINS-server-address" }, ... ] }, "NetworkAdapterToNetworkAdapterConfigurationList": { "NetworkAdapterToNetworkAdapterConfiguration": [ { "NetworkAdapterDeviceID": "device-ID-of-network-adapter", "NetworkAdapterConfigurationIndex": "setting-ID-of-network-adapter-configuration-information" }, ... ] }, "HostName": "host-name", "OperatingSystem": { "OSKind": "OS-kind", "Caption": "OS-name", "KernelVersion": "kernel-version", "CSDVersion": "service-pack-or-OS-version", "Description": "description-of-computer", "Locale": "locale", "Organization": "organization", "OSCode": "OS-code", "OSLanguage": "OS-language", "RegisteredUser": "registered-user-name", "SerialNumber": "OS-serial-number", "TotalVirtualMemorySize": "total-virtual-memory-size" }, "PhysicalMemoryList": { "PhysicalMemory": [ { "Capacity": "physical-memory-capacity" }, ... ] }, "PointingDeviceList": { "PointingDevice": [ { "Name": "mouse-name" } ], ... }, "PrinterList": { "Printer": [ { "Attributes": "printer-attributes", "DriverName": "printer-driver-name", "Name": "printer-name", "PortName": "printer-port-name", "ServerName": "printer-server-name", "ShareName": "printer-shared-name" }, ... ] }, "ProcessorList": { "Processor": [ { "Name": "processor-name" }, ... ] }, "SoundDeviceList": { "SoundDevice": [ { "Manufacturer": "sound-device-manufacturer", "Name": "sound-device-product-name" }, ... ] }, "UserAccount": { "Description": "user-description", "FullName": "user-name" }, "VideoControllerList": { "VideoController": [ { "AdapterRAM": "VRAM-capacity", "Name": "video-driver-name", "VideoProcessor": "video-processor" }, ... ] }, "AMTFirmwareVersion": "AMT-firmware-version", "WindowsInstaller": "Windows-Installer-version", "IEVersion": "Internet-Explorer-version", "IEServicePack": "Internet-Explorer-service-pack", "PowerManagement": { "VideoTimeoutAC": "video-timeout-AC", "VideoTimeoutDC": "video-timeout-DC", "SpindownTimeoutAC": "spindown-timeout-AC", "SpindownTimeoutDC": "spindown-timeout-DC", "StandbyTimeoutAC": "standby-timeout-AC", "StandbyTimeoutDC": "standby-timeout-DC", "HibernateTimeoutAC": "hibernate-timeout-AC", "HibernateTimeoutDC": "hibernate-timeout-DC", "ThrottlePolicyAC": "throttle-policy-AC", "ThrottlePolicyDC": "throttle-policy-DC" }, "property": [ { "@category": "category-name", "@key": "key", "@value": "value", "@type": "type", "@record": "record-number" }, ... ] "SmartDeviceInformation": { "UUID": "device-identifier", "IMEI": "IMEI", "UDID": "UDID", "ICCID": "ICCID", "IMSI": "IMSI", "PhoneNumber": "phone-number", "mail": "E-mail-address", "Carrier": "carrier", "PasscodeSetting": "passcode-setting", "PhisicalMemory": { "Size": "physical-memory-size", "FreeSpace": "physical-memory-free-size" }, "Storage": { "Size": "storage-size", "FreeSpace": "storage-free-space" }, "Media": { "Size": "external-media-size", "FreeSpace": "external-media-free-space" } } }, "InstalledSoftware": { "@ReportType": "All", "@LastUpdateTime": "YYYY-MM-DDTHH:MM:SS.sssZ", "SoftwareList": { "Software": [ { "@Type": "software-type", "SourceID": "source-ID", "InstallPath": "install-path", "Name": "software-name", "Version": "software-version", "Publisher": "software-publisher", "InstallDate": "YYYY-MM-DDTHH:MM:SS.sssZ", "HelpLink": "support-URL", "AppType": "app-type" }, ... ] } }, "Update": { "@ReportType": "All", "@LastUpdateTime": "YYYY-MM-DDTHH:MM:SS.sssZ", "SoftwareList": { "Software": [ { "HotFixID": "hotfix-ID", "Description": "hotfix-description", "InstallDate": "YYYY-MM-DDTHH:MM:SS.sssZ", "Type": "hotfix-type" }, ... ] } }, "SecurityInventory": { "@LastUpdateTime": "YYYY-MM-DDTHH:MM:SS.sssZ", "AccountList": { "Account": [ { "Name": "account-name", "LastPasswordModifiedDate": "last-password-modified-date", "WeakPassword": "weak-password", "UnexpirePassword": "unexpire-password", "ScreenSaverEnabled": "screen-saver-enabled", "ScreenSaverIsSecure": "screen-saver-is-secure", "ScreenSaverTimeout": "screen-saver-timeout" }, ... ] }, "PowerOnPassword": "power-on-password", "GuestAccount": "Guest-account", "AutoLogin": "auto-login", "SharedDirectory": "shared-directory", "AutoShareServer": "auto-share-server", "DCOM": "DCOM", "RestrictAnonymous": "restrict-anonymous-access", "WindowsFirewall": "Windows-firewall-setting", "WindowsUpdate": "Windows-update", "DenyTSConnections": "remote-desktop-connection" }, "ExtendedInventory": { "@LastUpdateTime": "YYYY-MM-DDTHH:MM:SS.sssZ", "ExtendInventoryList": { "ExtendInventoryItem": [ { "@InformationType": "information-type", "ItemName": "additional-management-item", "Value": "input-item-value", "ValueList": { "Value": "setelcted-item-value", ... }, "ValueTree": { "Value": { "Data": "value-of-tier-1", "Value": { "Data": "value-of-tier-2", "Value": { "Data": "value-of-tier-3", "Value": { ... } } } } } } }, ... ] } } } } }, ... ] }
- Legend:
-
, ...: Iterations of the previous object or data definition
...: Iterations of the previous layer
- Note
-
When there are duplicate elements like shown on the following JSON example, the last element is selected. In addition, if an element not defined in the API is specified, it is ignored.
{ "Device-Inventory": [ { "Report": { (omitted) "Agent": { //Duplicate element (omitted) }, "Agent": { //Duplicate element, the last one is selected (omitted) }, "UndefinedItem" : "xxx", //Undefined element, it is ignored "Inventory": { (omitted)
Device-Inventory
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Device-Inventory |
Array |
Mandatory |
Root name of information regarding the devices to be registered. Specify at least one but no more than 1,000 Report objects. |
Report |
Object |
Mandatory |
Object name of the device information. For details, see Report object. |
- Important
-
One Report object should be within 1 MB of data size.
Report object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@Version |
string |
Mandatory |
Always specify 0250. |
ID |
string |
Mandatory |
ID that uniquely identifies the device. Specify a string of ASCII characters except control characters. |
@CreationDate |
dateTime |
Mandatory |
Specify the date and time when the Report object was generated. |
Agent |
Object |
Mandatory |
Object name of basic information regarding the device. For details about this object, see Agent object. |
Inventory |
Object |
Optional |
Object name of information regarding the inventory. For details about this object, see Inventory object. |
Agent object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Type |
string |
Mandatory |
Always specify REST. |
DeviceStatus |
int |
Mandatory |
Device status. Specify one of the following:
|
Status |
int |
Mandatory |
Management status at the time the device is registered. Specify one of the following:
|
DistributionStatus |
int |
Mandatory |
Always specify 0. |
DiscoveryProtocol |
int |
Mandatory |
Always specify 7. |
LastAliveDate |
dateTime |
Optional |
Specify the last date and time the device was checked. If you omit this item, the date and time when the device is registered is set. |
Inventory object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Equipment |
Object |
Mandatory |
Object name of the device information. For details, see Equipment object. |
SystemInventory |
Object |
Optional |
Object name of system information and hardware information. For details, see SystemInventory object. |
InstalledSoftware |
Object |
Optional |
Object name of information regarding installed software. For details see InstalledSoftware object. |
Update |
Object |
Optional |
Object name of update information. For details, see Update object. |
SecurityInventory |
Object |
Optional |
Object name of security and OS setting information. For details, see SecurityInventory object. |
ExtendInventory |
Object |
Optional |
Object name of common management fields of asset information and device information, and additional management fields of hardware asset information. For details, see ExtendedInventory object. |
Equipment object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Type |
string |
Mandatory |
Device type. Specify one of the following:
|
UserType |
string |
This item is mandatory if EquipmentTypeUser is specified as Type, and optional in all the other cases. |
If you specified EquipmentTypeUser as Type, specify the device type added by the user. |
SystemInventory object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@LastUpdateTime |
dateTime |
Mandatory |
Specify the date and time when the SystemInventory object was generated. |
BaseBoard |
Object |
Optional |
Object name of motherboard information. For details, see BaseBoard object. |
BIOS |
Object |
Optional |
Object name of BIOS information. For details, see BIOS object. |
CDROMDriveList |
Object |
Optional |
Object that puts together CD-ROM drive information. For details, see CDROMDriveList object. |
ComputerSystem |
Object |
Optional |
Object name of computer information. For details, see ComputerSystem object. |
ComputerSystemProduct |
Object |
Optional |
Object name of computer product information. For details, see ComputerSystemProduct object. |
DesktopMonitorList |
Object |
Optional |
Object that puts together monitor information. For details, see DesktopMonitorList object. |
DiskDriveList |
Object |
Optional |
Object that puts together hard disk information. For details, see DiskDriveList object. |
KeyboardList |
Object |
Optional |
Object that puts together keyboard information. For details, see KeyboardList object. |
LogicalDiskList |
Object |
Optional |
Object that puts together Logical drive information. For details, see LogicalDiskList object. |
DiskDriveToLogicalDiskList |
Object |
Optional |
Object representing information that associates hard disk information with logical drive information. For details, see DiskDriveToLogicalDiskList object. |
BitLocker |
Object |
Optional |
Object name of BitLocker drive encryption information. For details, see BitLocker object. |
NetworkAdapterList |
Object |
Optional |
Object that puts together network adapter information. For details, see NetworkAdapterList object. |
NetworkAdapterConfigurationList |
Object |
Optional |
Object that puts together network adapter configuration information. For details, see NetworkAdapterConfigurationList object. |
NetworkAdapterToNetworkAdapterConfigurationList |
Object |
Optional |
Object representing information that associates network adapter information with network adapter configuration information. For details, see NetworkAdapterToNetworkAdapterConfigurationList object. |
HostName |
string |
Optional |
Specify a host name, which must be ASCII characters and no more than 256 characters. |
OperatingSystem |
Object |
Optional |
Object name of operating system information. For details, see OperatingSystem object. |
PhysicalMemoryList |
Object |
Optional |
Object that puts together physical memory information. For details, see PhysicalMemoryList object. |
PointingDeviceList |
Object |
Optional |
Object that puts together mouse information. For details, see PointingDeviceList object. |
PrinterList |
Object |
Optional |
Object that puts together printer information. For details, see PrinterList object. |
ProcessorList |
Object |
Optional |
Object that puts together processor information. For details, see ProcessorList object. |
SoundDeviceList |
Object |
Optional |
Object that puts together sound card information. For details, see SoundDeviceList object. |
UserAccount |
Object |
Optional |
Object name of user account information. For details, see UserAccount object. |
VideoControllerList |
Object |
Optional |
Object that puts together video controller information. For details, see VideoControllerList object. |
AMTFirmwareVersion |
string |
Optional |
Specify the AMT firmware version, which must be no more than 128 characters. |
WindowsInstaller |
string |
Optional |
Specify the Windows Installer version, which must be no more than 1,024 characters. |
WindowsUpdateAgent |
string |
Optional |
Specify the Windows Update Agent version, which must be no more than 1,024 characters. |
OSLastStartupTime |
dateTime |
Optional |
Specify the last date and time the OS was started. |
WindowsDirectory |
string |
Optional |
Specify the Windows directory, which must be no more than 255 characters. |
IEVersion |
string |
Optional |
Specify the Internet Explorer version, which must be no more than 64 characters. |
IEServicePack |
string |
Optional |
Specify the Service Pack applied to Internet Explorer, which must be no more than 1,024 characters. Enclose the specified character string in semicolons (;), as in ;SP2;. |
PowerManagement |
Object |
Optional |
Object name of power management information. For details, see PowerManagement object. |
property |
Array |
Optional |
Array whose elements consist of one or more objects representing general inventory information. For details, see property array. Specify up to 512 objects for this array. |
SmartDeviceInformation |
Object |
Optional |
Object name of smart device information. For details, see SmartDeviceInformation object. |
BaseBoard object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
SerialNumber |
string |
Optional |
Specify the serial number of the motherboard, which must be no more than 1,024 characters. |
BIOS object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Manufacturer |
string |
Optional |
Specify the manufacturer of the BIOS, which must be no more than 1,024 characters. |
Name |
string |
Optional |
Specify the name of the BIOS, which must be no more than 1,024 characters. |
ReleaseDate |
dateTime |
Optional |
Specify the date and time when the BIOS was released. |
SerialNumber |
string |
Optional |
Specify the serial number of the BIOS, which must be no more than 1,024 characters. |
SMBIOSBIOSVersion |
string |
Optional |
Specify the SMBIOS version of the BIOS, which must be no more than 1,024 characters. |
Version |
string |
Optional |
Specify the version of the BIOS, which must be no more than 1,024 characters. |
CDROMDriveList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
CDROMDrive |
Array |
Mandatory |
Array whose elements consist of one or more objects representing CD-ROM drive information. You have to specify 1 to 26 objects for this array. |
Name |
string |
Optional |
This item is part of each object in the CDROMDrive array. Specify the CD-ROM drive name, which must be no more than 1,024 characters. |
ComputerSystem object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
CurrentTimeZone |
int |
Optional |
Specify the current time zone in minutes. For example, specify 540 (9 hours) for Japan Standard Time. |
Domain |
string |
Optional |
Specify the name of the domain or work group, which must be no more than 1,024 characters. |
DomainRole |
string |
Optional |
Domain role. Specify one of the following:
|
Manufacturer |
string |
Optional |
Specify the manufacturer of the computer, which must be no more than 1,024 characters. |
Model |
string |
Optional |
Specify the model name of the computer, which must be no more than 1,024 characters. |
Name |
string |
Optional |
Specify the computer name, which must be no more than 1,024 characters. |
NumberOfProcessors |
unsignedInt |
Optional |
Specify the number of processors installed on the computer, which must be 0 to 65535. |
TotalPhysicalMemory |
unsignedLong |
Optional |
Specify the amount of memory installed on the computer in bytes. |
UserName |
string |
Optional |
Specify the user of the physical console session who last logged in, which must be no more than 1,024 characters. If the user is currently logged in, specify the current user. |
ComputerSystemProduct object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
IdentifyingNumber |
string |
Optional |
Specify the serial number of the machine, which must be no more than 1,024 characters. |
UUID |
string |
Optional |
Specify the machine UUID, which must be no more than 1,024 characters. |
DesktopMonitorList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
DesktopMonitor |
Array |
Mandatory |
Array whose elements consist of one or more objects representing monitor information. You have to specify 1 to 8 objects for this array. |
Name |
string |
Optional |
This item is part of each object in the DesktopMonitor array. Specify the name of the monitor, which must be no more than 1,024 characters. |
DiskDriveList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
DiskDrive |
Array |
Mandatory |
Array whose elements consist of one or more objects representing hard disk information. You have to specify 1 to 255 objects for this array. |
DeviceID |
string |
Mandatory |
This item is part of each object in the DiskDrive array. Specify the device ID of the hard disk, which must be no more than 1,024 characters. |
InterfaceType |
string |
Optional |
This item is part of each object in the DiskDrive array. Specify the interface type of the hard disk, which must be no more than 1,024 characters. |
Model |
string |
Optional |
This item is part of each object in the DiskDrive array. Specify the model name of the hard disk, which must be no more than 1,024 characters. |
Size |
unsignedLong |
Optional |
This item is part of each object in the DiskDrive array. Specify hard disk capacity in bytes. |
KeyboardList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Keyboard |
Array |
Mandatory |
Array whose elements consist of one or more objects representing keyboard information. You have to specify 1 to 8 objects for this array. |
Description |
string |
Optional |
This item is part of each object in the Keyboard array. Specify the name of the keyboard, which must be no more than 1,024 characters. |
LogicalDiskList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
LogicalDisk |
Array |
Mandatory |
Array whose elements consist of one or more objects representing logical drive information. You have to specify 1 to 26 objects for this array. |
DeviceID |
string |
Optional |
This item is part of each object in the LogicalDisk array. Specify the drive letter, which must be no more than 1,024 characters. |
DriveType |
string |
Optional |
This item is part of each object in the LogicalDisk array. Specify one of the following options as the drive type:
|
FileSystem |
string |
Optional |
This item is part of each object in the LogicalDisk array. Specify the name of the file system, which must be no more than 1,024 characters. |
FreeSpace |
unsignedLong |
Optional |
This item is part of each object in the LogicalDisk array. Specify free drive space in bytes. |
Size |
unsignedLong |
Optional |
This item is part of each object in the LogicalDisk array. Specify drive capacity in bytes. |
DiskDriveToLogicalDiskList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
DiskDriveToLogicalDisk |
Array |
Mandatory |
Array whose elements consist of one or more objects representing information that associates hard disk information with logical drive information. You have to specify 1 to 255 objects for this array. |
DiskDriveDeviceID |
string |
Mandatory |
This item is part of each object in the DiskDriveToLogicalDisk array. Specify the device ID of the hard disk, which must be no more than 1,024 characters. |
LogicalDiskDeviceID |
string |
Mandatory |
This item is part of each object in the DiskDriveToLogicalDisk array. Specify the drive letter, which must be no more than 1,024 characters. |
- Important
-
When a device ID of a nonexistent hard disk or a nonexistent drive letter is specified, the association is judged as being invalid.
BitLocker object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
DriveList |
Object |
Mandatory |
Object that puts together BitLocker drive encryption information. |
Drive |
Array |
Mandatory |
Array whose elements consist of one or more objects representing drive information encrypted with BitLocker. You have to specify 1 to 255 objects for this array. |
DriveLetter |
string |
Mandatory |
This item is part of each object in the Drive array. Specify the drive letter of the drive encrypted with BitLocker, which must be no more than 1,024 characters. |
ProtectionStatus |
int |
Mandatory |
This item is part of each object in the Drive array. Specify one of the following as the protection provided by BitLocker:
|
LockStatus |
int |
Mandatory |
This item is part of each object in the Drive array. Specify one of the following as the lock status:
|
NetworkAdapterList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
NetworkAdapter |
Array |
Mandatory |
Array whose elements consist of one or more objects representing network adapter information. You have to specify 1 to 255 objects for this array. |
DeviceID |
string |
Mandatory |
This item is part of each object in the NetworkAdapter array. Specify the device ID of the network adapter, which must be no more than 1,024 characters. |
Name |
string |
Optional |
This item is part of each object in the NetworkAdapter array. Specify the name of the network adapter, which must be no more than 1,024 characters. |
NetworkAdapterConfigurationList object
Item name |
Data type |
Mandatory / Optional |
Description |
|
---|---|---|---|---|
NetworkAdapterConfiguration |
Array |
Mandatory |
Array whose elements consist of one or more objects representing network adapter configuration information. You have to specify 1 to 255 objects for this array. |
|
DefaultIPGatewayList |
Object |
Optional |
Object that puts together default gateway information. |
|
DefaultIPGateway |
Array |
Mandatory |
Array whose element consists of one object representing default gateway information. You have to specify 1 object for this array. |
|
_value |
string |
Mandatory |
This item is part of an object in the DefaultIPGateway array. Specify the default gateway, which must be no more than 39 characters. |
|
@Index |
int |
Mandatory |
This item is part of an object in the DefaultIPGateway array. Specify an index for the default gateway information. Specify a serial number starting with 1. |
|
DHCPEnabled |
string |
Optional |
Whether DHCP is enabled or disabled. Specify one of the following:
|
|
DHCPLeaseExpires |
dateTime |
Optional |
Specify the date and time when the DHCP lease expires. |
|
DHCPLeaseObtained |
dateTime |
Optional |
Specify the date and time when the DHCP lease was obtained. |
|
DHCPServer |
string |
Optional |
Specify the address of the DHCP server, which must be no more than 39 characters. |
|
DNSServerSearchOrderList |
Object |
Optional |
Object that puts together DNS server information. |
|
DNSServerSearchOrder |
Array |
Mandatory |
Array whose elements consist of one or more objects representing DNS server information. You have to specify 1 to 255 objects for this array. |
|
_value |
string |
Mandatory |
This item is part of each object in the DNSServerSearchOrder array. Specify the address of the DNS server, which must be no more than 39 characters. |
|
@Index |
int |
Mandatory |
This item is part of each object in the DNSServerSearchOrder array. Specify an index for the DNS server. Specify a serial number starting with 1. |
|
Index |
unsignedInt |
Mandatory |
Specify the setting ID of network adapter configuration information. |
|
IPAddressList |
Object |
Optional |
Object that puts together IP address information. |
|
IPAddress |
Array |
Mandatory |
Array whose elements consist of one or more objects representing IP address information. You have to specify 1 to 255 objects for this array. |
|
_value |
string |
Mandatory |
This item is part of each object in the IPAddress array. Specify the IP address in IPv4 format, where the first element of the IPAddress array inside the first obeject of the NetworkAdapterConfiguration arrray. |
|
@Index |
int |
Mandatory |
This item is part of each object in the IPAddress array. Specify an index for the IP address. Specify a serial number starting with 1. |
|
IPSubnetList |
Object |
Optional |
Object that puts together subnet mask information. |
|
IPSubnet |
Array |
Mandatory |
Array whose elements consist of one or more objects representing subnet mask information. You have to specify 1 to 255 objects for this array. |
|
_value |
string |
Mandatory |
This item is part of each object in the IPSubnet array. Specify the subnet mask, which must be no more than 39 characters. |
|
@Index |
int |
Mandatory |
This item is part of each object in the IPSubnet array. Specify an index for the subnet mask. Specify a serial number starting with 1. |
|
MACAddress |
string |
Optional |
Specify a 17-character long MAC address in the following format: xx:xx:xx:xx:xx:xx x: One of the characters in the range from 0 to 9 and a to f. |
|
WINSPrimaryServer |
string |
Optional |
Specify the address of the primary WINS server, which must be no more than 39 characters. |
|
WINSSecondaryServer |
string |
Optional |
Specify the address of the secondary WINS server, which must be no more than 39 characters. |
NetworkAdapterToNetworkAdapterConfigurationList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
NetworkAdapterToNetworkAdapterConfiguration |
Array |
Mandatory |
Array whose elements consist of one or more objects representing information that associates network adapter information with network adapter configuration information. You have to specify 1 to 255 objects for this array. |
NetworkAdapterDeviceID |
string |
Mandatory |
This item is part of each object in the NetworkAdapterToNetworkAdapterConfiguration array. Specify the device ID of the network adapter, which must be no more than 1,024 characters. |
NetworkAdapterConfigurationIndex |
unsignedInt |
Mandatory |
This item is part of each object in the NetworkAdapterToNetworkAdapterConfiguration array. Specify the setting ID of the network adapter configuration corresponding to the device ID of the network adapter specified in NetworkAdapterDeviceID. |
OperatingSystem object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
OSKind |
int |
Optional |
OS type. Specify one of the following:
|
Caption |
string |
Optional |
Specify the name of the OS. See the List of OS names, and specify one of the names in the "OS" column. |
KernelVersion |
string |
Optional |
Specify the Linux kernel version, which must be no more than 64 characters. |
CSDVersion |
string |
Optional |
See the "Service pack or OS version" column in the List of OS names, and specify as follows:
|
Description |
string |
Optional |
Specify the description of the computer, which must be no more than 1,024 characters. |
Locale |
int |
Optional |
Specify a locale code. Specify one of the following:
|
Organization |
string |
Optional |
Specify the company name, which must be no more than 1,024 characters. |
OSCode |
string |
Optional |
Specify an OS code. See the List of OS names, and specify one of the codes in the "OS code" column. |
OSLanguage |
int |
Optional |
Specify an OS language code. Specify one of the codes listed for Locale in the Description column. |
RegisteredUser |
string |
Optional |
Specify the owner name, which must be no more than 1,024 characters. |
SerialNumber |
string |
Optional |
Specify the serial number of the OS, which must be no more than 1,024 characters. |
TotalVirtualMemorySize |
unsignedLong |
Optional |
Specify the amount of virtual memory in bytes. |
List of OS names
OS |
CPU |
OS code |
Service pack or OS version |
---|---|---|---|
Microsoft Windows XP Home Edition |
32bit |
1.5.1.768.0.0.0 |
Service pack |
Microsoft Windows XP Professional |
32bit |
1.5.1.256.0.0.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003, Enterprise Edition |
32bit |
1.5.2.274.1.0.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003, Standard Edition |
32bit |
1.5.2.272.1.0.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003, Enterprise x64 Edition |
64bit |
1.5.2.274.1.0.9 |
Service pack |
Microsoft(R) Windows(R) Server 2003, Standard x64 Edition |
64bit |
1.5.2.272.1.0.9 |
Service pack |
Microsoft(R) Windows VistaTM Business |
32bit |
1.6.0.6.0.0.0 |
Service pack |
Microsoft(R) Windows VistaTM Enterprise |
32bit |
1.6.0.4.0.0.0 |
Service pack |
Microsoft(R) Windows VistaTM Ultimate |
32bit |
1.6.0.1.0.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Standard |
32bit |
1.6.0.7.1.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Enterprise |
32bit |
1.6.0.10.1.0.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003 R2, Standard Edition |
32bit |
1.5.2.272.1.1.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003 R2, Enterprise Edition |
32bit |
1.5.2.274.1.1.0 |
Service pack |
Microsoft(R) Windows(R) Server 2003 R2, Standard x64 Edition |
64bit |
1.5.2.272.1.1.9 |
Service pack |
Microsoft(R) Windows(R) Server 2003 R2, Enterprise x64 Edition |
64bit |
1.5.2.274.1.1.9 |
Service pack |
Microsoft(R) Windows VistaTM Home Basic |
32bit |
1.6.0.2.0.0.0 |
Service pack |
Microsoft(R) Windows VistaTM Home Premium |
32bit |
1.6.0.3.0.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Standard without Hyper-V |
32bit |
1.6.0.36.1.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Enterprise without Hyper-V |
32bit |
1.6.0.38.1.0.0 |
Service pack |
Microsoft Windows XP |
-- |
1.5.1.-.0.-.- |
Service pack |
Microsoft(R) Windows(R) Server 2003 |
-- |
1.5.2.-.1.-.- |
Service pack |
Microsoft(R) Windows VistaTM |
-- |
1.6.0.-.0.-.- |
Service pack |
Microsoft(R) Windows Server(R) 2008 |
-- |
1.6.0.-.1.-.- |
Service pack |
Microsoft Windows |
-- |
1.-.-.-.-.-.- |
Service pack |
Linux |
-- |
2.-.-.-.-.-.- |
Service pack |
UNIX |
-- |
3.-.-.-.-.-.- |
Service pack |
Mac OS |
-- |
4.-.-.-.-.-.- |
Service pack |
Microsoft Windows 7 Starter |
32bit |
1.6.1.11.0.0.0 |
Service pack |
Microsoft Windows 7 Home Premium |
32bit |
1.6.1.3.0.0.0 |
Service pack |
Microsoft Windows 7 Professional |
32bit |
1.6.1.48.0.0.0 |
Service pack |
Microsoft Windows 7 Enterprise |
32bit |
1.6.1.4.0.0.0 |
Service pack |
Microsoft Windows 7 Ultimate |
32bit |
1.6.1.1.0.0.0 |
Service pack |
Microsoft Windows 7 Edition / CPU unknown |
-- |
1.6.1.-.0.-.- |
Service pack |
Microsoft Windows Server 2008 R2 Standard |
64bit |
1.6.1.7.1.0.9 |
Service pack |
Microsoft Windows Server 2008 R2 Enterprise |
64bit |
1.6.1.10.1.0.9 |
Service pack |
Microsoft Windows Server 2008 R2 |
64bit |
1.6.1.-.1.-.- |
Service pack |
Microsoft(R) Windows VistaTM Home Basic |
64bit |
1.6.0.2.0.0.9 |
Service pack |
Microsoft(R) Windows VistaTM Home Premium |
64bit |
1.6.0.3.0.0.9 |
Service pack |
Microsoft(R) Windows VistaTM Business |
64bit |
1.6.0.6.0.0.9 |
Service pack |
Microsoft(R) Windows VistaTM Enterprise |
64bit |
1.6.0.4.0.0.9 |
Service pack |
Microsoft(R) Windows VistaTM Ultimate |
64bit |
1.6.0.1.0.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Standard |
64bit |
1.6.0.7.1.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Enterprise |
64bit |
1.6.0.10.1.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Standard without Hyper-V |
64bit |
1.6.0.36.1.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Enterprise without Hyper-V |
64bit |
1.6.0.38.1.0.9 |
Service pack |
Microsoft Windows 7 Starter |
64bit |
1.6.1.11.0.0.9 |
Service pack |
Microsoft Windows 7 Home Premium |
64bit |
1.6.1.3.0.0.9 |
Service pack |
Microsoft Windows 7 Professional |
64bit |
1.6.1.48.0.0.9 |
Service pack |
Microsoft Windows 7 Enterprise |
64bit |
1.6.1.4.0.0.9 |
Service pack |
Microsoft Windows 7 Ultimate |
64bit |
1.6.1.1.0.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Datacenter |
32bit |
1.6.0.8.1.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Datacenter |
64bit |
1.6.0.8.1.0.9 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Datacenter without Hyper-V |
32bit |
1.6.0.37.1.0.0 |
Service pack |
Microsoft(R) Windows Server(R) 2008 Datacenter without Hyper-V |
64bit |
1.6.0.37.1.0.9 |
Service pack |
Microsoft Windows Server 2008 R2 Datacenter |
64bit |
1.6.1.8.1.0.9 |
Service pack |
iOS |
-- |
5.1.0.0.0.0.0 |
Service pack |
Android |
-- |
5.2.0.0.0.0.0 |
Service pack |
Smart device |
-- |
5.-.-.-.-.-.- |
Service pack |
Microsoft Windows 8 |
32bit |
1.6.2.101.0.0.0 |
Service pack |
Microsoft Windows 8 |
64bit |
1.6.2.101.0.0.9 |
Service pack |
Microsoft Windows 8 Pro |
32bit |
1.6.2.48.0.0.0 |
Service pack |
Microsoft Windows 8 Pro |
64bit |
1.6.2.48.0.0.9 |
Service pack |
Microsoft Windows 8 Enterprise |
32bit |
1.6.2.4.0.0.0 |
Service pack |
Microsoft Windows 8 Enterprise |
64bit |
1.6.2.4.0.0.9 |
Service pack |
Microsoft Windows 8 Edition / CPU unknown |
-- |
1.6.2.-.0.-.- |
Service pack |
Microsoft Windows Server 2012 Standard |
64bit |
1.6.2.7.1.0.9 |
Service pack |
Microsoft Windows Server 2012 Datacenter |
64bit |
1.6.2.8.1.0.9 |
Service pack |
Microsoft Windows Server 2012 Edition unknown |
-- |
1.6.2.-.1.-.- |
Service pack |
Microsoft Windows 7 Home Basic |
32bit |
1.6.1.2.0.0.0 |
Service pack |
Microsoft Windows 7 Home Basic |
64bit |
1.6.1.2.0.0.9 |
Service pack |
Microsoft Windows 8.1 |
32bit |
1.6.3.101.0.0.0 |
Service pack |
Microsoft Windows 8.1 |
64bit |
1.6.3.101.0.0.9 |
Service pack |
Microsoft Windows 8.1 Pro |
32bit |
1.6.3.48.0.0.0 |
Service pack |
Microsoft Windows 8.1 Pro |
64bit |
1.6.3.48.0.0.9 |
Service pack |
Microsoft Windows 8.1 Enterprise |
32bit |
1.6.3.4.0.0.0 |
Service pack |
Microsoft Windows 8.1 Enterprise |
64bit |
1.6.3.4.0.0.9 |
Service pack |
Microsoft Windows 8.1 Edition / CPU unknown |
-- |
1.6.3.-.0.-.- |
Service pack |
Microsoft Windows Server 2012 R2 Standard |
64bit |
1.6.3.7.1.0.9 |
Service pack |
Microsoft Windows Server 2012 R2 Datacenter |
64bit |
1.6.3.8.1.0.9 |
Service pack |
Microsoft Windows Server 2012 R2 Edition unknown |
-- |
1.6.3.-.1.-.- |
Service pack |
Microsoft Windows 10 Home |
32bit |
1.10.0.101.0.0.0 |
Service pack |
Microsoft Windows 10 Home |
64bit |
1.10.0.101.0.0.9 |
Service pack |
Microsoft Windows 10 Pro |
32bit |
1.10.0.48.0.0.0 |
Service pack |
Microsoft Windows 10 Pro |
64bit |
1.10.0.48.0.0.9 |
Service pack |
Microsoft Windows 10 Enterprise |
32bit |
1.10.0.4.0.0.0 |
Service pack |
Microsoft Windows 10 Enterprise |
64bit |
1.10.0.4.0.0.9 |
Service pack |
Microsoft Windows 10 Edition / CPU unknown |
-- |
1.10.0.-.0.-.- |
Service pack |
HP-UX 11i V3 (IPF) |
-- |
6.11.3.-.-.-.- |
Service pack |
HP-UX Version unknown |
-- |
6.-.-.-.-.-.- |
Service pack |
Oracle Solaris 10 (SPARC) |
-- |
7.10.-.-.-.-.- |
Service pack |
Oracle Solaris 11 (SPARC) |
-- |
7.11.-.-.-.-.- |
Service pack |
Oracle Solaris (SPARC) |
-- |
7.-.-.-.-.-.- |
Service pack |
AIX V6.1 |
-- |
8.6.1.-.-.-.- |
Service pack |
AIX V7.1 |
-- |
8.7.1.-.-.-.- |
Service pack |
AIX Version unknown |
-- |
8.-.-.-.-.-.- |
Service pack |
Red Hat Enterprise Linux Server 6 |
-- |
2.6.-.1.-.-.- |
Service pack |
Red Hat Enterprise Linux Server 7 |
-- |
2.7.-.1.-.-.- |
Service pack |
Red Hat Enterprise Linux |
-- |
2.-.-.1.-.-.- |
Service pack |
CentOS 6.1 |
-- |
2.6.-.2.-.-.- |
Service pack |
CentOS 7.1 |
-- |
2.7.-.2.-.-.- |
Service pack |
CentOS Version unknown |
-- |
2.-.-.2.-.-.- |
Service pack |
Microsoft Windows 10 Enterprise LTSB |
32bit |
1.10.0.125.0.0.0 |
Service pack |
AIX V7.2 |
-- |
8.7.2.-.-.-.- |
Service pack |
AIX V7.3 |
-- |
8.7.3.-.-.-.- |
Service pack |
Microsoft Windows 10 Enterprise LTSB |
64bit |
1.10.0.125.0.0.9 |
Service pack |
Microsoft Windows Server 2016 Standard |
64bit |
1.10.0.7.1.0.9 |
Service pack |
Microsoft Windows Server 2016 Datacenter |
64bit |
1.10.0.8.1.0.9 |
Service pack |
Microsoft Windows Server 2016 |
-- |
1.10.0.-.1.-.- |
Service pack |
OS X 10.10 Yosemite |
-- |
4.10.10.-.-.-.- |
Service pack |
OS X 10.11 El Capitan |
-- |
4.10.11.-.-.-.- |
Service pack |
macOS 10.12 Sierra |
-- |
4.10.12.-.-.-.- |
Service pack |
Red Hat Enterprise Linux Server 5 |
-- |
2.5.-.1.-.-.- |
Service pack |
macOS High Sierra 10.13 |
-- |
4.10.13.-.-.-.- |
Service pack |
macOS Mojave 10.14 |
-- |
4.10.14.-.-.-.- |
Service pack |
macOS Catalina 10.15 |
-- |
4.10.15.-.-.-.- |
Service pack |
macOS Big Sur 11 |
-- |
4.11.-.-.-.-.- |
Service pack |
macOS Monterey 12 |
-- |
4.12.-.-.-.-.- |
Service pack |
macOS Ventura 13 |
-- |
4.13.-.-.-.-.- |
Service pack |
Microsoft Windows 10 Pro for Workstations |
32bit |
1.10.0.161.0.0.0 |
OS version |
Microsoft Windows 10 Pro for Workstations |
64bit |
1.10.0.161.0.0.9 |
OS version |
Microsoft Windows Server 2019 Standard |
64bit |
1.10.17763.7.1.0.9 |
OS version |
Microsoft Windows Server 2019 Datacenter |
64bit |
1.10.17763.8.1.0.9 |
OS version |
Microsoft Windows Server 2019 |
-- |
1.10.17763.-.1.-.- |
OS version |
Microsoft Windows 10 Enterprise LTSC |
32bit |
1.10.0.125.0.0.0 |
OS version |
Microsoft Windows 10 Pro N |
32bit |
1.10.0.49.0.0.0 |
OS version |
Microsoft Windows 10 Pro N |
64bit |
1.10.0.49.0.0.9 |
OS version |
Microsoft Windows 10 Enterprise N |
32bit |
1.10.0.27.0.0.0 |
OS version |
Microsoft Windows 10 Enterprise N |
64bit |
1.10.0.27.0.0.9 |
OS version |
Microsoft Windows 10 Enterprise multi-session |
64bit |
1.10.0.175.1.0.9 |
OS version |
Microsoft Windows Server 2022 Standard |
64bit |
1.10.20348.7.1.0.9 |
OS version |
Microsoft Windows Server 2022 Datacenter |
64bit |
1.10.20348.8.1.0.9 |
OS version |
Microsoft Windows Server 2022 |
- |
1.10.20348.-.1.-.- |
OS version |
Microsoft Windows 11 Pro |
64bit |
1.11.0.48.0.0.9 |
OS version |
Microsoft Windows 11 Pro for Workstations |
64bit |
1.11.0.161.0.0.9 |
OS version |
Microsoft Windows 11 Enterprise |
64bit |
1.11.0.4.0.0.9 |
OS version |
Microsoft Windows 11 Enterprise multi-session |
64bit |
1.11.0.175.1.0.9 |
OS version |
Microsoft Windows 11 |
- |
1.11.0.-.-.-.- |
OS version |
Legend: --: Not applicable
PhysicalMemoryList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
PhysicalMemory |
Array |
Mandatory |
Array whose elements consist of one or more objects representing physical memory information. You have to specify 1 to 255 objects for this array. |
Capacity |
unsignedLong |
Optional |
This item is part of each object in the PhysicalMemory array. Specify the amount of physical memory inserted into the memory slot in bytes. |
PointingDeviceList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
PointingDevice |
Array |
Mandatory |
Array whose elements consist of one or more objects representing mouse information. You have to specify 1 to 255 objects for this array. |
Name |
string |
Optional |
This item is part of each object in the PointingDevice array. Specify the name of the mouse, which must be no more than 1,024 characters. |
PrinterList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Printer |
Array |
Mandatory |
Array whose elements consist of one or more objects representing printer information. You have to specify 1 to 255 objects for this array. |
Attributes |
unsignedInt |
Optional |
This item is part of each object in the Printer array. Specify the attributes of the printer by using a combination of the following values:
|
DriverName |
string |
Optional |
This item is part of each object in the Printer array. Specify the driver name of the printer, which must be no more than 1,024 characters. |
Name |
string |
Optional |
This item is part of each object in the Printer array. Specify the printer name, which must be no more than 1,024 characters. |
PortName |
string |
Optional |
This item is part of each object in the Printer array. Specify the printer port, which must be no more than 1,024 characters. |
ServerName |
string |
Optional |
This item is part of each object in the Printer array. Specify the server name of the printer, which must be no more than 1,024 characters. |
ShareName |
string |
Optional |
This item is part of each object in the Printer array. Specify the share name of the printer, which must be no more than 1,024 characters. |
ProcessorList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Processeor |
Array |
Mandatory |
Array whose elements consist of one or more objects representing processor information. You have to specify 1 to 255 objects for this array. |
Name |
string |
Optional |
This item is part of each object in the Processor array. Specify the processor name, which must be no more than 1,024 characters. |
SoundDeviceList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
SoundDevice |
Array |
Mandatory |
Array whose elements consist of one or more objects representing sound card information. You have to specify 1 to 255 objects for this array. |
Manufacturer |
string |
Optional |
This item is part of each object in the SoundDevice array. Specify the manufacturer of the sound card, which must be no more than 1,024 characters. |
Name |
string |
Optional |
This item is part of each object in the SoundDevice array. Specify the product name of the sound card, which must be no more than 1,024 characters. |
UserAccount object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Description |
string |
Optional |
Specify user description, which must be no more than 1,024 characters. |
FullName |
string |
Optional |
Specify the full name of the user, which must be no more than 1,024 characters. |
VideoControllerList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
VideoController |
Array |
Mandatory |
Array whose elements consist of one or more objects representing video controller information. You have to specify 1 to 255 objects for this array. |
AdapterRAM |
unsignedInt |
Optional |
This item is part of each object in the VideoController array. Specify the amount of video controller's VRAM in bytes. |
Name |
string |
Optional |
This item is part of each object in the VideoController array. Specify the video driver, which must be no more than 1,024 characters. |
VideoProcessor |
string |
Optional |
This item is part of each object in the VideoController array. Specify the video chip, which must be no more than 1,024 characters. |
PowerManagement object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
VideoTimeoutAC |
int |
Optional |
Specify Turn off monitor (AC) in seconds. |
VideoTimeoutDC |
int |
Optional |
Specify Turn off monitor (DC) in seconds. |
SpindownTimeoutAC |
int |
Optional |
Specify Turn off hard disks (AC) in seconds. |
SpindownTimeoutDC |
int |
Optional |
Specify Turn off hard disks (DC) in seconds. |
StandbyTimeoutAC |
int |
Optional |
Specify System standby (AC) in seconds. |
StandbyTimeoutDC |
int |
Optional |
Specify System standby (DC) in seconds. |
HibernateTimeoutAC |
int |
Optional |
Specify System hibernates (AC) in seconds. |
HibernateTimeoutDC |
int |
Optional |
Specify System hibernates (DC) in seconds. |
ThrottlePolicyAC |
int |
Optional |
Specify Processor Throttle (AC) in seconds. |
ThrottlePolicyDC |
int |
Optional |
Specify Processor Throttle (DC) in seconds. |
property array
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@category |
string |
Optional |
This item is part of each object in the property array. Specify one of the following strings as the category name. For details, see Combinations of generic inventories.
|
@key |
string |
Optional |
This item is part of each object in the property array. Specify one of the following as the key. For details, see Combinations of generic inventories.
|
@value |
string |
Optional |
This item is part of each object in the property array. Specify a value corresponding to the key. For details, see Combinations of generic inventories. |
@record |
string |
Optional |
This item is part of each object in the property array. Specify a number that distinguishes the category. For details, see Combinations of generic inventories. |
Combinations of generic inventories
@category |
@key |
Description of category / key |
Data type of @value |
Description of @value |
---|---|---|---|---|
prtMarker |
prtMarkerMarkTech |
Printing method - Method |
int |
Specify one of the followings:
|
prtMarkerProcessColorants |
Printing method - Number of colors |
int |
Specify a value in the range from 0 to 65535. |
|
prtMarkerSupplies |
prtMarkerSuppliesType |
Supplies - Type |
int |
Specify one of the following as the type of the consumable, package, or the like:
|
prtMarkerSuppliesDescription |
Supplies - Description |
string |
Specify the description of the container or package of the consumable. |
|
prtMarkerSuppliesLevel |
Supplies - State |
int |
Specify the current level when the consumable is a container, or the remaining space when the consumable is a package. Specify a value (%) in the range from 1 to 100.
|
|
prtInput |
prtInputType |
Paper feed tray - Type |
int |
Specify one of the following values as the type of technology (which is mainly identified by the type of paper feed mechanism) adopted by a specific component:
|
prtInputName |
Paper feed tray - Name |
string |
Specify the name of the paper feed tray. |
|
prtInputCurrentLevel |
Paper feed tray - Capacity |
int |
The current capacity of the Input subunit, shown in capacity units of the Input subunit. Specify the remaining capacity (%) as the value to be displayed.
|
SmartDeviceInformation object
Item name |
Data type |
Mandatory / Optional |
Description |
|
---|---|---|---|---|
UUID |
string |
Optional |
Specify the device identifier, which must be no more than 256 characters. |
|
IMEI |
string |
Optional |
Specify the International Mobile Equipment Identifier (IMEI), which must be no more than 64 characters. |
|
UDID |
string |
Optional |
Specify the identifier of the iOS terminal, which must be no more than 128 characters. |
|
ICCID |
string |
Optional |
Specify the ICCID, which must be no more than 64 characters. |
|
IMSI |
string |
Optional |
Specify the International Mobile Subscriber Identity assigned to the SIM card inserted into the device, which must be no more than 64 characters. |
|
PhoneNumber |
string |
Optional |
Specify the mobile number, which must be no more than 256 characters. |
|
|
string |
Optional |
Specify the email address, which must be no more than 256 characters. |
|
Carrier |
string |
Optional |
Specify the carrier, which must be no more than 512 characters. |
|
PasscodeSetting |
string |
Optional |
Specify one of the following values as the passcode setting status:
|
|
PhisicalMemory |
Object |
Optional |
Object name of RAM information. |
|
Size |
unsignedLong |
Optional |
Specify the amount of RAM in bytes. |
|
FreeSpace |
unsignedLong |
Optional |
Specify the free RAM space in bytes. |
|
Storage |
Object |
Optional |
Object name of internal storage information. |
|
Size |
unsignedLong |
Optional |
Specify the amount of internal storage in bytes. |
|
FreeSpace |
unsignedLong |
Optional |
Specify the free internal storage space in bytes. |
|
Media |
Object |
Optional |
Object name of external media information. |
|
Size |
unsignedLong |
Optional |
Specify the size of external media in bytes. |
|
FreeSpace |
unsignedLong |
Optional |
Specify the free space on the external media in bytes. |
InstalledSoftware object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@ReportType |
string |
Mandatory |
Always specify ALL. |
@LastUpdateTime |
dateTime |
Mandatory |
Specify the date and time when the InstalledSoftware object was generated. |
SoftwareList |
Object |
Optional |
Object that puts together software information. For details, see SoftwareList object of the InstalledSoftware object. |
SoftwareList object of the InstalledSoftware object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Software |
Array |
Mandatory |
Array whose elements consist of one or more objects representing software information. Specify 1 to 500 objects for this array. |
@Type |
string |
Optional |
This item is part of each object in the Software array. Specify one of the following values as the software type:
If you omit this item, it is assumed that InstalledSoftware is specified. |
SourceID |
string |
Mandatory |
This item is part of each object in the Software array. Specify the ID that uniquely identifies the software, which must be no more than 512 characters. Specify the software name. |
InstallPath |
string |
Optional |
This item is part of each object in the Software array. Specify the path to the location to which to install the software, which must be no more than 512 characters. |
Name |
string |
Mandatory |
This item is part of each object in the Software array. Specify the software name, which must be no more than 512 characters. |
Version |
string |
Optional |
This item is part of each object in the Software array. Specify the software version, which must be no more than 128 characters. |
Publisher |
string |
Optional |
This item is part of each object in the Software array. Specify the publisher of the software, which must be no more than 128 characters. |
InstallDate |
dateTime |
Optional |
This item is part of each object in the Software array. Specify the date when the software was installed. |
HelpLink |
string |
Optional |
This item is part of each object in the Software array. Specify the URL of the support page for the software, which must be no more than 512 characters. |
AppType |
int |
Optional |
This item is part of each object in the Software array. Specify one of the following values as the application type of the software:
If you omit this item, it is assumed that 0 is set. |
Update object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@ReportType |
string |
Mandatory |
Always specify ALL. |
@LastUpdateTime |
dateTime |
Mandatory |
Specify the date and time when the Update object was generated. |
SoftwareList |
Object |
Mandatory |
Object that puts together update information. For details, see SoftwareList object of the Update object. |
SoftwareList object of the Update object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Software |
Array |
Mandatory |
Array whose elements consist of one or more objects representing update information. Specify 1 to 500 objects for this array. |
HotFixID |
string |
Mandatory |
This item is part of each object in the Software array. Specify the knowledge base number (KB number) of the update. Specify the KB number in one of the following formats:
|
Description |
string |
Optional |
This item is part of each object in the Software array. Specify the description of the update, which must be no more than 512 characters. |
InstallDate |
dateTime |
Optional |
This item is part of each object in the Software array. Specify the date when the update was installed. |
Type |
string |
Optional |
This item is part of each object in the Software array. Specify one of the following values as the type of update:
When this item is omitted, it is assumed that Update is set. |
SecurityInventory object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@LastUpdateTime |
dateTime |
Mandatory |
Specify the date and time when the SecurityInventory object was generated. |
AccountList |
Object |
Optional |
Object that puts together account information. For details, see AccountList object. |
PowerOnPassword |
string |
Mandatory |
Power-on password status. Specify one of the following:
|
GuestAccount |
string |
Mandatory |
Guest account status. Specify one of the following:
|
AutoLogon |
string |
Mandatory |
Whether automatic logon is enabled. Specify one of the following:
|
SharedDirectory |
string |
Mandatory |
Availability of shared folders. Specify one of the following:
|
AutoShareServer |
string |
Mandatory |
State of an administrative share. Specify one of the following:
|
DCOM |
string |
Mandatory |
DCOM status. Specify one of the following:
|
RestrictAnonymous |
string |
Mandatory |
Whether the collection of information through anonymous connections is restricted. Specify one of the following:
|
WindowsFirewall |
string |
Mandatory |
Whether Windows Firewall is enabled. Specify one of the following:
|
WindowsUpdate |
string |
Mandatory |
Whether Windows automatic update is enabled. Specify one of the following:
|
DenyTSConnections |
string |
Mandatory |
State of Remote Desktop. Specify one of the following:
|
AccountList object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
Account |
Array |
Mandatory |
Array whose elements consist of one or more objects representing account information. Specify 1 to 500 objects for this array. |
Name |
string |
Mandatory |
This item is part of each object in the Account array. Specify the account name, which must be no more than 1,024 characters. |
LastPasswordModifiedDate |
dateTime |
Optional |
This item is part of each object in the Account array. Specify the last date and time when the password was modified. |
WeakPassword |
string |
Optional |
This item is part of each object in the Account array. Specify one of the following values as the password vulnerability check result:
|
UnexpirePassword |
string |
Optional |
This item is part of each object in the Account array. Specify one of the following values to enable or disable Unexpire Password:
|
ScreenSaverEnabled |
string |
Optional |
This item is part of each object in the Account array. Specify one of the following values to enable or disable the screen saver:
|
ScreenSaverIsSecure |
string |
Optional |
This item is part of each object in the Account array. Specify one of the following values to enable or disable the screen saver password:
|
ScreenSaverTimeout |
int |
Optional |
This item is part of each object in the Account array. Specify the wait time to launch the screen saver in seconds. If the screen saver is disabled, specify 0. |
ExtendInventory object
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
@LastUpdateTime |
dateTime |
Mandatory |
Specify the date and time when the ExtendInventory object was generated. |
ExtendInventoryList |
Object |
Optional |
Object that puts together common management fields of asset information and device information, and additional management fields of hardware asset information. For details, see ExtendInventoryList object. |
ExtendInventoryList object
Item name |
Data type |
Mandatory / Optional |
Description |
|
---|---|---|---|---|
ExtendInventoryItem |
Array |
Mandatory |
Array whose elements consist of one or more objects representing common management fields of asset information and device information, and additional management fields of hardware asset information. Specify 1 to 221 objects for this array. |
|
@InformationType |
string |
Mandatory |
This item is part of each object in the ExtendInventoryItem array. Specify the information type. Specify one of the following values that is appropriate to the items of the common management fields and the additional management fields:
If there are no items which checked Entering item is mandatory in the setting asset field or a value of the asset field item which checked Entering item is mandatory is empty, it becomes an error. |
|
ItemName |
string |
Optional |
This item is part of each object in the ExtendInventoryItem array. Specify this item only when other is specified as @InformationType. Specify the name of the asset field within 256 characters. When the multiple-language definition is set for the item of the additional management field, specify the item name in the default language. If you omit this item when other is specified as @InformationType, or if you specify a value that is not included in the definition, the value is judged as being in violation of restrictions. |
|
Value |
string |
Optional |
This item is part of each object in the ExtendInventoryItem array. Specify this item when Type is Text, Number, or Date in the setting asset field. When specify an empty value, use "". When common management fields are either text type or number type, specify the default display values for text-type input items. When common management fields are date type, just specify the date in local time. If the specified value is in violation of the restrictions on entered characters defined in the Asset Field Definitions view, the value is judged as being in violation of restrictions. The Information type is Department or Location, specify "/" as a hierarchy. The maximum of the hierarchy is 40. Do not specify "/" consecutively such as "//". |
|
ValueList |
Object |
Optional |
This item is part of each object in the ExtendInventoryItem array. Specify this item when Type is Enumeration in the setting asset field. This object puts together the items whose entry is selected from a list. |
|
Value |
string |
Mandatory |
Specify the values of the item whose entry is selected item. When the multiple-language definition is set, specify the values in the default language. When you specify the value which is not defined at select values, works as follows:
When specify an empty value, use "". The Information type is Department or Location, specify "/" as a hierarchy. The maximum of the hierarchy is 40. Do not specify "/" consecutively such as "//". |
|
ValueTree |
Object |
Optional |
This item is part of each object in the ExtendInventoryItem array. Specify this item when Type is Hierarchy in the setting asset field. This object puts together the items whose entry is selected from a tree. |
|
Value |
Object |
Mandatory |
Object representing the item whose entry is selected from a tree. Specify the item value in the Data member of the object. |
|
Data |
string |
Mandatory |
This item is part of the Value object. Specify the value of the item whose entry is selected from a tree, which must be no more than 256 characters. If you specify a value that is not present in the item hierarchy definition (department, installation location), that value is registered anyway. The maximum of the hierarchy is 40. Do not use "/" character. When specify an empty value, the value of the first level is "". |
|
Value |
Object |
Optional |
This item is part of the Value object. To specify a child item in the tree, nest one Value object inside another Value object. For example, if there are three levels (X/Y/Z), specify as follows: "ValueTree" : { "Value": { "Data": "X", "Value": { "Data": "Y", "Value": { "Data": "Z" } } } } You can specify until 510 characters including the hierarchy separate character "/". |
Response format
- Status line
-
Either a status code or its text is returned. For details, see the description of status codes in 20.2 Common API specifications.
- Response header
-
For details, see the description of the response format in 20.2 Common API specifications.
- Response message body
-
The response does not have a message body when the request has been successful. When an error occurs, error information is stored in JSON format. For details, see the description of the error information in 20.2 Common API specifications.
Example usage
{ "Device-Inventory":[ { "Report": { "@CreationDate":"2017-04-13T15:45:15.000Z", "@Version":"0250", "ID":"1234567890", "Agent": { "Type":"REST", "DeviceStatus":"0", "Status":"0", "DistributionStatus":"0", "DiscoveryProtocol":"7" }, "Inventory": { "Equipment": { "Type":"EquipmentTypeComputer" }, "SystemInventory": { "@LastUpdateTime":"2018-04-04T11:35:08.000Z", "BaseBoard": { "SerialNumber":"JPXXXXXXXX" }, "BIOS": { "Manufacturer":"XXXXXXXX", "Name":"Default System BIOS", "ReleaseDate":"2009-10-22T00:00:00.000Z", "SerialNumber":"JPXXXXXXXX", "SMBIOSBIOSVersion":"786G7 v01.02", "Version":"HPQOEM - 20091022" }, "CDROMDriveList": { "CDROMDrive": [ { "Name":"XXXXXXXX DVDRAM XXXXXXXX ATA Device" } ] }, "ComputerSystem": { "CurrentTimeZone":"540", "Domain":"WORKGROUP", "DomainRole":"DomainRoleStandaloneWorkstation", "Manufacturer":"XXXXXXXX", "Model":"XXXXXXXX XXXXXXXX PC", "Name":"JSS53445", "NumberOfProcessors":"2", "TotalPhysicalMemory":"4294967296", "UserName":"JSS53445\\hitachi" }, "ComputerSystemProduct": { "IdentifyingNumber":"XXXXXXXX", "UUID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }, "DesktopMonitorList": { "DesktopMonitor": [ { "Name":"Monitor" } ] }, "DiskDriveList": { "DiskDrive": [ { "DeviceID":"\\\\.\\PHYSICALDRIVE0", "InterfaceType":"IDE", "Model":"XXXXXXXX XXXXXXXX ATA Device", "Size":"500105249280" } ] }, "KeyboardList": { "Keyboard": [ { "Description":"HID Keyboard Device" } ] }, "LogicalDiskList": { "LogicalDisk": [ { "DeviceID":"C:", "DriveType":"DriveTypeLocalDisk", "FileSystem":"NTFS", "FreeSpace":"15716945920", "Size":"42952409088" } ] }, "DiskDriveToLogicalDiskList": { "DiskDriveToLogicalDisk": [ { "DiskDriveDeviceID":"\\\\.\\PHYSICALDRIVE0", "LogicalDiskDeviceID":"C:" } ] }, "BitLocker": { "DriveList": { "Drive": [ { "DriveLetter":"C:", "ProtectionStatus":"0", "LockStatus":"0" } ] } }, "NetworkAdapterList": { "NetworkAdapter": [ { "DeviceID":"7", "Name":"XXXXXXXX Gigabit Network Connection" } ] }, "NetworkAdapterConfigurationList": { "NetworkAdapterConfiguration": [ { "DefaultIPGatewayList": { "DefaultIPGateway": [ { "_value":"10.208.152.1", "@Index":"1" } ] }, "DHCPEnabled":"0", "DNSServerSearchOrderList": { "DNSServerSearchOrder": [ { "_value":"172.16.0.152", "@Index":"1" }, { "_value":"172.16.228.126", "@Index":"2" } ] }, "Index":"7", "IPAddressList": { "IPAddress": [ { "_value":"10.208.152.21", "@Index":"1" } ] }, "IPSubnetList": { "IPSubnet": [ { "_value":"255.255.255.0", "@Index":"1" } ] }, "MACAddress":"XX:XX:XX:XX:XX:XX" } ] }, "NetworkAdapterToNetworkAdapterConfigurationList": { "NetworkAdapterToNetworkAdapterConfiguration": [ { "NetworkAdapterDeviceID":"7", "NetworkAdapterConfigurationIndex":"7" } ] }, "HostName":"JSS53445", "OperatingSystem": { "OSKind":"1", "Caption":"Microsoft Windows 7 Professional", "KernelVersion":"Kernel Version", "CSDVersion":"Service Pack 3", "Description":"Description of this computer", "Locale":"1041", "Organization":"Hitachi, Ltd.", "OSCode":"1.6.1.48.0.0.9", "OSLanguage":"1041", "RegisteredUser":"Bob Brown", "SerialNumber":"XXXXX-XXX-XXXXXXX-XXXXX", "TotalVirtualMemorySize":"8368304128" }, "PhysicalMemoryList": { "PhysicalMemory": [ { "Capacity":"2147483648" } ] }, "PointingDeviceList": { "PointingDevice": [ { "Name":"Name of mouse #1" } ] }, "PrinterList": { "Printer": [ { "Attributes":"580", "DriverName":"XXXXXXXX XXXXXXXX XXXXXXXX", "Name":"XXXXXXXX XXXXXXXX XXXXXXXX", "PortName":"XXXPort:", "ServerName":"Printer Server Name", "ShareName":"Shared Printer Name" } ] }, "ProcessorList": { "Processor": [ { "Name":"XXXXXXXX XXXXXXXX XXXXXXXX CPU @ 3.40GHz" }, { "Name":"XXXXXXXX XXXXXXXX XXXXXXXX CPU @ 3.40GHz" } ] }, "SoundDeviceList": { "SoundDevice": [ { "Manufacturer":"XXXXXXXX", "Name":"High Definition Audio device" } ] }, "UserAccount": { "Description":"Sample Description", "FullName":"Bob Brown" }, "VideoControllerList": { "VideoController": [ { "AdapterRAM":"1857681408", "Name":"XXXXXXXX XXXXXXXX XXXXXXXX (XXXXXXXX 1.1)", "VideoProcessor":"XXXXXXXX XXXXXXXX XXXXXXXX" } ] }, "AMTFirmwareVersion":"1.0", "WindowsInstaller":"5.0.7600.16385", "WindowsUpdateAgent":"7.3.7600.16385", "OSLastStartupTime":"2009-10-22T00:00:00.000Z", "WindowsDirectory":"C:\\windows", "IEVersion":"8.0.7600.16385", "IEServicePack":"0", "PowerManagement": { "VideoTimeoutAC":"600", "VideoTimeoutDC":"300", "SpindownTimeoutAC":"1200", "SpindownTimeoutDC":"600", "StandbyTimeoutAC":"0", "StandbyTimeoutDC":"900", "HibernateTimeoutAC":"0", "HibernateTimeoutDC":"0", "ThrottlePolicyAC":"ThrottlePolicyAdaptive", "ThrottlePolicyDC":"ThrottlePolicyAdaptive" }, "property": [ { "@category":"Category Name", "@key":"Key Name", "@value":"1", "@type":"int", "@record":"1" } ], "SmartDeviceInformation": { "UUID":"1", "IMEI":"1", "UDID":"1", "ICCID":"1", "IMSI":"1", "PhoneNumber":"1", "mail":"foo@example.com", "Carrier":"XXXXXXXX", "PasscodeSetting":"true", "PhisicalMemory": { "Size":"100", "FreeSpace":"100" }, "Storage": { "Size":"100", "FreeSpace":"100" }, "Media": { "Size":"100", "FreeSpace":"100" } } }, "InstalledSoftware": { "@LastUpdateTime":"2018-04-12T15:35:53.000Z", "@ReportType":"All", "SoftwareList": { "Software": [ { "@Type":"InstalledSoftware", "SourceID":"XXXXXXXX 2013", "InstallPath":"C:\\Program Files\\XXXXXXXX\\", "Name":"XXXXXXXX 2013", "Version":"15.0.4569.1506", "Publisher":"XXXXXXXX", "InstallDate":"2016-10-03T00:00:00.000Z" } ] } }, "Update": { "@ReportType":"All", "@LastUpdateTime":"2018-04-12T15:35:53.000Z", "SoftwareList": { "Software": [ { "HotFixID":"KB00000", "Description":"Description", "InstallDate":"2016-10-03T00:00:00.000Z" } ] } }, "SecurityInventory": { "@LastUpdateTime":"2018-04-13T12:00:00.000Z", "AccountList": { "Account": [ { "Name":"TEST\\1", "LastPasswordModifiedDate":"2017-08-10T06:00:00.000Z", "WeakPassword":"WeakPasswordFalse", "UnexpirePassword":"UnexpirePasswordFalse", "ScreenSaverEnabled":"ScreenSaverEnabledFalse", "ScreenSaverIsSecure":"ScreenSaverIsSecureFalse", "ScreenSaverTimeout":"0" } ] }, "PowerOnPassword":"PowerOnPasswordDisabled", "GuestAccount":"GuestAccountDisabled", "AutoLogon":"AutoLogonDisabled", "SharedDirectory":"SharedDirectoryFound", "AutoShareServer":"AutoShareServerTrue", "DCOM":"DCOMEnabled", "RestrictAnonymous":"RestrictAnonymousDisabled", "WindowsFirewall":"WindowsFirewallDisabled", "WindowsUpdate":"WindowsUpdateEnabled", "DenyTSConnections":"DenyTSConnectionsTrue" }, "ExtendInventory": { "@LastUpdateTime":"2019-10-11T12:12:12.000Z", "ExtendInventoryList": { "ExtendInventoryItem": [ { "@InformationType":"Organization", "ValueTree" : { "Value" : { "Data" : "X", "Value" : { "Data" : "Y", "Value" : { "Data" : "Z" } } } } }, { "@InformationType":"other", "ItemName":"Gender", "ValueList": { "Value":"xx" } }, { "@InformationType":"other", "ItemName":"Name", "Value":"Pedro Garcia" }, { "@InformationType":"other", "ItemName":"Age", "Value":"20" }, { "@InformationType":"other", "ItemName":"Birthday", "Value":"2000-11-11T00:00:00.000Z" } ] } } } } } ] }