CI Class Location

Inheritance diagram for Location

Summary

Display NameLocation
Namelocation
DescriptionLocation of devices and business organizations/people that support a function (i.e. data center, company/client site). Can vary from country to city or low level like building or room. It can be connected to devices and logical CIs representing end users or data center location.

Attributes

Attributes defined for Location
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
classificationclassification_enumlocationtruefalsefalse
cloud_location_typeCloudLocationTypecloud_location_type_enumDescribes the type of Cloud location. Check the possible values in CloudLocationType enum.truefalsefalse
country_or_areaCountryOrAreastring[250]Represents the country or area name.truefalsefalse
extended_street_addressExtendedStreetAddressstring[250]Represents the extended street address (of address microformat) of a physical address. Can be for example "Suite 207".truefalsefalse
latitudeLatitudestring[250]Latitude of the geographical location.truefalsefalse
layerlayer_enumfacilitiestruefalsefalse
localityLocalitystring[250]Represents the locality (of address microformat) of a physical address. For example, it can be "San Francisco".truefalsefalse
location_bar_codeLocationBarCodestring[250]Locations that are rooms have a barcode (close to the door usually) that is used to do the inventory. If barcode scanning is not used for doing physical inventory, this attribute will then represent the ID of the room.truefalsefalse
location_typeLocationTypelocation_type_enumDescribes the type of physical location. This is an extensible enumeration with values as Building, Room, Floor, Site...etc.truefalsefalse
longitudeLongitudestring[250]Longitude of the geographical location.truefalsefalse
post_office_boxPostOfficeBoxstring[250]Represents the post office box (of address microformat) of a physical address.truefalsefalse
postal_codePostalCodestring[250]Represents the postal code (of address microformat) of a physical address. For example, it can be "94107".truefalsefalse
regionRegionstring[250]Represents the region (of address microformat) of a physical address. For example, it can be "CA" for USA California.truefalsefalse
street_addressStreetAddressstring[250]Represents the street address (of address microformat) of a physical address. For example, can be "665 3rd St."truefalsefalse
Attributes defined for ConfigurationItem
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
ack_cleared_timelongtruefalsetrue
ack_idstring[80]truefalsetrue
bit_positionBit Positionintegertruefalsetrue
bitmap_idBitmap IDintegertruefalsetrue
BODY_ICONstringit_worldtruefalsetrue
ci_lifecycle_stateCI Lifecycle Statelifecycle_state_enumThe attribute indicates the overall Lifecycle state of a CI when using enhanced lifecycle solutiontruefalsefalse
cityCitystring[50]City locationtruefalsetrue
classificationclassification_enumtruefalsefalse
contextmenuContext Menustring_list[100]Context menutruefalsetrue
countryCountry or Provincestring[50]Country or province locationtruefalsetrue
data_tagsTagsjson[4000]A tag is a label assigned to a resource.Each tag consists of a key and a value.truefalsefalse
discovery_stateDiscovery Statediscovery_state_enumState of UD discoverytruefalsefalse
is_save_persistencyStore KPI History For Over Time ReportsbooleanfalseStore KPI history for over time reportstruefalsetrue
layerlayer_enumtruefalsefalse
metaphaseMeta Phasestring[50]Meta Phase of a CI in SMAX. The attribute is owned by SMAX exclusivelytruefalsefalse
monitor_stateMonitor Statestring[50]Monitor State of a CI in OpsB. The attribute is owned by OpsB exclusively.truefalsefalse
provision_stateProvision Statestring[50]Provision State of a CI in HCMX. The attribute is owned by HCMX exclusively.truefalsefalse
regulatory_detailsRegulatory Detailsstring[1000][Summary]This attribute is used by DCA, it represents the regulatory details. [Collection]The value is pushed by DCA via CMSGatewaytruefalsefalse
regulatory_statusRegulatory Statusregulatory_status_enum[Summary]This attribute is used by DCA, it represents the regulatory status. [Collection]The value is pushed by DCA via CMSGatewaytruefalsefalse
sd_typeSD Typestring[32]truefalsefalse
stateStatestring[50]State locationtruefalsetrue
track_changesTrack Configuration ChangesbooleanfalseTrack configuration changestruefalsetrue
vulnerability_detailsVulnerability Detailsstring[1000][Summary]This attribute is used by DCA, it represents the vulnerability details. [Collection]The value is pushed by DCA via CMSGatewaytruefalsefalse
vulnerability_statusVulnerability Statusvulnerability_status_enum[Summary]This attribute is used by DCA, it represents the vulnerability status. [Collection]The value is pushed by DCA via CMSGatewaytruefalsefalse
Attributes defined for Managed Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
TenantOwnerOwner Tenantstring[32]The Tenant Owner IDtruefalsefalse
TenantsUsesConsumer Tenantsstring_listThe IDs of the Tenants who are associated with the CItruefalsefalse
Attributes defined for Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
document_listDocumentsstringDocumentstruefalsetrue
MENUxmltruefalsetrue
Attributes defined for Data
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
data_adminstateAdmin Stateadminstates_enum0Admin Statetruefalsetrue
data_allow_auto_discoveryAllow CI Updateboolean[250]truetruefalsefalse
data_changecorrstateChange Corr Statechangestates_enum0Change Statetruefalsetrue
data_changeisnewChange Is NewbooleanfalseChange Statetruefalsetrue
data_changestateChange Statechangestates_enum0Change Statetruefalsetrue
data_externalidExternal IDstring[300]external source id: snmp index, data sources index etc.truefalsetrue
data_noteNotestring[250]truefalsefalse
data_operationcorrstateOperation Corr Stateoperationstates_enum0Operation Statetruefalsetrue
data_operationisnewOperation Is NewbooleanfalseOperation Statetruefalsetrue
data_operationstateOperation Stateoperationstates_enum0Operation Statetruefalsetrue
data_originOriginstring[100]truefalsefalse
data_sourceCreated Bystring[512]truefalsefalse
data_testcorrstateTest Corr Stateteststates_enum0Test Statetruefalsetrue
data_testisnewTest Is NewbooleanfalseTest Statetruefalsetrue
data_teststateTest Stateteststates_enum0Test Statetruefalsetrue
data_updated_byLastModifiedBystring[512]truefalsefalse
descriptionDescriptionstring[1000]Descriptiontruefalsefalse
digestDigeststring[40]truefalsetrue
display_labelDisplay Labelstring[900]Used as calc attribute for displaytruefalsefalse
MENUxmltruefalsetrue
nameNamestring[900]truefalsefalse
user_labelUser Labelstring[900]Used as user labeltruefalsefalse
Attributes defined for Root
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
BODY_ICONstringgeneraltruefalsetrue
calculated_idCalculated IDbytes[16]Calculated IDtruefalsetrue
create_timeCreated TimedateWhen was this CI createdtruefalsefalse
FAMILY_ICONstringtruefalsetrue
global_idGlobal Idstring[32]A globally unique identifier for the entity represented by the objecttruefalsefalse
global_id_scopestringDefaulttruefalsetrue
last_discovered_byLastDiscoveredBystring[512]Who discovered this CItruefalsefalse
last_discovered_by_probeLastDiscoveredByProbestringWhich probe discovered this CItruefalsefalse
last_discovered_timeLastDiscoveredTimedateWhen was this CI discoveredtruefalsefalse
last_modified_timeLastModifiedTimedateWhen was this CI last updatedtruefalsefalse
root_actualdeletetimeActual Delete TimedateWhen will this CI be deletedtruefalsetrue
root_actualdeletionperiodActual Deletion Periodinteger40What is the period after the CI will be deletedtruefalsefalse
root_candidatefordeletetimeCandidate For Deletion TimedateWhen will this CI be warned about deletingtruefalsetrue
root_classCI Typestring[100]Class name of the CItruefalsetrue
root_containerContainerstring[32]Container CI of this CItruefalsefalse
root_deletioncandidateperiodDeletion Candidate Periodinteger20What is the period after the CI will be candidate for deletetruefalsefalse
root_enableageingEnable AgingbooleanfalseIs aging enabledtruefalsefalse
root_iconpropertiesstring[100]truefalsetrue
root_iscandidatefordeletionIs Candidate For DeletionbooleanfalseIs candidate for deletiontruefalsefalse
root_lastaccesstimeLast Access TimedateWhen was this CI last accessedtruefalsefalse
root_systemSystemstring[2]truefalsetrue

