CI Class IpSubnet

Inheritance diagram for IpSubnet

Summary

Display Name	IpSubnet
Name	ip_subnet
Description	This class represents an IP subnet in a network. The network could be an IPv4 or an IPv6 network. An instance of this class will exists for each IP subnet in a routing domain.

Attributes

Attributes defined for IpSubnet
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	network		true	false	true
ip_address_type	IpAddressType	ip_address_type_enum	IPv4	The type of the IP Address (e.g. IPv4, IPv6)	true	false	false
ip_address_value	IpAddressValue	string		This represents the value of an IPv4 or IPv6 address. Both IPv6 and IPv4 address values are kept in an IPv6 address format. IPv4 addresses are mapped to IPv6 address format as as per the guidelines in http://www.ietf.org/rfc/rfc4291.txt. Examples: * ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 *Note: The Ipv6 addresses are fully specified, simplification rules (like omitting leading zeros or dropping parts of the address by using '::' will not be applied).	true	false	false
ip_prefix_length	IpPrefixLength	integer		The prefix length is the number of contiguous bits that are turned on in any IP address be it a subnet address or just an IP address.	true	false	false
network_broadcastaddress	Network Broadcast Address	string[50]		Network Broadcast Address	true	false	false
network_count	Network Count	integer		Network count of membered ips	true	false	false
network_ismanaged	Is Managed	boolean	true	Is Managed By Auto Discovery?	true	false	false
network_managed	Network Managed	boolean		Managed by the user	true	false	false
network_netclass	Network Class	string[10]		The class of the network by the net mask (a,b,c)	true	false	false
network_netmask	Network Mask	string[50]		The value of the mask is an IP address with all the network bits set to 1 and all the hosts bits set to 0.	true	false	false
network_nettype	Network Type	network_nettype_enum		The type ot the network	true	false	false
network_probename	Network Probe Name	string[50]		The Name of the Probe which created the Netwrok object	true	false	false
routing_domain	RoutingDomain	string[50]	${DefaultDomain}	This is a continuous region of an IP network within which routing is possible without any intervening Network Address Translation (NAT) devices. The literal "$DefaultDomain" should be used if the routing domain is unknown, unspecified, or known to be the default domain.	true	false	false
service_delegations	Service Delegations	string[255]		Populated for Azure Subnets,with a list of PaaS Service types that need to be injected into the network. [Azure Collection] mapped from json[properties][delegations][name]	true	false	false
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
ci_lifecycle_state	CI Lifecycle State	lifecycle_state_enum		The attribute indicates the overall Lifecycle state of a CI when using enhanced lifecycle solution	true	false	false
~~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
monitor_state	Monitor State	string[50]		Monitor State of a CI in OpsB. The attribute is owned by OpsB exclusively.	true	false	false
provision_state	Provision State	string[50]		Provision State of a CI in HCMX. The attribute is owned by HCMX exclusively.	true	false	false
regulatory_details	Regulatory Details	string[1000]		[Summary]This attribute is used by DCA, it represents the regulatory details. [Collection]The value is pushed by DCA via CMSGateway	true	false	false
regulatory_status	Regulatory Status	regulatory_status_enum		[Summary]This attribute is used by DCA, it represents the regulatory status. [Collection]The value is pushed by DCA via CMSGateway	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
vulnerability_details	Vulnerability Details	string[1000]		[Summary]This attribute is used by DCA, it represents the vulnerability details. [Collection]The value is pushed by DCA via CMSGateway	true	false	false
vulnerability_status	Vulnerability Status	vulnerability_status_enum		[Summary]This attribute is used by DCA, it represents the vulnerability status. [Collection]The value is pushed by DCA via CMSGateway	true	false	false
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[300]		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 IpSubnet

