Entity types
Entities in TrueSight Capacity Optimization are in three categories: Domains, Business Drivers, and Systems. Each of these categories has its own set of sub-types that can be assigned to the entity. In addition, relationships (see Entity relationships) are also assigned their own types.
The following types of systems, business drivers, domains, and relationships are defined:
System types
A connector may assign a specific type to a system. If not assigned, the system type defaults to "Generic". TrueSight Capacity Optimization uses system types in the following ways:
- In the console user interface, a system's icon denotes its type, and its summary page selects a few metrics to show depending on its type.
- Certain analysis and modeling templates use system types to present the appropriate metrics.
System types can also be used for defining queries for Advanced Reports (see Creating custom reports).
The following table lists all available system types. The "Icon" column shows how the type appears in the console user interface. The "Prefix" column provides the string to be used when developing connectors. The "System type ID" column provides the numeric ID to be used when looking up the system type from the public views.
| Entity Icon | Entity Type | Entity Prefix | System Type ID | Entity type name |
|---|---|---|---|---|
| SYS | gen | 0 | Generic |
| SYS | dbs | 1 | Database Server |
| SYS | aps | 2 | Application Server |
| SYS | wss | 3 | Web Server |
| SYS | db | 4 | Database Instance |
| SYS | as | 5 | Application Server Instance |
 | SYS | ws | 6 | Web Server Instance |
 | SYS | ln | 7 | Network - Link Node |
 | SYS | nas | 8 | Network Attached Storage |
| SYS | san | 9 | Storage System |
| SYS | mf | 10 | Mainframe Instance |
| SYS | tv | 11 | IPTV Server |
| SYS | vh | 12 | Virtual Host |
| SYS | bat | 13 | Batch Server |
 | SYS | fac | 14 | Facility |
| SYS | soa | 15 | SOA Server |
| SYS | gm | 16 | Virtual Machine |
| SYS | vhc | 17 | Virtual Cluster |
| SYS | fac:dev:pdu | 18 | Facility Device - PDU |
| SYS | fac:dev:ups | 19 | Facility Device - UPS |
| SYS | fac:dev:ac | 20 | Facility Device - Air Conditioner |
| SYS | fac:str:rk | 21 | Facility - Rack |
| SYS | fac:str:ln | 22 | Facility - Line |
| SYS | fac:str:rm | 23 | Facility - Room |
| SYS | net:lnk | 24 | Network - Link |
| SYS | gm:vmw | 25 | Virtual Machine - VMware |
| SYS | gm:zn | 26 | Virtual Machine - Solaris Zone |
| SYS | gm:lp | 27 | Virtual Machine - AIX LPAR |
| SYS | gm:xen | 28 | Virtual Machine - Xen |
| SYS | gm:hv | 29 | Virtual Machine - Hyper-V |
| SYS | gm:int | 30 | Virtual Machine - HP Integrity |
| SYS | vh:vmw | 31 | Virtual Host - VMware |
| SYS | vh:xen | 32 | Virtual Host - Xen |
| SYS | vh:hv | 33 | Virtual Host - Hyper-V |
| SYS | vh:zn | 34 | Virtual Host - Solaris |
| SYS | vh:lp | 35 | Virtual Host - AIX PowerVM |
| SYS | vh:int | 36 | Virtual Host - HP Integrity |
| SYS | net:dev | 37 | Network - Device |
| SYS | vhc:vmw | 38 | Virtual Cluster - VMware |
| SYS | vhc:xen | 39 | Pool - Xen |
| SYS | vhc:zn | 40 | Virtual Cluster - Solaris Zone |
| SYS | vhc:hv | 41 | Virtual Cluster - Hyper-V |
 | SYS | dbc | 42 | Cluster Database |
| SYS | ds | 43 | Datastore |
| SYS | rp | 44 | Resource Pool |
| SYS | dc | 45 | Datacenter |
 | SYS | gapp | 46 | Virtual Application |
| SYS | gapp:vapp | 47 | Virtual Application - VMware vApp |
| SYS | wk | 48 | Workload |
| SYS | gm:ldom | 49 | Virtual Machine - Solaris LDOM |
| SYS | cl | 51 | Cloud |
| SYS | clpod | 52 | Cloud - Pod |
| SYS | clsp | 53 | Cloud - Default Pool |
| SYS | rac | 54 | Oracle Rac |
| SYS | clsp:vhc | 55 | Cloud - Compute Pool Virtual Cluster |
| SYS | clsp:vh | 56 | Cloud - Compute Pool Virtual Host |
| SYS | clsp:rp | 57 | Cloud - Compute Pool Resource Pool |
| SYS | clsp:phy | 58 | Cloud - Physical Server Pool |
| SYS | rp:sto | 59 | Storage Pool |
| SYS | gm:wpar | 60 | Workload Partition - AIX WPAR |
| SYS | gm:wvn | 61 | Virtual Node - VMware |
| SYS | gm:dsd | 62 | Virtual Machine - Solaris Dynamic System Domain |
| SYS | gm:splp | 63 | Virtual Machine - AIX Shared Processor LPAR |
| SYS | gm:hvvn | 64 | Virtual Node - Hyper-V |
| SYS | gm:xenvn | 65 | Virtual Node - Xen |
| SYS | vh:kvm | 66 | Virtual Host - KVM |
| SYS | gm:kvm | 67 | Virtual Machine - KVM |
| SYS | npar | 68 | HP nPartition |
| SYS | vpar | 69 | HP vPartition |
| SYS | nparc | 70 | Virtual Host - HP nPar/vPar |
 | SYS | clnetc | 71 | Cloud - Network Container |
