Entity types

The Topology Service allows you to group together resources of the same type using the entityTypes property, and identify them in the UI by their icon. Usually a resource has only a single entity type, however, as the property is a Set, it is possible for a resource to have more than one entity type. A number of pre-defined entity types are supplied, which are listed in this topic. In addition, you can create additional entity types as required.

Pre-defined entity types

You can access the Swagger documentation for 'entity types' currently in use at the following default link: http://localhost/1.0/topology/swagger#!/Schema/getTypes

An entity type is used to map the resource vertex to an icon, and it also allows for more efficient searching via the _type query parameter, which can be found in the Swagger documentation at the following default location: http://localhost/1.0/topology/swagger/#!/Resources/getResourceList

Remember: An administrator user can create additional custom resource or entity types as required. Any observer may add new types.

Note: The topology service API only returns the resource or entity types in use.

The following table lists these entity types with links to their icons, if defined.

Table 1. Predefined entity types and icons, where defined
Entity type	Icon
aircond
alarm
application
backplane
bridge
building
bypass
card
cell
channel
chassis
circuit
cluster
command
component
computer
container
cpu
credential
daemonset
database
datacenter
deployment
device
directory
disk
domain
emailaddress
environment
event
fan
file
firewall
flavor
forum
fqdn
gauge
group
host
hsrp
hub
image
input
ipaddress
ipam
loadbalancer
location
memory
message
namespace
network
networkaddress
networkgear
networkinterface
operatingsystem
organization
outlet
output
patch
path
pdu
peripherals
person
pod
printer
process
product
project
psu
resource
router
routetable
routetarget
rsm
rule
sector
securitygroup
sensor
server
service
serviceaccesspoint
slot
snmpsystem
stack
statefulset
status
storage
subnet
subscription
switch
swarm
task
tcpudpport
template
tenant
tier
tool
ups
variable
version
vlan
vm
volume
vpn
vrf
workload

Schema REST API

The Topology Service has an API call which will allow you to see all the instantiated entity types in a given topology. The default Swagger location is: http://localhost/1.0/topology/swagger/#!/Schema/getTypes

Important: To retrieve the type name, you must add the _field=name query parameter.