Translate the Inventory Status
post
/inventory/translate/
Converts the discovery results by adding poll times.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
The discovery result containing the discovery context id.
Show Source
-
DiscoveryContextID: string
The ID obtained from discovery request.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
-
Model: string
The discovery model name.Example:
discovery
-
ModelData: object
ModelData
The discovery result data.
-
Type: string
The discovery type.Example:
ping
-
Version: string
The discovery version.Example:
0.0.1
Nested Schema : ModelData
Type:
object
The discovery result data.
Show Source
-
Devices: object
Devices
Additional Properties Allowed: additionalPropertiesThe list of the devices discovered.
-
VMWare: array
VMWare
The VMware data discovered for the discovery.
Nested Schema : Devices
Type:
object
Additional Properties Allowed
Show Source
The list of the devices discovered.
Example:
{
"203.0.113.0":{
"ICMPData":{
"Available":true,
"Hostname":"example1.oracle.com",
"LastRTTNano":221198,
"Timestamp":1702216942,
"IPAddress":"203.0.113.0",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"203.0.113.1":{
"ICMPData":{
"Available":true,
"Hostname":"example2.oracle.com",
"LastRTTNano":645484,
"Timestamp":1702216942,
"IPAddress":"203.0.113.1",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"192.0.2.0":{
"ICMPData":{
"Available":true,
"Hostname":"example3.oracle.com",
"LastRTTNano":688044,
"Timestamp":1702216942,
"IPAddress":"192.0.2.0",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.0",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example3.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.4"
}
}
},
"192.0.2.1":{
"ICMPData":{
"Available":true,
"Hostname":"example4.oracle.com",
"LastRTTNano":1491998,
"Timestamp":1702216942,
"IPAddress":"192.0.2.1",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.1",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example4.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.3"
}
}
}
}
Nested Schema : additionalProperties
Type:
Show Source
object
-
ICMPData: object
ICMPData
The ICMP data discovered for the discovery.
-
SNMPData: object
SNMPData
The SNMP data discovered for the discovery.
Nested Schema : ICMPData
Type:
object
The ICMP data discovered for the discovery.
Show Source
-
Available: boolean
Allowed Values:
[ true, false ]
The availability state of the device. -
Hostname: string
The hostname of the device.
-
IPAddress: string
The IP address of the device.
-
LastRTTNano: integer
The round trip time in nano seconds.
-
Timestamp: integer
The unix time in seconds at which icmp data is discovered.Example:
2147483647
-
WorkerError: boolean
Allowed Values:
[ true, false ]
The status of the ping poller worker error. -
WorkerErrorMessage: string
The worker error message obtained from the ping poller when discovery is done.Example:
ICMP configuration failed
-
ZoneID: integer
The zone id of the device.
Nested Schema : SNMPData
Type:
object
The SNMP data discovered for the discovery.
Show Source
-
AuthEngineID: string
The SNMP profile authentication engine ID.
-
Availability: array
Availability
The availability data of the SNMP device.
-
DeviceSystemInfo: object
DeviceSystemInfo
The information about SNMP device system.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
Performance: array
Performance
The performance data of the SNMP device.
-
ProfileID: integer
The SNMP profile IP of the device.
-
ProfileUUID: string
The SNMP profile UUID of the device.
-
Target: string
The hostname or IP address of the device.
-
WorkerError: boolean
Allowed Values:
[ true, false ]
The status of the snmp poller worker error. -
WorkerErrorMessage: string
The worker error message obtained from the snmp poller when discovery is done.
Nested Schema : DeviceSystemInfo
Type:
object
The information about SNMP device system.
Show Source
-
SerialNumber: string
The serial number of the SNMP device.
-
SysContact: string
The primary contact of the SNMP device.
-
SysDescription: string
The description of the SNMP device.
-
SysLocation: string
The physical location of the SNMP device being monitored.
-
SysName: string
The administrative assigned name for the SNMP device.
-
SysOid: string
The object identifier of the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
InstanceOid: string
The instance object identifier of the SNMP device.
-
Instances: array
Instances
The instance details of the SNMP device.
-
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device data belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : Instances
Type:
array
The instance details of the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
APIAccessID: string
The base64-encoded API access ID for the REST API URL.Example:
dGVzdA==
-
APIAccessKey: string
The base64-encoded API access key for the REST API URL.Example:
dGVzdA==
-
APIError: boolean
Allowed Values:
[ true, false ]
The API error status for the VMware discovery.Example:false
-
APIVersion: string
The VMware version.Example:
7.0.1 7.0.2.0
-
DatacenterName: string
The data center found in the VMware instance.Example:
Oracle-Datacenter
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the VMware instance.Example:true
-
ErrorMessage: string
The error message obtained for the VMware poller when discovery is done..Example:
-
HostDiscovery: array
HostDiscovery
The list of hosts discovered for the VMware instance.
-
Hostname: string
The hostname of the VMware instance.Example:
example3.oracle.com
-
IPAddress: string
The REST API IP address of the VMware instance.Example:
192.0.2.0
-
Port: integer
The port number used for the REST API URL.Example:
8080
-
Protocol: string
The protocol used for the REST API URL.Example:
https
-
TargetURL: string
The REST API URL of the VMware instance.Example:
https://192.0.2.0:8080
-
VMDiscovery: array
VMDiscovery
The list of virtual machines discovered for the VMware instance.
-
ZoneID: integer
The zone id of the VMware instance.Example:
1
Nested Schema : HostDiscovery
Type:
array
The list of hosts discovered for the VMware instance.
Example:
[
{
"ConnectionState":"connected",
"Hostname":"",
"IPAddress":"192.0.2.3",
"Name":"host-16",
"PowerState":"poweredOn"
}
]
Nested Schema : VMDiscovery
Type:
array
The list of virtual machines discovered for the VMware instance.
Example:
[
{
"ConnectionState":"connected",
"Hostname":"example.oracle.com",
"IPAddress":"192.0.2.4",
"Name":"vmware-example",
"PowerState":"poweredOn"
}
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
DiscoveryContextID: string
The ID obtained from discovery request.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
-
DiscoveryModel: string
The discovery model name.Example:
discovery
-
Method: string
The inventory method name.Example:
add
-
Model: string
The inventory model name.Example:
inventory
-
ModelData: object
ModelData
-
Type: string
The inventory type.Example:
device
-
Version: string
The inventory version.Example:
0.0.1
Nested Schema : ModelData
Type:
Show Source
object
-
Devices: object
Devices
Additional Properties Allowed: additionalPropertiesThe list of devices discovered.
-
VMWare: array
VMWare
The VMware data discovered for the discovery.
Nested Schema : Devices
Type:
object
Additional Properties Allowed
Show Source
The list of devices discovered.
Example:
{
"203.0.113.0":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example1.oracle.com",
"LastRTTNano":221198,
"Timestamp":1702216942,
"IPAddress":"203.0.113.0",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"203.0.113.1":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example2.oracle.com",
"LastRTTNano":645484,
"Timestamp":1702216942,
"IPAddress":"203.0.113.1",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"192.0.2.0":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example3.oracle.com",
"LastRTTNano":688044,
"Timestamp":1702216942,
"IPAddress":"192.0.2.0",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.0",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example3.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.4"
}
}
},
"192.0.2.1":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example4.oracle.com",
"LastRTTNano":1491998,
"Timestamp":1702216942,
"IPAddress":"192.0.2.1",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.1",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example4.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.3"
}
}
}
}
Nested Schema : additionalProperties
Type:
Show Source
object
-
ICMPData: object
ICMPData
The ICMP data discovered for the discovery.
-
SNMPData: object
SNMPData
The SNMP data discovered for the discovery.
Nested Schema : ICMPData
Type:
object
The ICMP data discovered for the discovery.
Show Source
-
Available: boolean
Allowed Values:
[ true, false ]
The availability state of the device. -
Hostname: string
The hostname of the device.
-
IPAddress: string
The IP address of the device.
-
PollTimeACOM: integer
The polling time in seconds for the availability models.
-
PollTimePCOM: integer
The polling time in seconds for the performance models.
-
Properties: object
Properties
The device properties.
-
Timestamp: integer
The unix time in seconds at which icmp data is discovered.Example:
2147483647
-
ZoneID: integer
The zone id of the device.
Nested Schema : SNMPData
Type:
object
The SNMP data discovered for the discovery.
Show Source
-
AuthEngineID: string
The SNMP profile authentication engine ID.
-
Availability: array
Availability
The availability data of the SNMP device.
-
DeviceSystemInfo: object
DeviceSystemInfo
The information about SNMP device system.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
Performance: array
Performance
The performance data of the SNMP device.
-
ProfileID: integer
The SNMP profile IP of the device.
-
ProfileUUID: string
The SNMP profile UUID of the device.
-
Target: string
The hostname or IP address of the device.
-
WorkerError: boolean
Allowed Values:
[ true, false ]
The status of the snmp poller worker error. -
WorkerErrorMessage: string
The worker error message obtained from the snmp poller when discovery is done.
Nested Schema : Properties
Type:
object
The device properties.
Show Source
-
Managed: boolean
Allowed Values:
[ true, false ]
The status of the devices can be managed. Possible values are true and false.
Nested Schema : DeviceSystemInfo
Type:
object
The information about SNMP device system.
Show Source
-
SerialNumber: string
The serial number of the SNMP device.
-
SysContact: string
The primary contact of the SNMP device.
-
SysDescription: string
The description of the SNMP device.
-
SysLocation: string
The physical location of the SNMP device being monitored.
-
SysName: string
The administrative assigned name for the SNMP device.
-
SysOid: string
The object identifier of the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
InstanceOid: string
The instance object identifier of the SNMP device.
-
Instances: array
Instances
The instance details of the SNMP device.
-
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device data belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : Instances
Type:
array
The instance details of the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]
The discovery status of the SNMP device. -
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device data belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : items
Type:
Show Source
object
-
APIAccessID: string
The base64-encoded API access ID for the REST API URL.Example:
dGVzdA==
-
APIAccessKey: string
The base64-encoded API access key for the REST API URL.Example:
dGVzdA==
-
APIVersion: string
The VMware version.Example:
7.0.1 7.0.2.0
-
datacenterName: string
The data center found in the VMware instance.Example:
Oracle-Datacenter
-
Hostname: string
The hostname of the VMware instance.Example:
example3.oracle.com
-
IPAddress: string
The REST API IP address of the VMware instance.Example:
192.0.2.0
-
PollTimeACOM: integer
The polling time in seconds for the availability models.Example:
300
-
PollTimePCOM: integer
The polling time in seconds for the performance models.Example:
300
-
Port: integer
The port number used for the REST API URL.Example:
8080
-
Protocol: string
The protocol used for the REST API URL.Example:
https
-
TargetURL: string
The REST API URL of the VMware instance.Example:
https://192.0.2.0:8080
-
ZoneID: integer
The zone id of the VMware instance.Example:
1
400 Response
Bad request
401 Response
Unauthorized operation
500 Response
Internal server error