---
sourceDocument: Australia IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/it-operations-management

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# VMware NSX-T cluster

# VMware
NSX-T cluster pattern-based discovery {#ariaid-title1}

Release version: Australia  
Updated May 7, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of VMware NSX-T cluster pattern-based discovery

The VMware NSX-T cluster pattern in ServiceNow's Discovery and Service Mapping Patterns application enables automated discovery of NSX-T infrastructure components.
This pattern populates the Configuration Management Database (CMDB) with detailed information about NSX-T clusters and their resources, including management clusters, nodes, transport nodes, transport zones, edge clusters, virtual switches, gateways, and segments.
Customers can visualize these resources and their relationships using dependency views.
Show full answer Show less  
To leverage the latest capabilities, customers should ensure they use the most recent version of the Discovery and Service Mapping Patterns application available on the ServiceNow Store.

## Prerequisites

* Update key applications: CMDB CI Class Models, Discovery and Service Mapping Patterns, and Visibility Content.
* Configure an applicative credential alias with sufficient NSX-T API permissions to perform discovery calls such as session creation, cluster status retrieval, node and segment queries, among others.
* Create a serverless discovery schedule to run the NSX-T cluster discovery pattern.

## Discovered Data and CMDB Population

The NSX Cluster pattern collects and populates detailed data into specific CMDB tables, each capturing attributes critical for accurate infrastructure mapping:

* **NSX Management Cluster:** IP address, cluster status, operational and install status.
* **NSX Management Cluster Node:** Node identifiers, FQDN, node status, and operational details.
* **NSX Management Cluster Node Group:** Group identification and status.
* **NSX Transport Node Resource:** Host type, FQDN, IP, operational status, and description.
* **NSX Transport Zone Resource:** Transport type, forwarding mode, default status, and operational state.
* **NSX Edge Cluster Group:** Edge node types and forwarding configuration.
* **NSX Virtual Switch Resource:** Identifiers and operational status.
* **NSX Gateway Resource:** Tier type, HA mode, failover mode, and descriptions.
* **NSX Segment Resource:** Segment identifiers and status.
* **IP Address:** IPs associated with transport nodes.

## Relationships and References

The pattern establishes comprehensive relationships among discovered CIs, such as management cluster membership, management of gateways and transport nodes, and connectivity between gateways and segments. These relationships form the foundation for accurate dependency views and impact analysis within ServiceNow.

Additionally, references link CIs to external metadata and tags, facilitating enriched configuration data and integration with other systems.

## Tagging and External Metadata

The discovery process collects resource tags and external system metadata, storing them in dedicated tables linked to the relevant NSX resources. This enables enhanced categorization and filtering of NSX-T components within the CMDB.

## Key Actions for Implementation

* **Create an applicative credential alias** to securely authenticate and authorize NSX-T API calls during discovery.
* **Create a serverless discovery schedule** to automate periodic execution of the NSX Cluster pattern for up-to-date infrastructure visibility.

By implementing this pattern, ServiceNow customers can achieve detailed, accurate, and up-to-date visibility into their VMware NSX-T environments, facilitating effective management, troubleshooting, and service mapping.  
Discovery and Service Mapping Patterns uses the NSX Cluster pattern to find VMware
NSX-T infrastructure. Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

## Request new or enhanced Patterns on the ServiceNow® Store {#nsx-t-cluster-pattern__id_xhb_h5g_2jc}

Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/application/06a71b1367e4130051c9027e2685ef1e/1.6.0?referer=/store/search?listingtype=allintegrations%253Bancillary_app%253Bcertified_apps%253Bcontent%253Bindustry_solution%253Boem%253Butility%253Btemplate&q=Patterns&sl=sh) to view all the available updates 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#nsx-t-cluster-pattern__p_d21_nfg_h1c}

## NSX Cluster data model {#nsx-t-cluster-pattern__section_ycq_j5g_2jc}

The following diagram illustrates the tables and relationships that the Discovery and Service Mapping Patterns application creates when discovering NSX-T infrastructure resources.  
Figure 1. Tables and relationships populated during NSX-T cluster discovery

## Prerequisites {#nsx-t-cluster-pattern__section_prerequisites}