| SYS | lun | 72 | Storage - LUN |
| SYS | rp:dysto | 73 | Dynamic Storage Pool |
| SYS | filer | 74 | Storage Filer |
| SYS | vfiler | 75 | NetApp vFiler |
| SYS | aggregate | 76 | NetApp Aggregate |
| SYS | volume | 77 | Storage - Volume |
| SYS | rp:spp | 78 | Shared Processor Pool |
| SYS | net:fw | 90 | Network - Firewall |
| SYS | net:lb | 91 | Network - Load Balancer |
| SYS | net:rtr | 92 | Network - Router |
| SYS | net:swt | 93 | Network - Switch |
| SYS | clsp:ds | 94 | Cloud - Virtual Datastore Pool |
 | SYS | mf:cpc | 100 | Mainframe - CPC |
 | SYS | mf:splx | 101 | Mainframe - Sysplex |
 | SYS | mf:lpar | 102 | Mainframe - LPAR |
 | SYS | mf:zos | 103 | Mainframe - z/OS Image |
 | SYS | mf:lcsp | 104 | Mainframe - Software Prod. Group |
 | SYS | mf:suit | 105 | Mainframe - Suite |
 | SYS | mf:ap | 106 | Mainframe - Application |
 | SYS | mf:ssas | 107 | Mainframe - Subsystem A/S |
| SYS | mf:srcls | 108 | Mainframe - S/R Class |
| SYS | mf:stg | 139 | Mainframe - Storage Controller |
| SYS | mf:pool | 140 | Storage Pool |
| SYS | hc:vmw | 109 | VMware Hypothetical Cluster |
| SYS | vcd | 110 | vCloud |
| SYS | ovdc | 111 | vCloud - Organization vDC |
| SYS | pvdc | 112 | vCloud - Provider vDC |
| SYS | gm:kvmvn | 113 | Virtual Node - KVM |
| SYS | gm:violp | 114 | Virtual Machine - AIX VIO LPAR |
| SYS | dsc:vmw | 115 | Datastore Cluster - VMware |
| SYS | cp:vmwh | 116 | VMware Hosts Capacity Pool |
| SYS | cp:vmwc | 117 | VMware Clusters Capacity Pool |
| SYS | cp:aix | 120 | AIX Power VM Hosts Capacity Pool |
| SYS | cp:dst | 121 | VMware Datastores Capacity Pool |
| SYS | ds:xen | 122 | Datastore - Xen |
| SYS | rp:aix | 123 | Physical Pool - AIX PowerVM |
| SYS | share | 124 | Storage - Share |
| SYS | cp:rp:sto | 125 | Storage Pools Capacity Pool |
| SYS | hh:vmw | 126 | VMware Hypothetical Host |
| SYS | hh:lp | 127 | AIX Hypothetical Host |
 | SYS | cp:kvmh | 128 | KVM Hosts Capacity Pool |
 | SYS | hh:kvm | 129 | KVM Hypothetical Host |
| | SYS | cp:spp | 200 | AIX Shared Processor Pool Capacity Pool |
 | SYS | hh:spp | 201 | AIX Hypothetical Shared Processor Pool |
| SYS | cp:hvc | 204 | Hyper-V Clusters Capacity Pool |
| SYS | cp:hvh | 205 | Hyper-V Hosts Capacity Pool |
| SYS | cp:agg:os | 207 | OpenStack Host Aggregate Capacity Pool |
| SYS | cl:os | 311 | Cloud - OpenStack |
| SYS | agg:os | 312 | Host Aggregate - OpenStack |
| SYS | vhc:rhev | 313 | Virtual Cluster - RHEV |
| SYS | dc:rhev | 314 | Datacenter - RHEV |
| SYS | sd:rhev | 315 | Storage Domain - RHEV |
| SYS | sh:rhev | 316 | Storage Host - RHEV |
| SYS | shc:rhev | 317 | Storage Cluster - RHEV |
| SYS | gm:rhevn | 318 | Virtual Node - RHEV |
| SYS | gm:vn | 319 | Virtual Node |
| SYS | gm:oraclevn | 320 | Virtual Node - ORACLE VM |
| SYS | gm:ivmvn | 321 | Virtual Node - HPIVM |
 | SYS | cl:aws | 322 | Cloud - AWS |
