CI Class Interface

Inheritance diagram for Interface

Summary

Display Name	Interface
Name	interface
Description	Describes a logical interface (Note: This is NOT a physical interface card) that supports various data link layer and other higher layer protocols such as tunnels, mpls, frame, atm etc.

Attributes

Attributes defined for Interface
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	interface		true	false	true
gateways	InterfaceGateways	string_list[500]		This is the description on the network interface as reported by the device. This is not a user specified description.	true	false	false
interface_admin_status	AdminStatus	interfaceindex_status_enum			true	false	false
interface_alias	InterfaceAlias	string[256]		This is an alias string set up for the network interface by network device administrators. The alias is a more descriptive name for the interface and is well understood by the network administrators.	true	false	false
interface_description	InterfaceDescription	string[500]		This is the description on the network interface as reported by the device. This is not a user specified description.	true	false	false
interface_index	InterfaceIndex	integer		The index of the network interface. A node will have many interfaces and each interface has an index value which is unique on that node. Some types of devices tend to reindex themselves upon a reboot even though there are no configuration or other changes on those interfaces. This means the same interface will have a different index after a reboot.	true	false	false
~~interface_macaddr~~	~~Interface MAC Address~~	string[50]		The interfaces address at its protocol sub-layer. The interfaces media-specific MIB must define the bit and byte ordering and format of the value contained by this object. we get the macaddress from the mib tree by mibAddress : 1.3.6.1.2.1.2.2.1.6	true	false	true
interface_name	InterfaceName	string[256]		This attribute is the name automatically assigned by a device to a network interface. Sometimes it is unique per device and sometimes not. It depends upon the device type.	true	false	false
interface_nnm_internal_key	Interface NNM Internal Key	string[100]		Interface primary key in NNMi Database join with NNMi server IP. Only for uCMDB internal use	true	false	true
interface_operational_status	OperationalStatus	interfaceindex_status_enum			true	false	false
interface_role	InterfaceRole	string_list		The roles available in an Interface.	true	false	false
interface_speed	InterfaceSpeed	long		The configured speed of a network interface. The speed value is in bits per second.	true	false	false
interface_type	InterfaceType	interfaceindex_type_enum[256]		The type of the protocol running on an interface.	true	false	false
is_system_internal	System Internal	boolean_type_enum	0	Designates if interface has outer visibility from the host or is one of a special type for internal purposes	true	false	false
isPseudo	Is Pseudo Interface	boolean	false	An Interface with duplicate MAC or null MAC(to be used by NNM integration)	true	false	false
l2help	l2help	date	2006.01.16 16:36:06:562		true	false	true
mac_address	MacAddress	string[80]		Represents the entities MAC address.In computer networking, a Media Access Control address (MAC address) is a unique identifier assigned to most network adapters or network interface cards (NICs) by the manufacturer for identification, and used in the Media Access Control protocol sublayer.	true	false	false
matching_rules		string_list			true	false	true
primary_wins	PrimaryWINS	string[256]		The primary Windows Internet Naming Service (WINS) address	true	false	false
secondary_wins	SecondaryWINS	string[256]		The secondary WINS address	true	false	false
Attributes defined for NodeElement
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	hostresource		true	false	true
classification		classification_enum	infrastructure		true	false	false
FAMILY_ICON		string	hostresource		true	false	true
isvirtual	Is Virtual	boolean	false	indicates whether resource is virtual	true	false	false
layer		layer_enum	infrastructure		true	false	false
serial_number	SerialNumber	string[100]		A manufacturer specified serial number or unique ID for a product or element	true	false	false
Attributes defined for InfrastructureElement
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	system		true	false	true
codepage	CodePage	string[50]		System suported CodePage	true	false	true
credentials_id	Reference to the credentials dictionary entry	string		Reference to the credentials dictinary entry	true	false	true
language	Language	string[50]		System suported language	true	false	true
Attributes defined for ConfigurationItem
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
ack_cleared_time		long			true	false	true
ack_id		string[80]			true	false	true
BODY_ICON		string	it_world		true	false	true
~~city~~	~~City~~	string[50]		City location	true	false	true
classification		classification_enum			true	false	false
contextmenu	Context Menu	string_list[100]		Context menu	true	false	true
~~country~~	~~Country or Province~~	string[50]		Country or province location	true	false	true
is_save_persistency	Store KPI History For Over Time Reports	boolean	false	Store KPI history for over time reports	true	false	true
layer		layer_enum			true	false	false
~~state~~	~~State~~	string[50]		State location	true	false	true
track_changes	Track Configuration Changes	boolean	false	Track configuration changes	true	false	true
Attributes defined for Managed Object
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
TenantOwner	Owner Tenant	string[32]		The Tenant Owner ID	true	false	false
TenantsUses	Consumer Tenants	string_list		The IDs of the Tenants who are associated with the CI	true	false	false
Attributes defined for Object
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
document_list	Documents	string		Documents	true	false	true
MENU		xml			true	false	true
Attributes defined for Data
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
~~data_adminstate~~	~~Admin State~~	adminstates_enum	0	Admin State	true	false	true
data_allow_auto_discovery	Allow CI Update	boolean[250]	true		true	false	false
~~data_changecorrstate~~	~~Change Corr State~~	changestates_enum	0	Change State	true	false	true
~~data_changeisnew~~	~~Change Is New~~	boolean	false	Change State	true	false	true
~~data_changestate~~	~~Change State~~	changestates_enum	0	Change State	true	false	true
data_externalid	External ID	string[50]		external source id: snmp index, data sources index etc.	true	false	true
data_note	Note	string[250]			true	false	false
~~data_operationcorrstate~~	~~Operation Corr State~~	operationstates_enum	0	Operation State	true	false	true
~~data_operationisnew~~	~~Operation Is New~~	boolean	false	Operation State	true	false	true
~~data_operationstate~~	~~Operation State~~	operationstates_enum	0	Operation State	true	false	true
data_origin	Origin	string[100]			true	false	false
data_source	Created By	string[512]			true	false	false
~~data_testcorrstate~~	~~Test Corr State~~	teststates_enum	0	Test State	true	false	true
~~data_testisnew~~	~~Test Is New~~	boolean	false	Test State	true	false	true
~~data_teststate~~	~~Test State~~	teststates_enum	0	Test State	true	false	true
data_updated_by	Updated By	string[512]			true	false	false
description	Description	string[1000]		Description	true	false	false
digest	Digest	string[40]			true	false	true
display_label	Display Label	string[900]		Used as calc attribute for display	true	false	false
MENU		xml			true	false	true
name	Name	string[900]			true	false	false
user_label	User Label	string[900]		Used as user label	true	false	false
Attributes defined for Root
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	general		true	false	true
calculated_id	Calculated ID	bytes[16]		Calculated ID	true	false	true
create_time	Create Time	date		When was this CI created	true	false	false
FAMILY_ICON		string			true	false	true
global_id	Global Id	string[32]		A globally unique identifier for the entity represented by the object	true	false	false
global_id_scope		string	Default		true	false	true
last_modified_time	LastModifiedTime	date		When was this CI last updated	true	false	false
root_actualdeletetime	Actual Delete Time	date		When will this CI be deleted	true	false	true
root_actualdeletionperiod	Actual Deletion Period	integer	40	What is the period after the CI will be deleted	true	false	false
root_candidatefordeletetime	Candidate For Deletion Time	date		When will this CI be warned about deleting	true	false	true
root_class	CI Type	string[100]		Class name of the CI	true	false	true
root_container	Container	string[32]		Container CI of this CI	true	false	false
root_deletioncandidateperiod	Deletion Candidate Period	integer	20	What is the period after the CI will be candidate for delete	true	false	false
root_enableageing	Enable Aging	boolean	false	Is aging enabled	true	false	false
root_iconproperties		string[100]			true	false	true
root_iscandidatefordeletion	Is Candidate For Deletion	boolean	false	Is candidate for deletion	true	false	false
root_lastaccesstime	Last Access Time	date		When was this CI last accessed	true	false	false
~~root_system~~	~~System~~	string[2]			true	false	true