Valid Relations

Valid direct incoming and outgoing relations defined on Location

Relations defined for Location
FromToTypeDescription
LocationAmazon Auto Scaling GroupContainment
LocationAssetMembership
LocationAmazon DynamoDB ServiceMembership
LocationAmazon HTTP APIMembership
LocationAmazon Lambda FunctionMembership
LocationAWS ResourceContainment
LocationAmazon RESTful APIMembership
LocationAmazon SESMembership
LocationAmazon SNS SubscriptionMembership
LocationAmazon SNS TopicMembership
LocationAmazon SQS QueueMembership
LocationAmazon Virtual Private CloudContainment
LocationAzure API Management ServiceMembership
LocationAzure Application Security GroupMembership
LocationAzure App Service EnvironmentMembership
LocationAzure App Service PlanMembership
LocationAzure Application GatewayMembership
LocationAzure Automation AccountContainment
LocationAzure Automation AccountMembership
LocationAzure Availability SetContainment
LocationAzure Availability SetMembership
LocationAzure ConnectionsMembership
LocationAzure Container RegistryMembership
LocationAzure Cosmos DB AccountContainment
LocationAzure Cosmos DB AccountMembership
LocationAzure Data Factory ServiceMembership
LocationAzure Data Lake AnalyticsMembership
LocationAzure Databricks WorkspaceMembership
LocationAzure Enterprise Redis CacheMembership
LocationAzure Event Hub NamespaceContainment
LocationAzure Event Hub NamespaceMembership
LocationAzure Express Route CircuitMembership
LocationAzure Express Route DirectMembership
LocationAzure Express Route GatewayMembership
LocationAzure FirewallMembership
LocationAzure Firewall PolicyMembership
LocationAzure Front DoorMembership
LocationAzure Function AppMembership
LocationAzure Key VaultContainment
LocationAzure Key VaultMembership
LocationAzure Log Analytics workspaceContainment
LocationAzure Log Analytics workspaceMembership
LocationAzure Local Network GatewayMembership
LocationAzure Logic AppMembership
LocationAzure Logical ServerMembership
LocationAzure MySQL Single ServerMembership
LocationAzure Network Security GroupContainment
LocationAzure Network Security GroupMembership
LocationAzure Onpremise Data GatewayMembership
LocationAzure P2s VPN GatewayMembership
LocationAzure PostgreSQL Single ServerMembership
LocationAzure Private DNS ZoneMembership
LocationAzure Recovery Service VaultMembership
LocationAzure Redis CacheMembership
LocationAzure Route TableMembership
LocationAzure Scale SetContainment
LocationAzure Scale SetMembership
LocationAzure SQL Managed InstanceMembership
LocationAzure Traffic Manager ProfileMembership
LocationAzure Virtual WANMembership
LocationAzure VPN GatewayMembership
LocationAzure Web AppMembership
LocationCloud ServiceMembership
LocationConfigurationItemMembership
LocationDB2 DB ServiceMembership
LocationDB Cluster ServiceMembership
LocationDB ServiceMembership
LocationDisk Storage ServiceMembership
LocationContainer Image RepositoryMembership
LocationGoogle BigTable ClusterMembership
LocationGoogle Cloud SubnetContainment
LocationGoogle Dataflow JobMembership
LocationKubernetes ClusterMembership
LocationKpiConnection
LocationLoad BalancerContainment
LocationLoad BalancerMembership
LocationLocationContainment
LocationMySQL DB ServiceMembership
LocationNetwork File System ServiceMembership
LocationNodeContainment
LocationNodeMembership
LocationOracle Cloud Fault DomainCompositionRepresents 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
LocationOracle Cloud Storage VolumeMembership
LocationOracle DB ServiceMembership
LocationPartyMembership
LocationPostgreSQL DB ServiceMembership
LocationPowerApps Canvas ApplicationMembership
LocationProjectResponsibility
LocationMSSQL DB ServiceMembership
Amazon AccountLocationMembership
Azure MySQL Flexible ServerLocationMembership
Azure PostgreSQL Flexible ServerLocationMembership
ItProcessRecordLocationMembership
MaintenanceContractLocationAggregation
Oracle Cloud TenancyLocationMembership
Relations defined for ConfigurationItem
FromToTypeDescription
ConfigurationItemConfigurationItemConsumerProvider
ConfigurationItemKpiCompositionRepresents 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
ConfigurationItemOutageCompositionRepresents 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
ConfigurationItemPolicyResultAggregation
ConfigurationItemScheduledDowntimeConnection
ConfigurationItemServiceConnectionPointCompositionRepresents 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
ConfigurationItemServiceConnectionPointOwnership
ApplicationSystemConfigurationItemAggregation
AssetConfigurationItemConnection
CiCollectionConfigurationItemContainment
CiCollectionConfigurationItemMembership
ItProcessRecordConfigurationItemConnection
ItProcessRecordConfigurationItemMembership
LocationConfigurationItemMembership
TenantConfigurationItemConnection
Relations defined for Managed Object
FromToTypeDescription
Managed ObjectHistory ChangeHistory Link
TenantManaged ObjectConnection

