Jump to

• Request
• Response

Update the Inventory

patch

/inventory

Updates the inventory with the discovery results.

Request

Query Parameters

• PublishErrors(required): boolean
  Whether to publish errors (true) or not (false).

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Model":{
            "description":"The inventory model name.",
            "type":"string",
            "example":"inventory"
        },
        "DiscoveryModel":{
            "description":"The discovery model name.",
            "type":"string",
            "example":"discovery"
        },
        "Type":{
            "description":"The inventory type.",
            "type":"string",
            "example":"device"
        },
        "Method":{
            "description":"The inventory method name.",
            "type":"string",
            "example":"add"
        },
        "Version":{
            "description":"The inventory version.",
            "type":"string",
            "example":"0.0.1"
        },
        "DiscoveryContextID":{
            "description":"The ID obtained from discovery request.",
            "type":"string",
            "example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
        },
        "ModelData":{
            "type":"object",
            "properties":{
                "Devices":{
                    "description":"The list of devices discovered.",
                    "type":"object",
                    "additionalProperties":{
                        "properties":{
                            "ICMPData":{
                                "description":"The ICMP data discovered for the discovery.",
                                "type":"object",
                                "properties":{
                                    "PollTimePCOM":{
                                        "description":"The polling time in seconds for the performance models.",
                                        "type":"integer"
                                    },
                                    "PollTimeACOM":{
                                        "description":"The polling time in seconds for the availability models.",
                                        "type":"integer"
                                    },
                                    "Available":{
                                        "description":"The availability state of the device.",
                                        "type":"boolean",
                                        "enum":[
                                            true,
                                            false
                                        ]
                                    },
                                    "Hostname":{
                                        "description":"The hostname of the device.",
                                        "type":"string"
                                    },
                                    "Timestamp":{
                                        "description":"The unix time in seconds at which icmp data is discovered.",
                                        "type":"integer",
                                        "example":2147483647
                                    },
                                    "IPAddress":{
                                        "description":"The IP address of the device.",
                                        "type":"string"
                                    },
                                    "ZoneID":{
                                        "description":"The zone id of the device.",
                                        "type":"integer"
                                    },
                                    "Properties":{
                                        "description":"The device properties.",
                                        "type":"object",
                                        "properties":{
                                            "Managed":{
                                                "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
                                                "type":"boolean",
                                                "enum":[
                                                    true,
                                                    false
                                                ]
                                            }
                                        }
                                    }
                                }
                            },
                            "SNMPData":{
                                "description":"The SNMP data discovered for the discovery.",
                                "type":"object",
                                "properties":{
                                    "Target":{
                                        "description":"The hostname or IP address of the device.",
                                        "type":"string"
                                    },
                                    "ProfileUUID":{
                                        "description":"The SNMP profile UUID of the device.",
                                        "type":"string"
                                    },
                                    "ProfileID":{
                                        "description":"The SNMP profile IP of the device.",
                                        "type":"integer"
                                    },
                                    "Discovered":{
                                        "description":"The discovery status of the SNMP device.",
                                        "type":"boolean",
                                        "enum":[
                                            true,
                                            false
                                        ]
                                    },
                                    "AuthEngineID":{
                                        "description":"The SNMP profile authentication engine ID.",
                                        "type":"string"
                                    },
                                    "DeviceSystemInfo":{
                                        "description":"The information about SNMP device system.",
                                        "type":"object",
                                        "properties":{
                                            "SerialNumber":{
                                                "description":"The serial number of the SNMP device.",
                                                "type":"string"
                                            },
                                            "SysContact":{
                                                "description":"The primary contact of the SNMP device.",
                                                "type":"string"
                                            },
                                            "SysDescription":{
                                                "description":"The description of the SNMP device.",
                                                "type":"string"
                                            },
                                            "SysLocation":{
                                                "description":"The physical location of the SNMP device being monitored.",
                                                "type":"string"
                                            },
                                            "SysName":{
                                                "description":"The administrative assigned name for the SNMP device.",
                                                "type":"string"
                                            },
                                            "SysOid":{
                                                "description":"The object identifier of the SNMP device.",
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "Performance":{
                                        "description":"The performance data of the SNMP device.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "Vendor":{
                                                    "description":"The vendor name to which the SNMP device belongs to.",
                                                    "type":"string"
                                                },
                                                "Class":{
                                                    "description":"The class name to which the SNMP device belongs to.",
                                                    "type":"string"
                                                },
                                                "SubClass":{
                                                    "description":"The sub class name to which the SNMP device data belongs to.",
                                                    "type":"string"
                                                },
                                                "Weight":{
                                                    "description":"The importance level for the SNMP device.",
                                                    "type":"integer"
                                                },
                                                "ObjectName":{
                                                    "description":"The object name of the SNMP device.",
                                                    "type":"string"
                                                },
                                                "Discovered":{
                                                    "description":"The discovery status of the SNMP device.",
                                                    "type":"boolean",
                                                    "enum":[
                                                        true,
                                                        false
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "Availability":{
                                        "description":"The availability data of the SNMP device.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "Vendor":{
                                                    "description":"The vendor name to which the SNMP device belongs to.",
                                                    "type":"string"
                                                },
                                                "Class":{
                                                    "description":"The class name to which the SNMP device belongs to.",
                                                    "type":"string"
                                                },
                                                "SubClass":{
                                                    "description":"The sub class name to which the SNMP device data belongs to.",
                                                    "type":"string"
                                                },
                                                "Weight":{
                                                    "description":"The importance level for the SNMP device.",
                                                    "type":"integer"
                                                },
                                                "ObjectName":{
                                                    "description":"The object name of the SNMP device.",
                                                    "type":"string"
                                                },
                                                "Discovered":{
                                                    "description":"The discovery status of the SNMP device.",
                                                    "type":"boolean",
                                                    "enum":[
                                                        true,
                                                        false
                                                    ]
                                                },
                                                "InstanceOid":{
                                                    "description":"The instance object identifier of the SNMP device.",
                                                    "type":"string"
                                                },
                                                "Instances":{
                                                    "description":"The instance details of the SNMP device.",
                                                    "type":"array"
                                                }
                                            }
                                        }
                                    },
                                    "WorkerError":{
                                        "description":"The status of the snmp poller worker error.",
                                        "type":"boolean",
                                        "enum":[
                                            true,
                                            false
                                        ]
                                    },
                                    "WorkerErrorMessage":{
                                        "description":"The worker error message obtained from the snmp poller when discovery is done.",
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    },
                    "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"
                                }
                            }
                        }
                    }
                },
                "VMWare":{
                    "description":"The VMware data discovered for the discovery.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "TargetURL":{
                                "description":"The REST API URL of the VMware instance.",
                                "type":"string",
                                "example":"https://192.0.2.0:8080"
                            },
                            "IPAddress":{
                                "description":"The REST API IP address of the VMware instance.",
                                "type":"string",
                                "example":"192.0.2.0"
                            },
                            "Hostname":{
                                "description":"The hostname of the VMware instance.",
                                "type":"string",
                                "example":"example3.oracle.com"
                            },
                            "Protocol":{
                                "description":"The protocol used for the REST API URL.",
                                "type":"string",
                                "example":"https"
                            },
                            "Port":{
                                "description":"The port number used for the REST API URL.",
                                "type":"integer",
                                "example":8080
                            },
                            "ZoneID":{
                                "description":"The zone id of the VMware instance.",
                                "type":"integer",
                                "example":1
                            },
                            "datacenterName":{
                                "description":"The data center found in the VMware instance.",
                                "type":"string",
                                "example":"Oracle-Datacenter"
                            },
                            "APIAccessID":{
                                "description":"The base64-encoded API access ID for the REST API URL.",
                                "type":"string",
                                "example":"dGVzdA=="
                            },
                            "APIAccessKey":{
                                "description":"The base64-encoded API access key for the REST API URL.",
                                "type":"string",
                                "example":"dGVzdA=="
                            },
                            "APIVersion":{
                                "description":"The VMware version.",
                                "type":"string",
                                "example":"7.0.1 7.0.2.0"
                            },
                            "PollTimePCOM":{
                                "description":"The polling time in seconds for the performance models.",
                                "type":"integer",
                                "example":300
                            },
                            "PollTimeACOM":{
                                "description":"The polling time in seconds for the availability models.",
                                "type":"integer",
                                "example":300
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : ModelData

Type: object

Show Source

• Devices: object Devices
  Additional Properties Allowed: additionalProperties

  The list of devices discovered.
• VMWare: array VMWare
  The VMware data discovered for the discovery.

{
    "type":"object",
    "properties":{
        "Devices":{
            "description":"The list of devices discovered.",
            "type":"object",
            "additionalProperties":{
                "properties":{
                    "ICMPData":{
                        "description":"The ICMP data discovered for the discovery.",
                        "type":"object",
                        "properties":{
                            "PollTimePCOM":{
                                "description":"The polling time in seconds for the performance models.",
                                "type":"integer"
                            },
                            "PollTimeACOM":{
                                "description":"The polling time in seconds for the availability models.",
                                "type":"integer"
                            },
                            "Available":{
                                "description":"The availability state of the device.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            },
                            "Hostname":{
                                "description":"The hostname of the device.",
                                "type":"string"
                            },
                            "Timestamp":{
                                "description":"The unix time in seconds at which icmp data is discovered.",
                                "type":"integer",
                                "example":2147483647
                            },
                            "IPAddress":{
                                "description":"The IP address of the device.",
                                "type":"string"
                            },
                            "ZoneID":{
                                "description":"The zone id of the device.",
                                "type":"integer"
                            },
                            "Properties":{
                                "description":"The device properties.",
                                "type":"object",
                                "properties":{
                                    "Managed":{
                                        "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
                                        "type":"boolean",
                                        "enum":[
                                            true,
                                            false
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "SNMPData":{
                        "description":"The SNMP data discovered for the discovery.",
                        "type":"object",
                        "properties":{
                            "Target":{
                                "description":"The hostname or IP address of the device.",
                                "type":"string"
                            },
                            "ProfileUUID":{
                                "description":"The SNMP profile UUID of the device.",
                                "type":"string"
                            },
                            "ProfileID":{
                                "description":"The SNMP profile IP of the device.",
                                "type":"integer"
                            },
                            "Discovered":{
                                "description":"The discovery status of the SNMP device.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            },
                            "AuthEngineID":{
                                "description":"The SNMP profile authentication engine ID.",
                                "type":"string"
                            },
                            "DeviceSystemInfo":{
                                "description":"The information about SNMP device system.",
                                "type":"object",
                                "properties":{
                                    "SerialNumber":{
                                        "description":"The serial number of the SNMP device.",
                                        "type":"string"
                                    },
                                    "SysContact":{
                                        "description":"The primary contact of the SNMP device.",
                                        "type":"string"
                                    },
                                    "SysDescription":{
                                        "description":"The description of the SNMP device.",
                                        "type":"string"
                                    },
                                    "SysLocation":{
                                        "description":"The physical location of the SNMP device being monitored.",
                                        "type":"string"
                                    },
                                    "SysName":{
                                        "description":"The administrative assigned name for the SNMP device.",
                                        "type":"string"
                                    },
                                    "SysOid":{
                                        "description":"The object identifier of the SNMP device.",
                                        "type":"string"
                                    }
                                }
                            },
                            "Performance":{
                                "description":"The performance data of the SNMP device.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "Vendor":{
                                            "description":"The vendor name to which the SNMP device belongs to.",
                                            "type":"string"
                                        },
                                        "Class":{
                                            "description":"The class name to which the SNMP device belongs to.",
                                            "type":"string"
                                        },
                                        "SubClass":{
                                            "description":"The sub class name to which the SNMP device data belongs to.",
                                            "type":"string"
                                        },
                                        "Weight":{
                                            "description":"The importance level for the SNMP device.",
                                            "type":"integer"
                                        },
                                        "ObjectName":{
                                            "description":"The object name of the SNMP device.",
                                            "type":"string"
                                        },
                                        "Discovered":{
                                            "description":"The discovery status of the SNMP device.",
                                            "type":"boolean",
                                            "enum":[
                                                true,
                                                false
                                            ]
                                        }
                                    }
                                }
                            },
                            "Availability":{
                                "description":"The availability data of the SNMP device.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "Vendor":{
                                            "description":"The vendor name to which the SNMP device belongs to.",
                                            "type":"string"
                                        },
                                        "Class":{
                                            "description":"The class name to which the SNMP device belongs to.",
                                            "type":"string"
                                        },
                                        "SubClass":{
                                            "description":"The sub class name to which the SNMP device data belongs to.",
                                            "type":"string"
                                        },
                                        "Weight":{
                                            "description":"The importance level for the SNMP device.",
                                            "type":"integer"
                                        },
                                        "ObjectName":{
                                            "description":"The object name of the SNMP device.",
                                            "type":"string"
                                        },
                                        "Discovered":{
                                            "description":"The discovery status of the SNMP device.",
                                            "type":"boolean",
                                            "enum":[
                                                true,
                                                false
                                            ]
                                        },
                                        "InstanceOid":{
                                            "description":"The instance object identifier of the SNMP device.",
                                            "type":"string"
                                        },
                                        "Instances":{
                                            "description":"The instance details of the SNMP device.",
                                            "type":"array"
                                        }
                                    }
                                }
                            },
                            "WorkerError":{
                                "description":"The status of the snmp poller worker error.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            },
                            "WorkerErrorMessage":{
                                "description":"The worker error message obtained from the snmp poller when discovery is done.",
                                "type":"string"
                            }
                        }
                    }
                }
            },
            "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"
                        }
                    }
                }
            }
        },
        "VMWare":{
            "description":"The VMware data discovered for the discovery.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TargetURL":{
                        "description":"The REST API URL of the VMware instance.",
                        "type":"string",
                        "example":"https://192.0.2.0:8080"
                    },
                    "IPAddress":{
                        "description":"The REST API IP address of the VMware instance.",
                        "type":"string",
                        "example":"192.0.2.0"
                    },
                    "Hostname":{
                        "description":"The hostname of the VMware instance.",
                        "type":"string",
                        "example":"example3.oracle.com"
                    },
                    "Protocol":{
                        "description":"The protocol used for the REST API URL.",
                        "type":"string",
                        "example":"https"
                    },
                    "Port":{
                        "description":"The port number used for the REST API URL.",
                        "type":"integer",
                        "example":8080
                    },
                    "ZoneID":{
                        "description":"The zone id of the VMware instance.",
                        "type":"integer",
                        "example":1
                    },
                    "datacenterName":{
                        "description":"The data center found in the VMware instance.",
                        "type":"string",
                        "example":"Oracle-Datacenter"
                    },
                    "APIAccessID":{
                        "description":"The base64-encoded API access ID for the REST API URL.",
                        "type":"string",
                        "example":"dGVzdA=="
                    },
                    "APIAccessKey":{
                        "description":"The base64-encoded API access key for the REST API URL.",
                        "type":"string",
                        "example":"dGVzdA=="
                    },
                    "APIVersion":{
                        "description":"The VMware version.",
                        "type":"string",
                        "example":"7.0.1 7.0.2.0"
                    },
                    "PollTimePCOM":{
                        "description":"The polling time in seconds for the performance models.",
                        "type":"integer",
                        "example":300
                    },
                    "PollTimeACOM":{
                        "description":"The polling time in seconds for the availability models.",
                        "type":"integer",
                        "example":300
                    }
                }
            }
        }
    }
}

Nested Schema : Devices

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The list of devices discovered.",
    "type":"object",
    "additionalProperties":{
        "properties":{
            "ICMPData":{
                "description":"The ICMP data discovered for the discovery.",
                "type":"object",
                "properties":{
                    "PollTimePCOM":{
                        "description":"The polling time in seconds for the performance models.",
                        "type":"integer"
                    },
                    "PollTimeACOM":{
                        "description":"The polling time in seconds for the availability models.",
                        "type":"integer"
                    },
                    "Available":{
                        "description":"The availability state of the device.",
                        "type":"boolean",
                        "enum":[
                            true,
                            false
                        ]
                    },
                    "Hostname":{
                        "description":"The hostname of the device.",
                        "type":"string"
                    },
                    "Timestamp":{
                        "description":"The unix time in seconds at which icmp data is discovered.",
                        "type":"integer",
                        "example":2147483647
                    },
                    "IPAddress":{
                        "description":"The IP address of the device.",
                        "type":"string"
                    },
                    "ZoneID":{
                        "description":"The zone id of the device.",
                        "type":"integer"
                    },
                    "Properties":{
                        "description":"The device properties.",
                        "type":"object",
                        "properties":{
                            "Managed":{
                                "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            }
                        }
                    }
                }
            },
            "SNMPData":{
                "description":"The SNMP data discovered for the discovery.",
                "type":"object",
                "properties":{
                    "Target":{
                        "description":"The hostname or IP address of the device.",
                        "type":"string"
                    },
                    "ProfileUUID":{
                        "description":"The SNMP profile UUID of the device.",
                        "type":"string"
                    },
                    "ProfileID":{
                        "description":"The SNMP profile IP of the device.",
                        "type":"integer"
                    },
                    "Discovered":{
                        "description":"The discovery status of the SNMP device.",
                        "type":"boolean",
                        "enum":[
                            true,
                            false
                        ]
                    },
                    "AuthEngineID":{
                        "description":"The SNMP profile authentication engine ID.",
                        "type":"string"
                    },
                    "DeviceSystemInfo":{
                        "description":"The information about SNMP device system.",
                        "type":"object",
                        "properties":{
                            "SerialNumber":{
                                "description":"The serial number of the SNMP device.",
                                "type":"string"
                            },
                            "SysContact":{
                                "description":"The primary contact of the SNMP device.",
                                "type":"string"
                            },
                            "SysDescription":{
                                "description":"The description of the SNMP device.",
                                "type":"string"
                            },
                            "SysLocation":{
                                "description":"The physical location of the SNMP device being monitored.",
                                "type":"string"
                            },
                            "SysName":{
                                "description":"The administrative assigned name for the SNMP device.",
                                "type":"string"
                            },
                            "SysOid":{
                                "description":"The object identifier of the SNMP device.",
                                "type":"string"
                            }
                        }
                    },
                    "Performance":{
                        "description":"The performance data of the SNMP device.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "Vendor":{
                                    "description":"The vendor name to which the SNMP device belongs to.",
                                    "type":"string"
                                },
                                "Class":{
                                    "description":"The class name to which the SNMP device belongs to.",
                                    "type":"string"
                                },
                                "SubClass":{
                                    "description":"The sub class name to which the SNMP device data belongs to.",
                                    "type":"string"
                                },
                                "Weight":{
                                    "description":"The importance level for the SNMP device.",
                                    "type":"integer"
                                },
                                "ObjectName":{
                                    "description":"The object name of the SNMP device.",
                                    "type":"string"
                                },
                                "Discovered":{
                                    "description":"The discovery status of the SNMP device.",
                                    "type":"boolean",
                                    "enum":[
                                        true,
                                        false
                                    ]
                                }
                            }
                        }
                    },
                    "Availability":{
                        "description":"The availability data of the SNMP device.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "Vendor":{
                                    "description":"The vendor name to which the SNMP device belongs to.",
                                    "type":"string"
                                },
                                "Class":{
                                    "description":"The class name to which the SNMP device belongs to.",
                                    "type":"string"
                                },
                                "SubClass":{
                                    "description":"The sub class name to which the SNMP device data belongs to.",
                                    "type":"string"
                                },
                                "Weight":{
                                    "description":"The importance level for the SNMP device.",
                                    "type":"integer"
                                },
                                "ObjectName":{
                                    "description":"The object name of the SNMP device.",
                                    "type":"string"
                                },
                                "Discovered":{
                                    "description":"The discovery status of the SNMP device.",
                                    "type":"boolean",
                                    "enum":[
                                        true,
                                        false
                                    ]
                                },
                                "InstanceOid":{
                                    "description":"The instance object identifier of the SNMP device.",
                                    "type":"string"
                                },
                                "Instances":{
                                    "description":"The instance details of the SNMP device.",
                                    "type":"array"
                                }
                            }
                        }
                    },
                    "WorkerError":{
                        "description":"The status of the snmp poller worker error.",
                        "type":"boolean",
                        "enum":[
                            true,
                            false
                        ]
                    },
                    "WorkerErrorMessage":{
                        "description":"The worker error message obtained from the snmp poller when discovery is done.",
                        "type":"string"
                    }
                }
            }
        }
    },
    "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"
                }
            }
        }
    }
}

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 : VMWare