Valid Relations

Valid direct incoming and outgoing relations defined on Interface

Relations defined for Interface
From	To	Type	Description
Interface	Azure Network Interface	Realization	This link represents an element being realized by some other element.
Interface	Citrix Network	Usage	Monitor system Relationships
Interface	Interface	Layer 2	the layertwo links are links discovered by the discover layer 2 service. the link represent a connection between switche to host (physical connection)
Interface	Interface	Membership
Interface	Interface	Realization	This link represents an element being realized by some other element.
Interface	Interface	USB
Interface	IpAddress	Containment
Interface	PhysicalPort	Layer 2	the layertwo links are links discovered by the discover layer 2 service. the link represent a connection between switche to host (physical connection)
Interface	SEA Adapter	Usage	Monitor system Relationships
Interface	VMware Port Group	Usage	Monitor system Relationships
Bridge	Interface	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
Bridge	Interface	Containment
Citrix Network	Interface	Usage	Monitor system Relationships
Interface Aggregation	Interface	Membership
Interface Index	Interface	Parent
I/O Chassis	Interface	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
I/O Slot	Interface	Containment
IpAddress	Interface	Parent
IPMP Group	Interface	Membership
Layer2Connection	Interface	Membership
Network Adapter	Interface	Realization	This link represents an element being realized by some other element.
Node	Interface	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
Node	Interface	Containment
Node	Interface	Usage	Monitor system Relationships
OpenStack Network	Interface	Membership
PhysicalPort	Interface	Realization	This link represents an element being realized by some other element.
SEA Adapter	Interface	Usage	Monitor system Relationships
VMware Port Group	Interface	Usage	Monitor system Relationships
VMware Uplink	Interface	Usage	Monitor system Relationships
Relations defined for NodeElement
From	To	Type	Description
Node	NodeElement	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
RunningSoftware	NodeElement	Usage	Monitor system Relationships
Storage Array	NodeElement	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
Relations defined for InfrastructureElement
From	To	Type	Description
BusinessActivity	InfrastructureElement	Usage	Monitor system Relationships
BusinessApplication	InfrastructureElement	Containment
BusinessApplication	InfrastructureElement	Usage	Monitor system Relationships
BusinessElement	InfrastructureElement	Usage	Monitor system Relationships
BusinessTransaction	InfrastructureElement	Usage	Monitor system Relationships
CiCollection	InfrastructureElement	Usage	Monitor system Relationships
ClusterResourceConfig	InfrastructureElement	Dependency	represents a dependency between 2 objects
Service	InfrastructureElement	Containment
Service	InfrastructureElement	Usage	Monitor system Relationships
Relations defined for ConfigurationItem
From	To	Type	Description
ConfigurationItem	Automation Flow Execution	Includes	This relationship connects two CIs, one of which is included into another. A child CI can be moved to another parent, but when the parent is deleted, the child will be deleted as well, except if a second includes link exist on it already. Moving of a child CI possible by creation of new link to another parent and deletion of the first one.
ConfigurationItem	ConfigurationItem	ConsumerProvider
ConfigurationItem	Kpi	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItem	Outage	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItem	PolicyResult	Aggregation
ConfigurationItem	ScheduledDowntime	Connection
ConfigurationItem	ServiceConnectionPoint	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItem	ServiceConnectionPoint	Ownership
DefectsFilter	ConfigurationItem	Containment
ApplicationSystem	ConfigurationItem	Aggregation
Asset	ConfigurationItem	Connection
CiCollection	ConfigurationItem	Containment
CiCollection	ConfigurationItem	Membership
ItProcessRecord	ConfigurationItem	Connection
ItProcessRecord	ConfigurationItem	Membership
Location	ConfigurationItem	Membership
Tenant	ConfigurationItem	Connection
Relations defined for Managed Object
From	To	Type	Description
Managed Object	History Change	History Link
Tenant	Managed Object	Connection