Relations defined for IpSubnet
From	To	Type	Description
IpSubnet	Azure App Service Environment	Membership
IpSubnet	Azure Network Security Group	Dependency	represents a dependency between 2 objects
IpSubnet	Azure Private Endpoint	Dependency	represents a dependency between 2 objects
IpSubnet	Azure Route Table	Dependency	represents a dependency between 2 objects
IpSubnet	Azure Subnet	Realization	This link represents an element being realized by some other element.
IpSubnet	Interface	Membership
IpSubnet	IpAddress	Membership
IpSubnet	Node	Membership
ActiveDirectorySite	IpSubnet	Membership
Amazon Account	IpSubnet	Containment
Amazon EFS Mount Target	IpSubnet	Usage	Monitor system Relationships
Amazon NAT Gateway	IpSubnet	Membership
Amazon Network Acl	IpSubnet	Containment
Amazon Route 53 Resolver Endpoint	IpSubnet	Dependency	represents a dependency between 2 objects
Amazon Route Table	IpSubnet	Dependency	represents a dependency between 2 objects
Amazon Stack	IpSubnet	Containment
Amazon Transit Gateway VPC Attachment	IpSubnet	Usage	Monitor system Relationships
Amazon Virtual Private Cloud	IpSubnet	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
Azure Application Gateway	IpSubnet	Containment
Azure Data Lake Storage Gen1	IpSubnet	Usage	Monitor system Relationships
Azure IP Configuration	IpSubnet	Usage	Monitor system Relationships
Azure MySQL Single Server	IpSubnet	Usage	Monitor system Relationships
Azure NAT Gateway	IpSubnet	Usage	Monitor system Relationships
Azure PostgreSQL Flexible Server	IpSubnet	Usage	Monitor system Relationships
Azure PostgreSQL Single Server	IpSubnet	Usage	Monitor system Relationships
Azure SQL Managed Instance	IpSubnet	Usage	Monitor system Relationships
Azure Virtual Network	IpSubnet	Containment
Azure Virtual Network Gateway	IpSubnet	Usage	Monitor system Relationships
Firewall	IpSubnet	Route	thr route links are links discovered by the discover route collector. this link represent a row data from the route table in the mib containing the data of the next_hop ip address and the destination network address. the route table is in the mib address : table is in the mib address : 1.3.6.1.2.1.4.21.1.7
Kubernetes Cluster	IpSubnet	Dependency	represents a dependency between 2 objects
Kubernetes Cluster Network	IpSubnet	Membership
SG Package	IpSubnet	Dependency	represents a dependency between 2 objects
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	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
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 IpSubnet

Potential Data Providers

Adapters providing CIs of type IpSubnet
Adapter Name	Description	Adapter Type
AS400_NET_Dis_Connection	Connects to the AS400 Server using the JT400 Toolbox	Discovery
AWS Event Based Discovery	Discovers AWS topologies by using the AWS SDK for Java to access AWS SQS service.	Discovery
AWS Event Based Discovery using Tags	Read AWS messages from local DB using tags as filter and report the changes of AWS resources to UCMDB.	Discovery
AWS Discovery for HCM via API	Discovers AWS topologies of the EC2 services using Web Services	Discovery
AWS by Web Services	Discovers AWS topologies using the Amazon Web Services.	Discovery
AWS by Web Services using Tags	Discovers AWS resources with customized tags	Discovery
ArpCache Connection by SNMP (deprecated)	Discovers SNMP agents by trying to connect to a client machine using the SNMP protocol and reports node class relationship with ArpCache class according to the relevant OID.	Discovery
Discovery for Opsb integration by shell	Establishes a Shell connection to the remote machines. Discovery tries to connect to remote machines through the SSH, NTCMD protocols until the first valid connection is found.	Discovery
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 WPar by Shell	Adapter for Discovery of IBM WPar topology	Discovery
IP ping sweep	Performs IP ping sweep	Discovery
LDAP Active Directory Topology	Discovers Active Directory via LDAP	Discovery
Connection by NTCMD or UDA protocol	Try to connect to a WIN server using HPCmd (NetBIOS) or UD Agent.	Discovery
OpenShift by REST API	This adapter collects Virtual Infrastructure topology information using OpenShift by REST API.	Discovery
Host Connection by PowerShell	This adapter discovers PowerShell agents by trying to connect to a Windows machine using the PowerShell protocol.	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 (deprecated)	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 (deprecated)	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
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
Host Connection by WMI	This adapter discovers WMI agents by trying to connect to a Windows machine using the WMI protocol.	Discovery
AWS via AWS Config	Discovers AWS topologies via AWS Config	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
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
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
APM Push Adapter	This adapter pushes data from UCMDB to APM. Follow the APM Push Adapter documentation included in the 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
CA CMDB (deprecated)	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 (deprecated)	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 SaaS CMS	Integration
Push Adapter DB Example	Push data into Oracle \ MSSQL database	Integration
GenericDBAdapter	An example Adapter that uses the GDB-Framework	Integration
Java_Adapter_Template	Adapter Description	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 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