Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Data collected for IBM Cloud Discovery

Discovery collects information about cloud resources in the IBM Cloud Platform and creates relationships between the CIs it finds. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

Request apps on the Store

Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Prerequisites

Verify the REST API Permissions

Download the Cloud Discovery patterns spreadsheet so you can grant user permissions required for running the Discovery patterns. In addition to permissions, the spreadsheet also includes useful information such as pattern names, types, CI Classes, and links to vendor documentation. New patterns are available quarterly, so check periodically to be sure you have the latest version of the spreadsheet.

Load balancers

TableField Name / Description
Cloud Load Balancer \[cmdb\_ci\_cloud\_load\_balancer\]object_id: The load balancer's unique identifier.
name: Name of the load balancer.
fqdn: Address (Host name) of the load balancer. This is the fully qualified domain name of the load balancer.
dns_name: Address (Host name) of the load balancer.
short_description: Description of the load balancer.
operational_status: The operational status of the load balancer, either ONLINE or OFFLINE.
location: References the load balancer's location with type.
state: Provisioning status of the load balancer, either Available or Terminated.
Load Balancer Service \[cmdb\_ci\_lb\_service\]object_id: Unique identifier of the load balancer service.
name: Name created by the pattern that contains the following:- Load balancer name - Protocol - Port - Resource type: -listener
port: Listener's protocol port number.
front_end_port: Listener's protocol port number.
listener_protocol: Listener's protocol, either TCP, HTTP, or HTTPS.
operational_status: The provisioning status of the listener.
Load Balancer Pool \[cmdb\_ci\_lb\_pool\]object_id: Unique identifier of the load balancer pool.
name: Name created by the pattern that contains the following:- Load balancer name - Protocol - Port - Resource type: -pool
port: Protocol port of the back end.
pool_status: Provisioning status of a load balancer pool.
load_balancing_method: Method used to load balance the pool.
Load Balancer Pool Member \[cmdb\_ci\_lb\_pool\_member\]object-id: Unique identifier of the pool member, created from the ID of the member and the listener ID.
name: Name created by the pattern that contains the following:- Load balancer name - Protocol - Port - Resource type: -member - IP address of the pool member
ip_address: IP address of a load balancer member.
server_id: ID of the member in the IBM Cloud.
load_balancer: Name of the related load balancer.
Load Balancer Health Service \[cmdb\_ci\_lb\_health\_service\]object_id: Unique identifier of the healthservice check.
name: Name created by the pattern that contains the following:- Load balancer name - Protocol - Resource type: Health Check - Resource ID
monitor_type: Type of health check. Valid values are TCP, HTTP, or HTTPS.
timeout_sec: Timeout in seconds to wait for the health check response.
check_interval_sec: Interval in seconds to perform the health check.
CIRelationshipCI
cmdb_ci_ibm_datacenterContains::Contained bycmdb_ci_availability_zone
cmdb_ci_ibm_datacenterHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_cloud_load_balancerContains::Contained bycmdb_ci_lb_health_service
cmdb_ci_cloud_load_balancerHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_availability_zoneContains::Contained bycmdb_ci_cloud_load_balancer
cmdb_ci_lb_serviceHosted on::Hostscmdb_ci_cloud_load_balancer
cmdb_ci_availability_zoneContains::Contained bycmdb_ci_lb_service
cmdb_ci_lb_poolHosted on::Hostscmdb_ci_cloud_load_balancer
cmdb_ci_lb_serviceContains::Contained bycmdb_ci_lb_pool
cmdb_ci_lb_poolOwns::Owned bycmdb_ci_lb_pool_member

Organizations and spaces

TableFields
IBM Cloud Organizations \[cmdb\_ci\_cloud\_org\]
  • guid: The organization's unique identifier.
  • url: The organization's unique URL.
  • billing_enabled: Indicates if the organization's billing method is enabled or disabled.
  • name: Unique name of the cloud organization.
  • quota_definition_url: Resources that are available to the organization.
  • spaces_url: Unique URL of the space assigned to the organization.
  • operational_status: Operational status of the organization.
IBM Cloud Space \[cmdb\_ci\_cloud\_space\]
  • object_id: Unique identifier (GUID) of the space.
  • name: Unique name of the space.
  • url: Unique URL of the space.
  • allow_ssh: The IP address of a storage resource.
CIRelationshipCI
cmdb_ci_ibm_datacenterContains::Contained bycmdb_ci_availability_zone
cmdb_ci_ibm_datacenterHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_cloud_orgHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_cloud_spaceHosted on::Hostscmdb_ci_cloud_org
cmdb_ci_ibm_datacenterContains::Contained bycmdb_ci_cloud_space

SSH Keys

TableFields
Cloud Key Pairs \[cmdb\_ci\_cloud\_key\_pair\]
  • object_id: ID of the SSH key record.
  • name: Descriptive name used to identify the SSH key.
  • key: The SSH key.
  • finger_print: Short sequence of bytes used to authenticate or lookup a longer SSH key. This is generated automatically when adding or modifying the SSH key. This property is read only. Changes made are ignored.
  • created_date: Date the SSH key was added. This property is read only. Changes made are ignored.
  • modify_date: Date the SSH key was last modified. This property is read only. Changes made are ignored.
  • short_description: Brief note about the SSH key.
CIRelationshipCI
cmdb_ci_ibm_datacenterContained by::Containscmdb_ci_availability_zone
cmdb_ci_cloud_key_pairHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_ibm_datacenterHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_cloud_key_pairHosted on::Hostscmdb_ci_cloud_service_account

