TargetApiDTO

Description

Model to describe a Target. Targets are used to discover the components to create a connected virtual environment

Required Parameters

type

  • type: string

  • description: Probe type. Turbonomic ships with the following probe types: AppDynamics, Dynatrace, Datadog, Apptio Cloudability, Arista, AWS, Azure, Cisco APIC, Cisco HyperFlex, Cisco UCS Central, Cisco UCS Director, Cisco UCS Manager, CloudFoundry, CloudStack, Dell Compellent, EMC ScaleIO, EMC VMAX, EMC VNX, EMC VPLEX, EMC XtremIO, Hitachi Vantara, HP OneView, HPE 3PAR, Hyper-V, IBM PowerVM, Instana, JBoss, JVM, MSExchange, MySQL, NetApp, NetFlow, NetScaler, Nutanix, OpenStack, Oracle, Pivotal Ops Manager, Pure, Red Hat Virtualization Manager, sFlow, SNMP, SoftLayer, SQLServer, Tetration, Tomcat, vCenter, vCloudDirector, VMM, WebLogic, WebSphere, WMI, XenServer,

Optional Parameters

uuid

  • type: string

displayName

  • type: string

  • description: A user readable name of the api object. Cannot be blank. The UTF-8 encoding must be at most 255 bytes.

className

  • type: string

category

  • type: string

  • example: Hypervisor

  • description: Probe category.

isProbeRegistered

  • type: boolean

  • example: False

  • description: Indicator that is used to determine whether the associated probe is running and registered with the system

uiCategory

  • type: string

  • example: Application Server, Billing, Cloud Management, Applications and Databases, Fabric and Network, Guest OS Processes, HYPERCONVERGED, HYPERVISOR, Load Balancer, Operations Manager Appliance, ORCHESTRATOR, PaaS, Storage, Storage Browsing, WINDOWS APPLICATION. There are also categories Custom and UNKNOWN to be used for new probe development.

  • description: Probe UI category.

identifyingFields

  • type: array

  • description: Array of field names used to differentiate probes of the same category. Most typically either the name/address field, or a combination of address and port.

    • type: string

inputFields

  • type: array

  • description: List of all InputFieldApiDTO objects for the target, analogous to the target addition form fields in the GUI.

lastValidated

  • type: string

  • description: Date of the last validation - [DEPRECATED - Use: healthSummary.timeOfLastSuccessfulDiscovery]

status

  • type: string

  • example: Validated, VALIDATION FAILED, UNKNOWN

  • description: Description of the status of the most recent Validation Operation - [DEPRECATED - Use: healthSummary.healthState]

derivedTargets

  • type: array

  • description: Targets derived (created by discovery of) from this target. Populated depending on the TargetRelationship parameter.

patchedTargets
parentTargets

  • type: array

  • description: Targets that created this target. Populated depending on the TargetRelationship parameter.

subType

  • type: string

  • example: RedHatOpenShift

  • description: Target subType.

readonly

  • type: boolean

  • description: Whether the target cannot be changed through public APIs.

health

  • description: [BETA]: A summary of the overall health of the target. Only returned if TargetDetailLevel is HEALTH or HEALTH_DETAILS

  • reference: TargetHealthApiDTO

lastTargetOperationStages

  • type: array

  • description: [BETA]: The status at each stage of the most recent validation or discovery, which ever was more recent. Only returned if TargetDetailLevel is HEALTH_DETAILS

lastEditTime

  • type: string

  • example: 2021-07-07T20:33:49Z

  • description: [BETA]: The last time the target was edited in ISO-8601 Format (YYYY-MM-DDTHH:MM:SSZ). For example 2021-07-07T20:33:49Z

lastEditUser

  • type: string

  • description: [BETA]: The username for last user who edited the target.

healthSummary