| SYS | gm:aws | 324 | Virtual Machine - AWS |
| SYS | asg:aws | 325 | Auto Scale Group - AWS |
| SYS | volume:aws | 326 | Storage Volume - AWS |
 | SYS | ds:kvm | 327 | Datastore - KVM |
 | SYS | az:os | 328 | Availability Zone - OpenStack |
 | SYS | rg:os | 329 | Region - OpenStack |
 | SYS | netapp:hapair | 330 | NetApp HA Pair |
| SYS | netapp:cluster | 331 | NetApp Cluster |
| SYS | netapp:vserver | 332 | NetApp Vserver |
| SYS | netapp:volume | 333 | NetApp Volume |
| SYS | netapp:lun | 334 | NetApp LUN |
| SYS | vhc:hadoop | 335 | Hadoop Cluster |
 | SYS | node:hadoop | 336 | Hadoop Node |
| SYS | rp:hadoop | 337 | Hadoop Resource Pool |
| SYS | gm:azu | 338 | Virtual Machine - Azure |
| SYS | depl:azu | 339 | Deployment - Azure |
| SYS | role:azu | 340 | Role - Azure |
| SYS | rm:yarn:hadoop | 341 | Hadoop YARN Resource Manager |
 | SYS | rm:hdfs:hadoop | 342 | Hadoop HDFS Resource Manager |
 | SYS | srv:hbase:hadoop | 343 | Hadoop HBASE Service |
| SYS | srv:spark:hadoop | 344 | Hadoop Spark Service |
| SYS | srv:hadoop | 345 | Hadoop Service |
| SYS | sto:das | 346 | Direct Attached Storage |
 | SYS | sto:cas | 347 | Content Addressable |
| SYS | sto:bak | 348 | Backup Storage Device |
| SYS | kubernetes:cluster | 351 | Kubernetes - Cluster |
| SYS | kubernetes:node | 352 | Kubernetes - Node |
| SYS | kubernetes:pv | 353 | Kubernetes - Persistent |
| SYS | kubernetes:ns | 354 | Kubernetes - Namespace |
| SYS | kubernetes:pod | 355 | Kubernetes - Pod |
| SYS | kubernetes:deployment | 356 | Kubernetes - Deployment |
| SYS | gm:gcp | 358 | Virtual Machine - Google Cloud |
| SYS | sp | 362 | Service Pool |
| SYS | pcf:domain | 380 | PCF Domain |
| SYS | pcf:organization | 381 | PCF Organization |
| SYS | pcf:space | 382 | PCF Space |
| SYS | pcf:application | 383 | PCF Application |
| SYS | pcf:foundation | 384 | PCF Foundation |
| SYS | pcf:node | 385 | PCF Node |
| SYS | pcf:service | 386 | PCF Service |
| SYS | kubernetes:pod:wk | 387 | Pod Workload |
Application types
The following table lists all available application types.
| Domain Icon | Domain Type | Domain Prefix | Domain Type ID | Domain type name |
|---|---|---|---|---|
| APP | svc | 0 | Business Service |
| APP | gen | 1 | Generic |
| APP | sys | 2 | Systems |
| APP | dom | 3 | DomainServers |
| APP | net | 4 | NetworkDevices |
| APP | dbs | 5 | Databases |
| APP | wkld | 6 | Workloads |
| APP | wapp | 7 | WebApplications |
| APP | ts | 8 | TicketSystems |
| APP | mf | 9 | Mainframes |
| APP | bat | 10 | Batches |
| APP | tv | 11 | IPTV |
| APP | san | 12 | |
| APP | fg | 13 | Facilities |
| APP | soa | 14 | SOA |
| APP | tsvc | 16 | Technical Service |
| APP | tnt | 17 | Tenant |
| APP | soi | 18 | Service Offering Instance |
| APP | so | 19 | Service Offering |
| APP | org | 20 | vCloud - Organization |
| APP | ovdcapp | 21 | vCloud - Organization vDC vApps |
| APP | vapp | 22 | vCloud - vApp |
| APP | cs:azu | 23 | Cloud Service - Azure |
| APP | app | 26 | Application |
Business driver types
The following table lists all available business driver types.
Icon | Prefix | Business driver type ID | Business driver type | Description |
|---|---|---|---|---|
| ass | 8 | Application Server | Business driver related to application server instances (for example, servlet calls) |
| bat | 1 | Batch | Business driver running in batches |
| ctg | 13 | Chargeback target | Chargeback target |
| dbs | 7 | Database | Business driver on databases instances (for example, the number of queries executed on a specific instance) |
| fac | 9 | Facility | A business driver measurement for facility equipment |
| ws | 10 | Web service | Business driver related to web service |
| gen | 0 | Generic | A generic business driver |
| tv | 2 | IPTV | Business driver running on IPTV servers |
| ltg | 12 | Load Test Group | Load test group |
| lts | 11 | Load Test Summary | Load test summary |
| ln | 6 | Network Link | Business driver related to data networks (for example, the outbound bit rate from a specific node) |
| soa | 14 | SOA | Business driver that applies to service-oriented architecture |
| tc | 3 | Tickets | Business driver related to ticket systems |
| web | 4 | Web | Business driver related to web servers (for example, a visit to a web page) |
 | mf:bsap | 5 | Mainframe – Business Application | Mainframe – Business Application |