IBM Cloud storage

TableFields
Storage Volume \[cmdb\_ci\_storage\_volume\]
  • object_id: Unique identifier of the storage account.
  • size: Capacity of the storage account, measured in gigabytes.
  • size_bytes: Capacity of the storage account, measured in bytes.
  • name: Username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system.
  • label: Network resource name for the storage.
  • storage_type: Description of the storage object.
  • fqdn: IP address of the storage resource.
  • device: Unique identification number of the guest associated with the storage volume.
Storage Volume Snapshot \[cmdb\_ci\_storage\_vol\_snapshot\]
  • object_id: Unique identifier of the storage account.
  • name: Name of the storage's network resource.
  • capacity: The volume's configured snapshot space size.
  • fqdn: IP address of the storage resource.
  • location: Unique availability zone where the storage volume is located.
CIRelationshipCI
cmdb_ci_ibm_datacenterContains::Contained bycmdb_ci_availability_zone
cmdb_ci_ibm_datacenterHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_storage_volumeProvisioned::Provisioned Fromcmdb_ci_storage_vol_snapshot
cmdb_ci_storage_vol_snapshotHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_storage_volumeHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_storage_vol_snapshotLocated in Zone::Zone containscmdb_ci_availability_zone
cmdb_ci_availability_zoneContains::Contained bycmdb_ci_storage_volume

IBM Cloud virtual servers

TableFields
Virtual Machine Instance \[cmdb\_ci\_vm\_instance\]
  • name: Name of the virtual machine.
  • object_id: ID of the virtual machine.
  • dns_domain: Domain of the virtual machine.
  • fqdn: IP address of the virtual machine.
  • short_description: Notes attached to the virtual machine on the IBM console.
  • cpus: Number of CPUs on the virtual machine.
  • memory: Amount of memory on the virtual machine.
  • disks: Number of disks used by the virutal machine.
  • state: The running state of the virtual machine. The choices are:
  • Running
  • Halted
  • placement_group_id: Name of the IBM placement group containing the virtual machine.
  • nics: Number of network interfaces on the virtual machine.
Cloud Mgmt Network Interface \[cmdb\_ci\_nic\]
  • name: Name and port of the NIC, in the format <name><port>.
  • ip_address: IP address configured on the NIC.
  • mac_address: MAC address of the NIC.
  • netmask: Netmask of the NIC.
  • object_id: ID of the NIC.
  • status: State of the NIC - AVAILABLE.
Image \[cmdb\_ci\_os\_template\]
  • name: Long description of the template. For example: CentOS 7.0-64 Minimal for VSI.
  • version: Operating system version. For example, 7.0-64 Minimal for VSI.
  • object_id: ID of the image.
  • guest_os: Operating system of the virtual machine, such as Windows, Ubuntu, or CentOS.
Cloud Key Pair \[cmdb\_ci\_cloud\_key\_pair\]
  • name: The key label.
  • object_id: ID of the key.
Compute Security Group \[cmdb\_ci\_compute\_security\_group\]
  • name: Security group name.
  • object_id: ID of the security group
  • short_description: Security group notes.
Storage Volume \[cmdb\_ci\_storage\_volume\]object_id: The storage volume ID.
CIRelationshipCI
cmdb_ci_vm_instanceHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_vm_instanceLocated in::Housescmdb_ci_availability_zone
cmdb_ci_nicContained by::Containscmdb_ci_vm_instance
cmdb_ci_os_templateHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_os_templateProvisioned by::Provisionscmdb_ci_vm_instance
cmdb_ci_cloud_key_pairHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_cloud_key_pairUsed by::Usescmdb_ci_vm_instance
cmdb_ci_compute_security_groupHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_compute_security_groupImplement End Point From::Implement End Point Tocmdb_ci_vm_instance
cmdb_ci_storage_volumeHosted on::Hostscmdb_ci_ibm_datacenter
cmdb_ci_storage_volumeImplement End Point From::Implement End Point Tocmdb_ci_vm_instance

IBM Cloud service account

TableField
Cloud Service Account \[cmdb\_ci\_cloud\_service\_account\]
  • name: Display name of the cloud service account.
  • account_id: Service account ID.
  • object_id: Cloud ID of the service account. This is the same as the account_id.
  • datacenter_type: This is cmdb_ci_ibm_datacenter.
  • discovery_credentials: The sys_id of the credentials.
IBM Datacenter \[cmdb\_ci\_ibm\_datacenter\]
  • name: Display name of the cloud service account.
  • account_id: Service account ID.
  • object_id: Cloud ID of the service account. This is the same as the account_id.
  • datacenter_type: This is cmdb_ci_ibm_datacenter.
CIRelationshipCI
cmdb_ci_cloud_service_accountContained by::Containscmdb_ci_availability_zone
cmdb_ci_cloud_service_accountContained by::Containscmdb_ci_ibm_datacenter
cmdb_ci_cloud_service_accountHosts::Hosted oncmdb_ci_cloud_key_pair
cmdb_ci_cloud_service_accountHosts::Hosted oncmdb_ci_vm_instance
cmdb_ci_cloud_service_accountHosts::Hosted oncmdb_ci_lb_service
cmdb_ci_ibm_datacenterContained by::Containscmdb_ci_availability_zone
cmdb_ci_ibm_datacenterHosted on::Hostscmdb_ci_cloud_service_account
cmdb_ci_ibm_datacenterHosts::Hosted oncmdb_ci_network

Parent Topic:Cloud resource discovery references