CI Class Vlan

Inheritance diagram for Vlan

Summary

Display Name	Vlan
Name	vlan
Description	This class represents one instance of a Local Area Network logical broadcast domain set up across LAN switches. This logical domain is also called a virtual LAN or Vlan in short. Vlans provide some level of traffic isolation. Switches in a Vlan will forward frames over ports in the same vlan. There could be many Vlans that exist in a physical LAN with interconnected LAN switches.

Attributes

Attributes defined for Vlan
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
local_vlan_name	Local VLAN Name	string[900]		The local name of VLAN. Discovered from VLAN Ports using getLocalNameForVLANPort method in NmsVLAN Bean Service	true	false	false
vlan_aliasname	VLAN Name	string[50]		Can be used for ELAN name	true	false	false
vlan_bridgemac	VLAN Bridge MAC	string[50]			true	false	false
vlan_id	VlanId	integer		This is a number given to a VLAN by a network engineer or administrator. The ID helps LAN switches isolate traffic to certain segments of the network. The id is assigned to switch ports by network administrator. In some environments, the ID is automatically discovered as well.	true	false	false
vlan_unique_id	VLAN Unique ID	string[100]			true	false	true
Attributes defined for NetworkEntity
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	networkresource		true	false	true
classification		classification_enum	network		true	false	false
cloud_resource_identifier	Cloud Resource Identifier	string[300]		Used as unique identifier for all cloud resource	true	false	false
FAMILY_ICON		string	network		true	false	true
isvirtual	Is Virtual	boolean	false		true	false	false
layer		layer_enum	infrastructure		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
zone_list	Zone List	string_list[256]		List of management zones in which the CI is discovered	true	false	false
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
bit_position	Bit Position	integer			true	false	true
bitmap_id	Bitmap ID	integer			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
data_tags	Tags	json[4000]		A tag is a label assigned to a resource.Each tag consists of a key and a value.	true	false	false
discovery_state	Discovery State	discovery_state_enum		State of UD discovery	true	false	false
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
metaphase	Meta Phase	string[50]		Meta Phase of a CI in SMAX. The attribute is owned by SMAX exclusively	true	false	false
sd_type	SD Type	string[32]			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	LastModifiedBy	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	Created 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_discovered_by	LastDiscoveredBy	string[512]		Who discovered this CI	true	false	false
last_discovered_by_probe	LastDiscoveredByProbe	string		Which probe discovered this CI	true	false	false
last_discovered_time	LastDiscoveredTime	date		When was this CI discovered	true	false	false
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 Vlan

Relations defined for Vlan
From	To	Type	Description
Vlan	Bridge	Dependency	represents a dependency between 2 objects
Vlan	ELAN	ELAN-VLAN Map
Vlan	PhysicalPort	Membership
IBM Frame	Vlan	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
PhysicalPort	Vlan	Membership
Router	Vlan	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
Switch	Vlan	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 Vlan

Potential Data Providers

Adapters providing CIs of type Vlan
Adapter Name	Description	Adapter Type
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
Network Automation by Java	Network Automation by Java	Integration
IBM Virtualization by Shell	Discovery adapter for IBM HMC or IVM Software and related Virtualization PSeries Solution discovery	Discovery
Merge VLANs	Used to create links between VLAN and physical ports across different switches in case the corresponding interfaces have connectivity. Connectivity between interfaces is determined based on the Layer2Connection CI presence.	Discovery
Population from NNMi	Connects to the NNMi web service and populates NNMi discovered nodes, IPs, networks, interfaces and layer two connection information to create a Layer 2 topology in UCMDB. Note that it is recommended NOT to run the UCMDB Layer 2 discoveries if using NNMi Layer 2 integration discovery.	Integration
Catalist Vlans by SNMP	This adapter discovers VLANs on a switch by SNMP.	Discovery
VMS Catalyst by SNMP	Discovers the physical ports on a VLAN	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
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
SCCM Installed Software Integration	This adapter queries the records from SCCM database and recognizes it as install software by UD SAI	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
AMGenericAdapter	This adapter pushes/populates data between UCMDB and Asset Manager. Follow the Quick Start guide supplied with the AM Generic Adapter documentation before creating this integration point.	Integration
Application Portfolio Management Push Adapter	This adapter pushes data from UCMDB to HP Application Portfolio Management. 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
CA CMDB	Pushes CIs and relationships to CA CMDB	Integration
UCMDB 10.x and later	Used for Populating and Federating data from a remote UCMDB 10.x(or later) and for Pushing to a remote UCMDB 10.x(or later)	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
UCMDB to SaaS	Used for Pushing CIs and Relationships from an on-premises UCMDB 2019.02(or later) to Micro Focus SaaS CMS	Integration
Push Adapter DB Example	Push data into Oracle \ MSSQL database	Integration
GenericDBAdapter	An example Adapter that uses the GDB-Framework	Integration
IAM UI Push Adapter	Push IAM Universal Inventory data into MSSQL database on-premises or on cloud-based Azure.	Integration
Java_Adapter_Template	Adapter Description	Integration
Kafka Push Adapter 2019.05	Push function for Kafka Push Adapter	Integration
Local State Push Adapter	Used for populating data between the states of the same UCMDB Server	Integration
Pulsar Push Adapter	Push function for Pulsar Push Adapter	Integration
Push Adapter	Push Adapter	Integration
Remedyforce Push Integration	Remedyforce Push Integration	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 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
ServiceNow Enhanced Generic Adapter	Push, Populate and Federation of CI data between UCMDB and ServiceNow	Integration
UCMDB to XML	Export data into XML from UCMDB	Integration