Verify that the following applications are up to date
:
    * CMDB CI Class Models
    * Discovery and Service Mapping Patterns
    * Visibility Content
    {#nsx-t-cluster-pattern__ul_szc_42f_kjc}

Configure a credential alias
:   For more information, see [Create an applicative credential alias for NSX-T cluster discovery](https://www.servicenow.com/docs/OThM_aN6vfGrjim~8ROeiA "Create a credential alias and configure an applicative credential to enable the NSX Cluster pattern to authenticate with the NSX-T management cluster.").

Verify NSX-T API access and permissions

:   Verify that the credential has sufficient permissions to execute the following NSX-T API calls:

    * `POST /api/session/create`
    * `GET /api/v1/cluster/status`
    * `GET /api/v1/node`
    * `GET /policy/api/v1/infra/segments`
    * `GET /policy/api/v1/infra/tier-0s`
    * `GET /policy/api/v1/infra/tier-1s`
    * `GET /api/v1/transport-nodes`
    * `GET /api/v1/transport-zones`
    * `GET /api/v1/fabric/virtual-switches/`
    * `GET /api/v1/edge-clusters`
    {#nsx-t-cluster-pattern__ul_apis}

Create a serverless discovery schedule
:   For more information, see [Create a serverless schedule for NSX-T cluster discovery](https://www.servicenow.com/docs/6gvNjvJYBmhty4I6r5NcgA "Create a serverless discovery schedule to run the NSX Cluster pattern against a VMware NSX-T management cluster.").

## Data collected by Discovery during horizontal discovery {#nsx-t-cluster-pattern__section_data_collected}

Discovery populates the data in the CMDB when running the NSX Cluster pattern.  
{#nsx-t-cluster-pattern__table_mgmt_cluster__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | IP address of the NSX Management Cluster. |
| IP Address \[ip_address\] | IP address of the NSX Management Cluster. |
| Cluster Status \[cluster_status\] | Status of the management cluster as reported by the NSX-T API. |
| Operational status \[operational_status\] | Operational status of the resource, derived from the cluster status. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
[Table 1. NSX Management Cluster \[cmdb_ci_nsx_management_cluster\]]

{#nsx-t-cluster-pattern__table_mgmt_cluster}  
{#nsx-t-cluster-pattern__table_mgmt_cluster_node__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the cluster node, derived from the node's fully qualified domain name (FQDN). |
| ID \[nsx_node_id\] | Unique identifier of the NSX Manager node. |
| Fully qualified domain name \[fqdn\] | FQDN of the node. |
| Node Status \[node_status\] | Status of the node as reported by the NSX-T API. |
| Operational status \[operational_status\] | Operational status of the resource, derived from the node status. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
[Table 2. NSX Management Cluster Node \[cmdb_ci_nsx_management_cluster_node\]]

{#nsx-t-cluster-pattern__table_mgmt_cluster_node}  
{#nsx-t-cluster-pattern__table_mgmt_cluster_node_group__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Concatenation of the cluster IP address and the group type. For example: `10.0.0.1 MANAGER`. |
| Object ID \[object_id\] | Group ID assigned by NSX-T. |
| Operational status \[operational_status\] | Operational status of the resource, derived from the group status. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
[Table 3. NSX Management Cluster Node Group \[cmdb_ci_nsx_management_cluster_node_group\]]

{#nsx-t-cluster-pattern__table_mgmt_cluster_node_group}  
{#nsx-t-cluster-pattern__table_transport_node__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the transport node, derived from the host FQDN or virtual machine (VM) display name. |
| Object ID \[object_id\] | Unique identifier of the transport node. |
| Host Type \[host_type\] | Type of the transport node host. For example: ESXi, KVM, or Edge. |
| Host Name \[host_name\] | Host name of the transport node. |
| Host ID \[host_id\] | Identifier of the host running the transport node. |
| Fully qualified domain name \[fqdn\] | FQDN of the transport node. |
| IP Address \[ip_address\] | IP address of the transport node. |
| Operational status \[operational_status\] | Operational status of the resource. Default value is Operational. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
| Description \[short_description\] | User-provided description of the transport node. |
[Table 4. NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\]]

{#nsx-t-cluster-pattern__table_transport_node}  
{#nsx-t-cluster-pattern__table_transport_zone__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the transport zone. |
| Object ID \[object_id\] | Unique identifier of the transport zone. |
| Transport Type \[transport_type\] | Transport type of the zone. For example: OVERLAY or VLAN. |
| Forwarding Mode \[forwarding_mode\] | Forwarding mode of the transport zone. |
| Is Default \[is_default\] | Indicates whether this is the default transport zone. |
| Operational status \[operational_status\] | Operational status of the resource. The value is set to Operational. |
| Install Status \[install_status\] | Install status of the resource. The value is set to Installed. |
| Description \[short_description\] | User-provided description of the transport zone. |
[Table 5. NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\]]

{#nsx-t-cluster-pattern__table_transport_zone}  
{#nsx-t-cluster-pattern__table_edge_cluster__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the edge cluster group. |
| Object ID \[object_id\] | Unique identifier of the edge cluster. |
| Node Type \[node_type\] | Type of edge node in the cluster. |
| Inter Site Forwarding \[enable_inter_site_forwarding\] | Indicates whether inter-site forwarding is enabled for this edge cluster. |
[Table 6. NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\]]

{#nsx-t-cluster-pattern__table_edge_cluster}  
{#nsx-t-cluster-pattern__table_virtual_switch__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the virtual switch. |
| Object ID \[object_id\] | Unique identifier of the virtual switch. |
| CM Local ID \[cm_local_id\] | Local identifier assigned by the compute manager. |
| Origin ID \[origin_id\] | Origin identifier of the virtual switch resource. |
| Operational status \[operational_status\] | Operational status of the resource. Default value is Operational. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
[Table 7. NSX Virtual Switch Resource \[cmdb_ci_nsx_virtual_switch_resource\]]

{#nsx-t-cluster-pattern__table_virtual_switch}  
{#nsx-t-cluster-pattern__table_gateway__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the gateway. |
| Object ID \[object_id\] | Unique identifier of the gateway. |
| Tier Type \[tier_type\] | Tier type of the gateway: Tier-0 or Tier-1. |
| HA Mode \[ha_mode\] | High-availability mode of the gateway. |
| Failover Mode \[failover_mode\] | Failover mode of the gateway. |
| Operational status \[operational_status\] | Operational status of the resource. Default value is Operational. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
| Description \[short_description\] | User-provided description of the gateway resource. |
[Table 8. NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\]]

{#nsx-t-cluster-pattern__table_gateway}  
{#nsx-t-cluster-pattern__table_segment__entry__2}

| Field | Description |
|-|-|
| Name \[name\] | Display name of the segment. |
| Object ID \[object_id\] | Unique identifier of the segment. |
| Operational status \[operational_status\] | Operational status of the resource, derived from the resource state. |
| Install Status \[install_status\] | Install status of the resource. Default value is Installed. |
| Description \[short_description\] | User-provided description of the segment resource. |
[Table 9. NSX Segment Resource \[cmdb_ci_nsx_segment_resource\]]

{#nsx-t-cluster-pattern__table_segment}  
{#nsx-t-cluster-pattern__table_ip_address__entry__2}

| Field | Description |
|-|-|
| IP Address \[ip_address\] | IP address of the transport node. |
[Table 10. IP Address \[cmdb_ci_ip_address\]]

{#nsx-t-cluster-pattern__table_ip_address}

## Dependency Views map {#nsx-t-cluster-pattern__section_b24_h1h_2jc}

On the Dependency Views map, you can view discovered NSX-T cluster resources and the relationships between them.  
Figure 2. NSX Management Cluster CI dependency view

## CI relationships and references {#nsx-t-cluster-pattern__section_relationships}

The NSX Cluster pattern creates the following relationships and references to support NSX-T cluster discovery. References link to records in other tables and don't appear in the CI Relationship \[cmdb_rel_ci\] table.  
{#nsx-t-cluster-pattern__table_ci_rels__entry__3}

| CI | Relationship | CI |
|-|-|-|
| NSX Management Cluster Node \[cmdb_ci_nsx_management_cluster_node\] | Members::Member of | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] | Connects to::Connected by | NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] |
| NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] (Tier 1) | Connects to::Connected by | NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] (Tier 0) |
| NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] | Owns::Owned by | IP Address \[cmdb_ci_ip_address\] |
| NSX Management Cluster Node Group \[cmdb_ci_nsx_management_cluster_node_group\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Management Cluster Node Group \[cmdb_ci_nsx_management_cluster_node_group\] | Uses::Used by | NSX Management Cluster Node \[cmdb_ci_nsx_management_cluster_node\] |
| NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\] | Contains::Contained by | NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] |
| NSX Virtual Switch Resource \[cmdb_ci_nsx_virtual_switch_resource\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] | Managed by::Manages | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] | Uses::Used by | NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] |
[Table 11. CI relationships]

{#nsx-t-cluster-pattern__table_ci_rels}  
{#nsx-t-cluster-pattern__table_ci_references__entry__3}

| CI | Field | Referenced CI |
|-|-|-|
| NSX Management Cluster Node \[cmdb_ci_nsx_management_cluster_node\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Management Cluster Node Group \[cmdb_ci_nsx_management_cluster_node_group\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Virtual Switch Resource \[cmdb_ci_nsx_virtual_switch_resource\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] | Cluster \[cluster\] | NSX Management Cluster \[cmdb_ci_nsx_management_cluster\] |
| Key Value \[cmdb_key_value\] | Configuration item \[configuration_item\] | References one of the following NSX resource tables: * NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] * NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] * NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] * NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] {#nsx-t-cluster-pattern__ul_b4s_r5s_djc} |
| External system metadata \[cmdb_key_value_v2\] | Configuration item \[configuration_item\] | References one of the following NSX resource tables: * NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] * NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] * NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] * NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] * NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\] * NSX Virtual Switch Resource \[cmdb_ci_nsx_virtual_switch_resource\] {#nsx-t-cluster-pattern__ul_bjj_r5s_djc} |
[Table 12. CI references]

{#nsx-t-cluster-pattern__table_ci_references}

## Tag discovery and external system metadata {#nsx-t-cluster-pattern__section_tag_discovery}

The NSX Cluster pattern collects resource tags and external system metadata. Tags are stored in the Key Value \[cmdb_key_value\] table. External system metadata is stored in the External system metadata \[cmdb_key_value_v2\] table.  
{#nsx-t-cluster-pattern__table_key_value__entry__2}

| Field | Description |
|-|-|
| Key \[key\] | Tag name. |
| Value \[value\] | Tag value. |
| Configuration item \[configuration_item\] | References the NSX resource table associated with the tag. Possible tables: * NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] * NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] * NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] * NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] {#nsx-t-cluster-pattern__ul_pwd_p5s_djc} |
[Table 13. Key Value \[cmdb_key_value\]]

{#nsx-t-cluster-pattern__table_key_value}  
{#nsx-t-cluster-pattern__table_kv_v2__entry__2}

| Field | Description |
|-|-|
| Key \[key\] | Metadata property name. |
| String value \[string_value\] | Value of the metadata property. |
| Value type \[value_type\] | Data type of the metadata value. |
| Configuration item \[configuration_item\] | References the NSX resource table associated with the metadata entry. Possible tables: * NSX Segment Resource \[cmdb_ci_nsx_segment_resource\] * NSX Gateway Resource \[cmdb_ci_nsx_gateway_resource\] * NSX Transport Node Resource \[cmdb_ci_nsx_transport_node_resource\] * NSX Edge Cluster Group \[cmdb_ci_nsx_edge_cluster_group\] * NSX Transport Zone Resource \[cmdb_ci_nsx_transport_zone_resource\] * NSX Virtual Switch Resource \[cmdb_ci_nsx_virtual_switch_resource\] {#nsx-t-cluster-pattern__ul_gvp_q5s_djc} |
[Table 14. External system metadata \[cmdb_key_value_v2\]]

{#nsx-t-cluster-pattern__table_kv_v2}
* **[Create an applicative credential alias for NSX-T cluster discovery](https://www.servicenow.com/docs/OThM_aN6vfGrjim~8ROeiA)**   
  Create a credential alias and configure an applicative credential to enable the NSX Cluster pattern to authenticate with the NSX-T management cluster.
* **[Create a serverless schedule for NSX-T cluster discovery](https://www.servicenow.com/docs/6gvNjvJYBmhty4I6r5NcgA)**   
  Create a serverless discovery schedule to run the NSX Cluster pattern against a VMware NSX-T management cluster.