Type: array

The VMware data discovered for the discovery.

Show Source

• Array of: object items

{
    "description":"The VMware data discovered for the discovery.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "TargetURL":{
                "description":"The REST API URL of the VMware instance.",
                "type":"string",
                "example":"https://192.0.2.0:8080"
            },
            "IPAddress":{
                "description":"The REST API IP address of the VMware instance.",
                "type":"string",
                "example":"192.0.2.0"
            },
            "Hostname":{
                "description":"The hostname of the VMware instance.",
                "type":"string",
                "example":"example3.oracle.com"
            },
            "Protocol":{
                "description":"The protocol used for the REST API URL.",
                "type":"string",
                "example":"https"
            },
            "Port":{
                "description":"The port number used for the REST API URL.",
                "type":"integer",
                "example":8080
            },
            "ZoneID":{
                "description":"The zone id of the VMware instance.",
                "type":"integer",
                "example":1
            },
            "datacenterName":{
                "description":"The data center found in the VMware instance.",
                "type":"string",
                "example":"Oracle-Datacenter"
            },
            "APIAccessID":{
                "description":"The base64-encoded API access ID for the REST API URL.",
                "type":"string",
                "example":"dGVzdA=="
            },
            "APIAccessKey":{
                "description":"The base64-encoded API access key for the REST API URL.",
                "type":"string",
                "example":"dGVzdA=="
            },
            "APIVersion":{
                "description":"The VMware version.",
                "type":"string",
                "example":"7.0.1 7.0.2.0"
            },
            "PollTimePCOM":{
                "description":"The polling time in seconds for the performance models.",
                "type":"integer",
                "example":300
            },
            "PollTimeACOM":{
                "description":"The polling time in seconds for the availability models.",
                "type":"integer",
                "example":300
            }
        }
    }
}