Combined inheritance and relation diagram for Location

Potential Data Providers

Adapters providing CIs of type Location
Adapter NameDescriptionAdapter Type
AWS Event Based DiscoveryDiscovers AWS topologies by using the AWS SDK for Java to access AWS SQS service.Discovery
AWS Event Based Discovery using TagsRead AWS messages from local DB using tags as filter and report the changes of AWS resources to UCMDB.Discovery
AWS Discovery for HCM via APIDiscovers AWS topologies of the EC2 services using Web ServicesDiscovery
AWS by Web ServicesDiscovers AWS topologies using the Amazon Web Services.Discovery
AWS by Web Services using TagsDiscovers AWS resources with customized tagsDiscovery
Azure Discovery by TagsThis adapter discovers resources on an Azure tenantDiscovery
Azure Discovery by TenantThis adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenantDiscovery
Azure Event Based DiscoveryAzure Event Based DiscoveryDiscovery
Azure Event Based Discovery by TenantAzure Event Based Discovery by TenantDiscovery
Azure_Event_Discovery_by_TagsAzure_Event_Discovery_by_TagsDiscovery
Azure by WebServicesThis adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenantDiscovery
Basic AWS by Web ServicesDiscovers AWS topologies of the EC2 using Web ServicesDiscovery
Basic Azure by WebservicesDiscover Basic Azure by WebServiceDiscovery
Basic Google Cloud by RESTful APIDiscovers Basic Google Cloud topology using RESTful APIDiscovery
Google Cloud Discovery by LabelsDiscovers Google Cloud Resources by labelsDiscovery
Google Cloud by RESTful APIDiscovers Google Cloud topology using RESTful APIDiscovery
Oracle Cloud by REST APIThis job discovers Oracle Cloud topologies of Oracle Cloud Infrastructure Compute Classic, Oracle Database Cloud Service, Oracle MySQL Cloud Service, and services using REST API.Discovery
PowerApps DiscoveryThis adapter discovers PowerAppsDiscovery
SQL Discovery TutorialGetting Started Guide SQL Discovery TutorialDiscovery
AWS via AWS ConfigDiscovers AWS topologies via AWS ConfigDiscovery
Adapters providing CIs of type ConfigurationItem
Adapter NameDescriptionAdapter 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 IntegrationThis adapter queries the records from SCCM database and recognizes it as install software by UD SAIIntegration
Import from Excel WorkbookImports 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 NameDescriptionAdapter Type
AMGenericAdapterThis 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 AdapterThis 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 PopulationAllows defining Reconciliation Priority for API Data In flowsIntegration
Data Push into AtriumPushes CIs and relationships to BMC AtriumIntegration
CA CMDB (deprecated)Pushes CIs and relationships to CA CMDBIntegration
UCMDB 10.x and laterUsed 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.xIntegration
UCMDB History Adapter [local instance only]Used to federated data from the UCMDB's HistoryIntegration
UCMDB to SaaSUsed for Pushing CIs and Relationships from an on-premises UCMDB 2019.02(or later) to SaaS CMSIntegration
Push Adapter DB ExamplePush data into Oracle \ MSSQL databaseIntegration
GenericDBAdapterAn example Adapter that uses the GDB-FrameworkIntegration
Java_Adapter_TemplateAdapter DescriptionIntegration
Pulsar Push AdapterPush function for Pulsar Push AdapterIntegration
Push AdapterPush AdapterIntegration
Remedyforce Push IntegrationRemedyforce Push IntegrationIntegration
System Center Configuration ManagerUses the GDB-Framework to Populate and Federate data from a System Center Configuration Manager. The adapter is also backward compatible with the SMS DBIntegration
Service Manager 9.41Discovery Pattern DescriptionIntegration
Service Manager Enhanced Generic AdapterPush and Populate CI data between UCMDB and Service ManagerIntegration
ServiceNow Enhanced Generic AdapterPush, Populate and Federation of CI data between UCMDB and ServiceNowIntegration
UCMDB to XMLExport data into XML from UCMDBIntegration

© Copyright 2018 Micro Focus or one of its affiliates