Relationship types
The following table lists all available relationship types. If not specified by a connector, the type of a relationship defaults to CONTAINS. See Relationships for an explanation of how relationships are represented.
Relationship type | Key |
|---|---|
| Business Service contains Service Pool | BS_CONTAINS_SP |
| Application contains Service Pool | APP_CONTAINS_SP |
| Service Pool contains Server | SP_CONTAINS_SRV |
Cloud contains Cloud Pod | CL_CONTAINS_CLPOD |
Cloud Pod contains Cloud Static Pool | CLPOD_CONTAINS_CLSP |
Cloud Static Pool contains Resource Pool | CLSP_CONTAINS_RP |
Cloud Static Pool contains Virtual Host | CLSP_CONTAINS_VH |
Cloud Static Pool contains Virtual Cluster | CLSP_CONTAINS_VHC |
| Capacity Pool Element is part of Capacity Pool | CP_CONTAINS_RSVC |
Contains | CONTAINS |
contains Workload | CONTAINS_WORKLOAD |
Datacenter contains Virtual Host | DC_CONTAINS_VH |
Datacenter contains Virtual Cluster | DC_CONTAINS_VHC |
Datastore contains VM | DS_CONTAINS_GM |
LPAR contains WPAR | GM_CONTAINS_WPAR |
Logical Domain contains Zone | GM_CONTAINS_ZN |
Resource Pool contains VM | RP_CONTAINS_GM |
Resource Pool contains Resource Pool | RP_CONTAINS_RP |
Resource Pool contains VMware vApp | RP_CONTAINS_VAPP |
Uses | USES |
Virtual Host contains VM | VH_CONTAINS_GM |
Virtual Host contains Resource Pool | VH_CONTAINS_RP |
Virtual Host contains VMware vApp | VH_CONTAINS_VAPP |
AIX box contains WPAR | VH_CONTAINS_WPAR |
Solaris Container include Zone | VH_CONTAINS_ZN |
Virtual Host uses Datastore | VH_USES_DS |
Virtual Cluster contains VM | VHC_CONTAINS_GM |
Virtual Cluster contains Resource Pool | VHC_CONTAINS_RP |
Virtual Cluster contains VMware vApp | VHC_CONTAINS_VAPP |
Virtual Cluster contains Virtual Host | VHC_CONTAINS_VH |
Virtual Cluster uses Datastore | VHC_USES_DS |
Virtual Cluster uses VM Template | VHC_USES_GM_TEMPL |
Workload contains Workload | WORKLOAD_CONTAINS_WORKLOAD |
| Uses Direct Attached Storage | USES_DAS |
| Uses Content Addressable Storage | USES_CAS |
| Uses Backup Storage Device | USES_BAK |
Comments
On this page you state that entity type number 33 is "Virtual Host - HyperV", but in the system it is spelled with an additional hyphen, namely "Virtual Host - Hyper-V".
This is important because when we extract this data and perform external lookups, they don't work.
Can you fix this documentation error, please?
Thanks!
Pete.
Thank you for pointing this out, Peter!
We have updated the documentation.
Regards,
Manisha
On the System Type list, the Entity Type name for entry 41 "vhc:hv" is listed as "Virtual Cluster - Microsoft HyperV", however in our HCO system it is actually listed as "Virtual Cluster - Hyper-V" i.e. the term "Microsoft" is not part of the name.
Can you please review this and fix this documentation, if this is a documentation error? Thanks.
Thank you for brining this to our attention, Peter!
I have updated the entry 41 as 'Virtual Cluster - Hyper-V' and also added an additional hyphen for all Hyper-V system types as indicated in the product.
Regards,
Manisha
Hello,
Why have you deleted the entypeid from this page? was very useful...could you include again this information?
Regards, Javier
Hi Javier,
Thanks for bringing this to our attention. We have added the missing column back.
Regards,
Manisha
Log in or register to comment.