Nested Schema : additionalProperties

Type: object

Show Source

• ICMPData: object ICMPData
  The ICMP data discovered for the discovery.
• SNMPData: object SNMPData
  The SNMP data discovered for the discovery.

{
    "properties":{
        "ICMPData":{
            "description":"The ICMP data discovered for the discovery.",
            "type":"object",
            "properties":{
                "PollTimePCOM":{
                    "description":"The polling time in seconds for the performance models.",
                    "type":"integer"
                },
                "PollTimeACOM":{
                    "description":"The polling time in seconds for the availability models.",
                    "type":"integer"
                },
                "Available":{
                    "description":"The availability state of the device.",
                    "type":"boolean",
                    "enum":[
                        true,
                        false
                    ]
                },
                "Hostname":{
                    "description":"The hostname of the device.",
                    "type":"string"
                },
                "Timestamp":{
                    "description":"The unix time in seconds at which icmp data is discovered.",
                    "type":"integer",
                    "example":2147483647
                },
                "IPAddress":{
                    "description":"The IP address of the device.",
                    "type":"string"
                },
                "ZoneID":{
                    "description":"The zone id of the device.",
                    "type":"integer"
                },
                "Properties":{
                    "description":"The device properties.",
                    "type":"object",
                    "properties":{
                        "Managed":{
                            "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
                            "type":"boolean",
                            "enum":[
                                true,
                                false
                            ]
                        }
                    }
                }
            }
        },
        "SNMPData":{
            "description":"The SNMP data discovered for the discovery.",
            "type":"object",
            "properties":{
                "Target":{
                    "description":"The hostname or IP address of the device.",
                    "type":"string"
                },
                "ProfileUUID":{
                    "description":"The SNMP profile UUID of the device.",
                    "type":"string"
                },
                "ProfileID":{
                    "description":"The SNMP profile IP of the device.",
                    "type":"integer"
                },
                "Discovered":{
                    "description":"The discovery status of the SNMP device.",
                    "type":"boolean",
                    "enum":[
                        true,
                        false
                    ]
                },
                "AuthEngineID":{
                    "description":"The SNMP profile authentication engine ID.",
                    "type":"string"
                },
                "DeviceSystemInfo":{
                    "description":"The information about SNMP device system.",
                    "type":"object",
                    "properties":{
                        "SerialNumber":{
                            "description":"The serial number of the SNMP device.",
                            "type":"string"
                        },
                        "SysContact":{
                            "description":"The primary contact of the SNMP device.",
                            "type":"string"
                        },
                        "SysDescription":{
                            "description":"The description of the SNMP device.",
                            "type":"string"
                        },
                        "SysLocation":{
                            "description":"The physical location of the SNMP device being monitored.",
                            "type":"string"
                        },
                        "SysName":{
                            "description":"The administrative assigned name for the SNMP device.",
                            "type":"string"
                        },
                        "SysOid":{
                            "description":"The object identifier of the SNMP device.",
                            "type":"string"
                        }
                    }
                },
                "Performance":{
                    "description":"The performance data of the SNMP device.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Vendor":{
                                "description":"The vendor name to which the SNMP device belongs to.",
                                "type":"string"
                            },
                            "Class":{
                                "description":"The class name to which the SNMP device belongs to.",
                                "type":"string"
                            },
                            "SubClass":{
                                "description":"The sub class name to which the SNMP device data belongs to.",
                                "type":"string"
                            },
                            "Weight":{
                                "description":"The importance level for the SNMP device.",
                                "type":"integer"
                            },
                            "ObjectName":{
                                "description":"The object name of the SNMP device.",
                                "type":"string"
                            },
                            "Discovered":{
                                "description":"The discovery status of the SNMP device.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            }
                        }
                    }
                },
                "Availability":{
                    "description":"The availability data of the SNMP device.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Vendor":{
                                "description":"The vendor name to which the SNMP device belongs to.",
                                "type":"string"
                            },
                            "Class":{
                                "description":"The class name to which the SNMP device belongs to.",
                                "type":"string"
                            },
                            "SubClass":{
                                "description":"The sub class name to which the SNMP device data belongs to.",
                                "type":"string"
                            },
                            "Weight":{
                                "description":"The importance level for the SNMP device.",
                                "type":"integer"
                            },
                            "ObjectName":{
                                "description":"The object name of the SNMP device.",
                                "type":"string"
                            },
                            "Discovered":{
                                "description":"The discovery status of the SNMP device.",
                                "type":"boolean",
                                "enum":[
                                    true,
                                    false
                                ]
                            },
                            "InstanceOid":{
                                "description":"The instance object identifier of the SNMP device.",
                                "type":"string"
                            },
                            "Instances":{
                                "description":"The instance details of the SNMP device.",
                                "type":"array"
                            }
                        }
                    }
                },
                "WorkerError":{
                    "description":"The status of the snmp poller worker error.",
                    "type":"boolean",
                    "enum":[
                        true,
                        false
                    ]
                },
                "WorkerErrorMessage":{
                    "description":"The worker error message obtained from the snmp poller when discovery is done.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"The ICMP data discovered for the discovery.",
    "type":"object",
    "properties":{
        "PollTimePCOM":{
            "description":"The polling time in seconds for the performance models.",
            "type":"integer"
        },
        "PollTimeACOM":{
            "description":"The polling time in seconds for the availability models.",
            "type":"integer"
        },
        "Available":{
            "description":"The availability state of the device.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        },
        "Hostname":{
            "description":"The hostname of the device.",
            "type":"string"
        },
        "Timestamp":{
            "description":"The unix time in seconds at which icmp data is discovered.",
            "type":"integer",
            "example":2147483647
        },
        "IPAddress":{
            "description":"The IP address of the device.",
            "type":"string"
        },
        "ZoneID":{
            "description":"The zone id of the device.",
            "type":"integer"
        },
        "Properties":{
            "description":"The device properties.",
            "type":"object",
            "properties":{
                "Managed":{
                    "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
                    "type":"boolean",
                    "enum":[
                        true,
                        false
                    ]
                }
            }
        }
    }
}

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.

{
    "description":"The SNMP data discovered for the discovery.",
    "type":"object",
    "properties":{
        "Target":{
            "description":"The hostname or IP address of the device.",
            "type":"string"
        },
        "ProfileUUID":{
            "description":"The SNMP profile UUID of the device.",
            "type":"string"
        },
        "ProfileID":{
            "description":"The SNMP profile IP of the device.",
            "type":"integer"
        },
        "Discovered":{
            "description":"The discovery status of the SNMP device.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        },
        "AuthEngineID":{
            "description":"The SNMP profile authentication engine ID.",
            "type":"string"
        },
        "DeviceSystemInfo":{
            "description":"The information about SNMP device system.",
            "type":"object",
            "properties":{
                "SerialNumber":{
                    "description":"The serial number of the SNMP device.",
                    "type":"string"
                },
                "SysContact":{
                    "description":"The primary contact of the SNMP device.",
                    "type":"string"
                },
                "SysDescription":{
                    "description":"The description of the SNMP device.",
                    "type":"string"
                },
                "SysLocation":{
                    "description":"The physical location of the SNMP device being monitored.",
                    "type":"string"
                },
                "SysName":{
                    "description":"The administrative assigned name for the SNMP device.",
                    "type":"string"
                },
                "SysOid":{
                    "description":"The object identifier of the SNMP device.",
                    "type":"string"
                }
            }
        },
        "Performance":{
            "description":"The performance data of the SNMP device.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Vendor":{
                        "description":"The vendor name to which the SNMP device belongs to.",
                        "type":"string"
                    },
                    "Class":{
                        "description":"The class name to which the SNMP device belongs to.",
                        "type":"string"
                    },
                    "SubClass":{
                        "description":"The sub class name to which the SNMP device data belongs to.",
                        "type":"string"
                    },
                    "Weight":{
                        "description":"The importance level for the SNMP device.",
                        "type":"integer"
                    },
                    "ObjectName":{
                        "description":"The object name of the SNMP device.",
                        "type":"string"
                    },
                    "Discovered":{
                        "description":"The discovery status of the SNMP device.",
                        "type":"boolean",
                        "enum":[
                            true,
                            false
                        ]
                    }
                }
            }
        },
        "Availability":{
            "description":"The availability data of the SNMP device.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Vendor":{
                        "description":"The vendor name to which the SNMP device belongs to.",
                        "type":"string"
                    },
                    "Class":{
                        "description":"The class name to which the SNMP device belongs to.",
                        "type":"string"
                    },
                    "SubClass":{
                        "description":"The sub class name to which the SNMP device data belongs to.",
                        "type":"string"
                    },
                    "Weight":{
                        "description":"The importance level for the SNMP device.",
                        "type":"integer"
                    },
                    "ObjectName":{
                        "description":"The object name of the SNMP device.",
                        "type":"string"
                    },
                    "Discovered":{
                        "description":"The discovery status of the SNMP device.",
                        "type":"boolean",
                        "enum":[
                            true,
                            false
                        ]
                    },
                    "InstanceOid":{
                        "description":"The instance object identifier of the SNMP device.",
                        "type":"string"
                    },
                    "Instances":{
                        "description":"The instance details of the SNMP device.",
                        "type":"array"
                    }
                }
            }
        },
        "WorkerError":{
            "description":"The status of the snmp poller worker error.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        },
        "WorkerErrorMessage":{
            "description":"The worker error message obtained from the snmp poller when discovery is done.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The device properties.",
    "type":"object",
    "properties":{
        "Managed":{
            "description":"The status of the devices can be managed. Possible values are <b>true</b> and <b>false</b>.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    }
}

Nested Schema : Availability

Type: array

The availability data of the SNMP device.

Show Source

• Array of: object items

{
    "description":"The availability data of the SNMP device.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Vendor":{
                "description":"The vendor name to which the SNMP device belongs to.",
                "type":"string"
            },
            "Class":{
                "description":"The class name to which the SNMP device belongs to.",
                "type":"string"
            },
            "SubClass":{
                "description":"The sub class name to which the SNMP device data belongs to.",
                "type":"string"
            },
            "Weight":{
                "description":"The importance level for the SNMP device.",
                "type":"integer"
            },
            "ObjectName":{
                "description":"The object name of the SNMP device.",
                "type":"string"
            },
            "Discovered":{
                "description":"The discovery status of the SNMP device.",
                "type":"boolean",
                "enum":[
                    true,
                    false
                ]
            },
            "InstanceOid":{
                "description":"The instance object identifier of the SNMP device.",
                "type":"string"
            },
            "Instances":{
                "description":"The instance details of the SNMP device.",
                "type":"array"
            }
        }
    }
}

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.

{
    "description":"The information about SNMP device system.",
    "type":"object",
    "properties":{
        "SerialNumber":{
            "description":"The serial number of the SNMP device.",
            "type":"string"
        },
        "SysContact":{
            "description":"The primary contact of the SNMP device.",
            "type":"string"
        },
        "SysDescription":{
            "description":"The description of the SNMP device.",
            "type":"string"
        },
        "SysLocation":{
            "description":"The physical location of the SNMP device being monitored.",
            "type":"string"
        },
        "SysName":{
            "description":"The administrative assigned name for the SNMP device.",
            "type":"string"
        },
        "SysOid":{
            "description":"The object identifier of the SNMP device.",
            "type":"string"
        }
    }
}

Nested Schema : Performance

Type: array

The performance data of the SNMP device.

Show Source

• Array of: object items

{
    "description":"The performance data of the SNMP device.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Vendor":{
                "description":"The vendor name to which the SNMP device belongs to.",
                "type":"string"
            },
            "Class":{
                "description":"The class name to which the SNMP device belongs to.",
                "type":"string"
            },
            "SubClass":{
                "description":"The sub class name to which the SNMP device data belongs to.",
                "type":"string"
            },
            "Weight":{
                "description":"The importance level for the SNMP device.",
                "type":"integer"
            },
            "ObjectName":{
                "description":"The object name of the SNMP device.",
                "type":"string"
            },
            "Discovered":{
                "description":"The discovery status of the SNMP device.",
                "type":"boolean",
                "enum":[
                    true,
                    false
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Vendor":{
            "description":"The vendor name to which the SNMP device belongs to.",
            "type":"string"
        },
        "Class":{
            "description":"The class name to which the SNMP device belongs to.",
            "type":"string"
        },
        "SubClass":{
            "description":"The sub class name to which the SNMP device data belongs to.",
            "type":"string"
        },
        "Weight":{
            "description":"The importance level for the SNMP device.",
            "type":"integer"
        },
        "ObjectName":{
            "description":"The object name of the SNMP device.",
            "type":"string"
        },
        "Discovered":{
            "description":"The discovery status of the SNMP device.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        },
        "InstanceOid":{
            "description":"The instance object identifier of the SNMP device.",
            "type":"string"
        },
        "Instances":{
            "description":"The instance details of the SNMP device.",
            "type":"array"
        }
    }
}

Nested Schema : Instances

Type: array

The instance details of the SNMP device.

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Vendor":{
            "description":"The vendor name to which the SNMP device belongs to.",
            "type":"string"
        },
        "Class":{
            "description":"The class name to which the SNMP device belongs to.",
            "type":"string"
        },
        "SubClass":{
            "description":"The sub class name to which the SNMP device data belongs to.",
            "type":"string"
        },
        "Weight":{
            "description":"The importance level for the SNMP device.",
            "type":"integer"
        },
        "ObjectName":{
            "description":"The object name of the SNMP device.",
            "type":"string"
        },
        "Discovered":{
            "description":"The discovery status of the SNMP device.",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "TargetURL":{
            "description":"The REST API URL of the VMware instance.",
            "type":"string",
            "example":"https://192.0.2.0:8080"
        },
        "IPAddress":{
            "description":"The REST API IP address of the VMware instance.",
            "type":"string",
            "example":"192.0.2.0"
        },
        "Hostname":{
            "description":"The hostname of the VMware instance.",
            "type":"string",
            "example":"example3.oracle.com"
        },
        "Protocol":{
            "description":"The protocol used for the REST API URL.",
            "type":"string",
            "example":"https"
        },
        "Port":{
            "description":"The port number used for the REST API URL.",
            "type":"integer",
            "example":8080
        },
        "ZoneID":{
            "description":"The zone id of the VMware instance.",
            "type":"integer",
            "example":1
        },
        "datacenterName":{
            "description":"The data center found in the VMware instance.",
            "type":"string",
            "example":"Oracle-Datacenter"
        },
        "APIAccessID":{
            "description":"The base64-encoded API access ID for the REST API URL.",
            "type":"string",
            "example":"dGVzdA=="
        },
        "APIAccessKey":{
            "description":"The base64-encoded API access key for the REST API URL.",
            "type":"string",
            "example":"dGVzdA=="
        },
        "APIVersion":{
            "description":"The VMware version.",
            "type":"string",
            "example":"7.0.1 7.0.2.0"
        },
        "PollTimePCOM":{
            "description":"The polling time in seconds for the performance models.",
            "type":"integer",
            "example":300
        },
        "PollTimeACOM":{
            "description":"The polling time in seconds for the availability models.",
            "type":"integer",
            "example":300
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

204 Response

No content

401 Response

Unauthorized operation

405 Response

Bad request

500 Response

Internal server error

Back to Top