Combined inheritance and relation diagram for Interface

Potential Data Providers

Adapters providing CIs of type Interface
Adapter Name	Description	Adapter Type
AS400_NET_Dis_Connection	Connects to the AS400 Server using the JT400 Toolbox	Discovery
Azure by WebServices	This adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenant	Discovery
CiscoWorks Layer 2	This adapter populates nodes layer two infrastructure from the Cisco Works Campus Manager database	Integration
CiscoWorks NetDevices	This adapter populates network devices and layer two infrastructure from the Cisco Works Resource Manager Essentials database	Integration
Cisco Prime by WebServices	This adapter discovers nodes, interfaces, net devices, and layer2 connections on a Cisco Prime.	Discovery
HP Network Automation by Java	HP Network Automation by Java	Integration
Host Connection by Shell	Establishes a Shell connection to the remote machines. Discovery tries to connect to remote machines through the SSH, Telnet, NTCMD or UDA protocols until the first valid connection is found.	Discovery
IBM Virtualization by Shell	Discovery adapter for IBM HMC or IVM Software and related Virtualization PSeries Solution discovery	Discovery
IBM LPar And VIO Server by Shell	Adapter for Discovery of IBM VIO Server or any IBM LPar running system	Discovery
IBM WPar by Shell	Adapter for Discovery of IBM WPar topology	Discovery
Oracle VM Server for SPARC Technology by Shell	Adapter discovers LDOM topology via control domain.	Discovery
LPAR Resources by EView	This adapter discovers the IBM mainframe z/OS host and network resources using the EView mainframe agent	Discovery
Layer2 Topology by Shell	Reports Layer2 and networking related data by ssh or shell from network switches	Discovery
Connection by NTCMD or UDA protocol	Try to connect to a WIN server using HPCmd (NetBIOS) or UD Agent.	Discovery
NetApp_Filer_by_WebServices	This adapter discovers volumes, shares and other details on a NetApp filer	Discovery
OS Fingerprint	This adapter discovers hosts, IPs, open TCP and UDP ports and host operating systems using nmap.exe.	Discovery
OpenStack Event Monitor	OpenStack Event Monitor	Discovery
OpenStack by WebServices	This adapter discovers projects, compute resources, networks, storage and other details on an OpenStack	Discovery
Host Connection by PowerShell	This adapter discovers PowerShell agents by trying to connect to a Windows machine using the PowerShell protocol.	Discovery
Process Linux Servers With Duplicated Macs	This adapter is acting as a port processing logic after the "Layer2 Vlan based by SNMP" Job has run.	Discovery
Systems Insight Manager	Populates servers and other devices from an HP SIM (Systems Insight Manager) server	Integration
CDP/LLDP neighbors layer 2 devices by SNMP	This adapter discovers Layer 2 neighbors network devices	Discovery
L2 Bridge by SNMP	This adapter discovers the Layer 2 topology of a switch by SNMP.	Discovery
L2 Vlan by SNMP	This adapter discovers the Layer 2 topology of a specific VLAN by SNMP.	Discovery
Host Connection by SNMP	Discovers SNMP agents by trying to connect to a data center machine using the SNMP protocol, updates the node class (Windows, UNIX, router, and so on) according to the relevant OID	Discovery
Client Connection by SNMP	Discovers SNMP agents by trying to connect to a client machine using the SNMP protocol, updates the node class (Windows, UNIX, router, and so on) according to the relevant OID.	Discovery
Host Networking by SNMP	Discovers host networking topology using SNMP route and system tables	Discovery
Router ARP by SNMP	This adapter discovers the ARP table of a router using the SNMP protocol. This discovery reveals IP addresses by querying the protocol that translates IPs into the Ethernet addresses used by local area networks, as well as the host and network it belongs to.	Discovery
Solaris Zone by TTY	This adapter discovers Solaris Zones by shell protocols (SSH, Telnet or UDA) including non-global zones, resource pools, netwroking CPU and their dependencies.	Discovery
Sun_Cluster_by_Shell	adapter discovers Sun Cluster topology via shell including cluster nodes, resource groups and resources, quorum configuration, cluster interconnect.	Discovery
TTY_HACMP_Applications	Discovers IBM HACMP virtual applications	Discovery
TTY_HACMP_Topology	Discovers IBM HACMP node Topology on servers via SSH, Telnet or UDA	Discovery
TTY_Net_Dis_Connection	This adapter discovers SSH and Telnet agents by trying to connect to a machine using TTY as well as updating the correct host class (Windows, UNIX, router, and so on).	Discovery
VMware ESX Connection by CIM	VMware ESX Connection by CIM adapter	Discovery
VMware ESX Topology by VIM	This adapter discovers VMware ESX Servers using VIM protocol.	Discovery
VMware VMotion by VIM	adapter monitors migration events of Virtual Machines from one host to another.	Discovery
VMware vCenter Topology by VIM	Adapter collects Virtual Infrastructure topology information using vCenter Server by VI Management protocol.	Discovery
Host Connection by WMI	This adapter discovers WMI agents by trying to connect to a Windows machine using the WMI protocol.	Discovery
Xen and KVM by Shell Adapter	KVM and Xen discovery adapter based on libvirt cli	Discovery
HP nPartitions by Shell	This adapter discovers HP partitionable server (either cell-based or not) topology by connecting to the vPar or nPar	Discovery
Hyper-V Topology by Shell	adapter discovers Microsoft Hyper-V virtualization topology using shell protocol.	Discovery
Hyper-V Topology by WMI	adapter discovers Microsoft Hyper-V virtualization topology using WMI protocol.	Discovery
iSeries Resources by EView	This adapter discovers the IBM ISeries Resources on the on an Iseries box such as CPUs , Memory, Disks, Network Controllers, Installed Software.	Discovery
PureFlex Discovery Adapter	Allows to discover IBM FSM managed resources and topology	Discovery
Oracle VM Manager Discovery By MainCli	Make discovery of virtualization inventory using manager's main CLI accessible by SSH protocol	Discovery
Process Layer2 Collected Files	Adapter Description	Discovery
vCloud Event Monitor	vCloud Event Monitor	Discovery
vCloud Director URL by vCloud API	Adapter discovers VMware vCloud Director using direct connection URL by vCloud API	Discovery
vCloud Director by vCloud API	Adapter discovers VMware vCloud Director using vCloud API	Discovery
Adapters providing CIs of type ConfigurationItem
Adapter Name	Description	Adapter Type
Import from CSV	Imports data from a CSV file into CMDB using mapping of the CSV file columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the CSV file columns. Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter.	Integration
Import from DB	Imports data from an external database into CMDB using mapping of table columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the table columns Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter. A SQL 'select' query is generated automatically and selects all columns in specified table, which defined by parameter: tableName In advanced cases you can specify custom SQL query.	Integration
Import from properties file	Imports data from a Properties file into CMDB, using mapping of the CSV file columns to CIT attributes This mapping is usually defined by the setting adapter parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the Properties attributes to the CSV file columns In cases you need more complex mapping abilities, such as conversion of the strings contained in Properties file to the appropriate type of CMDB object's attribute, you should use the mapping XML configuration file specified by the mappingFile parameter.	Integration
Import from Excel Workbook	Imports data from Excel Workbooks. Parses through multiple worksheet XLS files. Uses 'CIImports.xls' (default) file to import data.	Integration
Adapters providing CIs of type Object
Adapter Name	Description	Adapter Type
ALMAdapter	Federate defects from ALM	Integration
APM Push Adapter	This adapter pushes data from UCMDB to HP APM. Follow the APM Push Adapter documentation included in the HP UCMDB Discovery and Integration Content Guide before creating this integration point.	Integration
UCMDB API Population	Allows defining Reconciliation Priority for API Data In flows	Integration
Data Push into Atrium	Pushes CIs and relationships to BMC Atrium	Integration
AutomationFlowAdapter	Provide API to Operation Orchestration	Integration
BSMKpiAdapter	Federate KPIs from BSM	Integration
CM1030KpiAdapter	Federate KPIs from CM	Integration
CM1030PolicyAdapter	Federate Policies and their results from CM	Integration
CA CMDB	Pushes CIs and relationships to CA CMDB	Integration
UCMDB 10.x	Used for Populating and Federating data from a remote UCMDB 10.x server and for Pushing to a remote UCMDB 10.x	Integration
UCMDB 9.x	Used for Populating and Federating data from a remote UCMDB 9.x server and for Pushing to a remote UCMDB 9.x	Integration
UCMDB History Adapter [local instance only]	Used to federated data from the UCMDB's History	Integration
ConvertXMLtoOSVH	Discovery Pattern Description	Discovery
Push Adapter DB Example	Push data into Oracle \ MSSQL database	Integration
DDMi	Uses the GDB-Framework to Populate and Federate data from a DDMi database	Integration
EnterpriseViewAdapter	Federate KPIs from Enterprise View	Integration
GenericDBAdapter	An example Adapter that uses the GDB-Framework	Integration
Java_Adapter_Template	Adapter Description	Integration
Local State Push Adapter	Used for populating data between the states of the same UCMDB Server	Integration
Push Adapter	Push Adapter	Integration
Remedyforce Push Integration	Remedyforce Push Integration	Integration
Service Anywhere Push Adapter	This adapter pushes data from UCMDB to Service Anywhere.	Integration
System Center Configuration Manager	Uses the GDB-Framework to Populate and Federate data from a System Center Configuration Manager. The adapter is also backward compatible with the SMS DB	Integration
Service Center 6.2x	Used for Federating from ServiceCenter version 6.2x	Integration
Service Manager 7.0x	Used for Federating from ServiceManager version 7.0x	Integration
Service Manager 7.1x - 9.2x	Used for Pushing data to and Federating from ServiceManager versions 7.1x to 9.2x	Integration
Service Manager 9.41	Discovery Pattern Description	Integration
Service Manager 9.xx	Discovery Pattern Description	Integration
Service Manager Enhanced Generic Adapter	Push and Populate CI data between UCMDB and Service Manager	Integration
Service Manager Enhanced Generic Adapter	Push and Populate CI data between UCMDB and Service Manager	Integration
ServiceNow Enhanced Generic Adapter	Push, Populate and Federation of CI data between UCMDB and ServiceNow	Integration
Service-Now Push	Adapter to push data from uCMDB to Service-Now.com	Integration
Data Push into Troux	Push CIs to Troux	Integration
Executive Scorecard	Discovery Pattern Description	Integration
UCMDB to XML	Export data into XML from UCMDB	Integration