Entity types

The Topology Service allows you to group resources of the same type that uses the entityTypes property, and identify them in the UI by their icon.

Usually a resource has only a single entity type, but, as the property is a Set, it is possible for a resource to have more than one entity type. Pre-defined associations of icons to specific entityTypes are listed in the following sections. You can create additional entity types as required.

  • An entityType is defined by defining a resource with that type in the entityTypes list field.
  • You can associate icons with named types in the Topology Viewer.
  • You can add custom icons.

Predefined entity types

An entity type is used to map the resource vertex to an icon.

Notes:

  • An administrator user can create more custom resource or entity types as required. Any observer may add new types.
  • The topology service API only returns the resource or entity types in use.

To assign an entityType

  1. Select a resource with the provided entityType in the Topology Viewer.
  2. Select the topology tools (the cog icon), then navigate to the resource types.
  3. Find the type to be edited, and select the icon to assign it. You can find an icon either by name from the dropdown list, or by using the View all icons option (the eye icon).

Entity type icons

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

Table. Entity type icons
Entity type Icon
aircond aircond icon
alarm alarm
application application icon
backplane backplane icon
bridge bridge icon
building building icon
bypass bypass icon
card card icon
cell cell icon
channel channel icon
chassis chassis icon
circuit circuit icon
cluster cluster icon
command command icon
component component icon
computer computer icon
container container icon
cpu cpu icon
credential credential icon
daemonset DaemonSet icon
database database icon
datacenter datacenter icon
deployment deployment icon
device device icon
directory directory icon
disk disk icon
domain domain icon
emailaddress email address icon
environment environment icon
event event icon
fan fan icon
file file icon
firewall firewall icon
flavor flavor icon
forum forum icon
fqdn fqdn icon
gauge gauge icon
group group icon
host host icon
hsrp Hot Standby Router Protocol (HRSP) icon
hub hub icon
image image icon
input input icon
ipaddress IP Address icon
ipam IP Address Management icon
loadbalancer load balancer icon
location location icon
memory memory icon
message message icon
namespace namespace icon
network network icon
networkaddress network address icon
networkgear network gear icon
networkinterface networkinterface icon
operatingsystem operating system icon
organization organization icon
outlet outlet icon
output output icon
patch patch icon
path path icon
pdu PDU icon
peripherals peripherals icon
person person icon
pod pod icon
printer printer icon
process process icon
product product icon
project project icon
psu PSU icon
resource resource icon
router router icon
routetable route table icon
routetarget route target icon
rsm rsm icon
rule rule icon
sector sector icon
securitygroup security group icon
sensor sensor icon
server server icon
service service icon
serviceaccesspoint serviceaccesspoint icon
slot slot icon
snmpsystem snmpsystem icon
stack stack icon
statefulset StatefulSet icon
status status icon
storage storage icon
subnet subnet icon
subscription subscription icon
switch switch icon
swarm swarm icon
task task icon
tcpudpport tcpudpport icon
template template icon
tenant tenant icon
tier tier icon
tool tool icon
ups ups icon
variable variable icon
version version icon
vlan vlan icon
vm vm icon
volume volume icon
vpn VPN icon
vrf vrf icon
workload workload icon