nsxt.getPolicyBaremetalServerInterfaces

nsxt 3.12.1, Sep 11 26

Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";

// Get all bare metal server interfaces
const allInterfaces = nsxt.getPolicyBaremetalServerInterfaces({});
// Filter by parent bare metal server
const bm1Interfaces = nsxt.getPolicyBaremetalServerInterfaces({
    bmsExternalId: "71be0142-2ed1-1d53-9c60-5564cf4b7e2e",
});
// Filter by network role using server-side tag filtering
const dataInterfaces = nsxt.getPolicyBaremetalServerInterfaces({
    tagScope: "network_role",
    tag: "data",
});
// Filter by interface name using regex
const ethInterfaces = nsxt.getPolicyBaremetalServerInterfaces({
    displayName: "eth.*",
});
// Multiple filters
const prodDataEth = nsxt.getPolicyBaremetalServerInterfaces({
    bmsExternalId: prod.results[0].externalId,
    displayName: "eth.*",
    tagScope: "network_role",
    tag: "data",
});
export const interfaceIps = dataInterfaces.then(dataInterfaces => .map(i => (i.ipAddresses)));

import pulumi
import pulumi_nsxt as nsxt

# Get all bare metal server interfaces
all_interfaces = nsxt.get_policy_baremetal_server_interfaces()
# Filter by parent bare metal server
bm1_interfaces = nsxt.get_policy_baremetal_server_interfaces(bms_external_id="71be0142-2ed1-1d53-9c60-5564cf4b7e2e")
# Filter by network role using server-side tag filtering
data_interfaces = nsxt.get_policy_baremetal_server_interfaces(tag_scope="network_role",
    tag="data")
# Filter by interface name using regex
eth_interfaces = nsxt.get_policy_baremetal_server_interfaces(display_name="eth.*")
# Multiple filters
prod_data_eth = nsxt.get_policy_baremetal_server_interfaces(bms_external_id=prod["results"][0]["externalId"],
    display_name="eth.*",
    tag_scope="network_role",
    tag="data")
pulumi.export("interfaceIps", [i.ip_addresses for i in data_interfaces.results])

Example coming soon!

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    // Get all bare metal server interfaces
    var allInterfaces = Nsxt.GetPolicyBaremetalServerInterfaces.Invoke();

    // Filter by parent bare metal server
    var bm1Interfaces = Nsxt.GetPolicyBaremetalServerInterfaces.Invoke(new()
    {
        BmsExternalId = "71be0142-2ed1-1d53-9c60-5564cf4b7e2e",
    });

    // Filter by network role using server-side tag filtering
    var dataInterfaces = Nsxt.GetPolicyBaremetalServerInterfaces.Invoke(new()
    {
        TagScope = "network_role",
        Tag = "data",
    });

    // Filter by interface name using regex
    var ethInterfaces = Nsxt.GetPolicyBaremetalServerInterfaces.Invoke(new()
    {
        DisplayName = "eth.*",
    });

    // Multiple filters
    var prodDataEth = Nsxt.GetPolicyBaremetalServerInterfaces.Invoke(new()
    {
        BmsExternalId = prod.Results[0].ExternalId,
        DisplayName = "eth.*",
        TagScope = "network_role",
        Tag = "data",
    });

    return new Dictionary<string, object?>
    {
        ["interfaceIps"] = .Select(i => 
        {
            return i.IpAddresses;
        }).ToList(),
    };
});

Example coming soon!

Example coming soon!

Example coming soon!

Using getPolicyBaremetalServerInterfaces

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPolicyBaremetalServerInterfaces(args: GetPolicyBaremetalServerInterfacesArgs, opts?: InvokeOptions): Promise<GetPolicyBaremetalServerInterfacesResult>
function getPolicyBaremetalServerInterfacesOutput(args: GetPolicyBaremetalServerInterfacesOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyBaremetalServerInterfacesResult>

def get_policy_baremetal_server_interfaces(bms_external_id: Optional[str] = None,
                                           display_name: Optional[str] = None,
                                           id: Optional[str] = None,
                                           source_id: Optional[str] = None,
                                           tag: Optional[str] = None,
                                           tag_scope: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetPolicyBaremetalServerInterfacesResult
def get_policy_baremetal_server_interfaces_output(bms_external_id: pulumi.Input[Optional[str]] = None,
                                           display_name: pulumi.Input[Optional[str]] = None,
                                           id: pulumi.Input[Optional[str]] = None,
                                           source_id: pulumi.Input[Optional[str]] = None,
                                           tag: pulumi.Input[Optional[str]] = None,
                                           tag_scope: pulumi.Input[Optional[str]] = None,
                                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyBaremetalServerInterfacesResult]

func LookupPolicyBaremetalServerInterfaces(ctx *Context, args *LookupPolicyBaremetalServerInterfacesArgs, opts ...InvokeOption) (*LookupPolicyBaremetalServerInterfacesResult, error)
func LookupPolicyBaremetalServerInterfacesOutput(ctx *Context, args *LookupPolicyBaremetalServerInterfacesOutputArgs, opts ...InvokeOption) LookupPolicyBaremetalServerInterfacesResultOutput

> Note: This function is named LookupPolicyBaremetalServerInterfaces in the Go SDK.

public static class GetPolicyBaremetalServerInterfaces 
{
    public static Task<GetPolicyBaremetalServerInterfacesResult> InvokeAsync(GetPolicyBaremetalServerInterfacesArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyBaremetalServerInterfacesResult> Invoke(GetPolicyBaremetalServerInterfacesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyBaremetalServerInterfacesResult> Invoke(GetPolicyBaremetalServerInterfacesInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetPolicyBaremetalServerInterfacesResult> getPolicyBaremetalServerInterfaces(GetPolicyBaremetalServerInterfacesArgs args, InvokeOptions options)
public static Output<GetPolicyBaremetalServerInterfacesResult> getPolicyBaremetalServerInterfaces(GetPolicyBaremetalServerInterfacesArgs args, InvokeOptions options)
public static Output<GetPolicyBaremetalServerInterfacesResult> getPolicyBaremetalServerInterfaces(GetPolicyBaremetalServerInterfacesArgs args, InvokeOutputOptions options)

fn::invoke:
  function: nsxt:index/getPolicyBaremetalServerInterfaces:getPolicyBaremetalServerInterfaces
  arguments:
    # arguments dictionary

data "nsxt_get_policy_baremetal_server_interfaces" "name" {
    # arguments
}

The following arguments are supported:

BmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
DisplayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
Id string: ID of the data source.
SourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
Tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
TagScope string: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

BmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
DisplayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
Id string: ID of the data source.
SourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
Tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
TagScope string: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

bms_external_id string: Filter by parent bare metal server external ID. Default is empty (no filtering).
display_name string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
id string: ID of the data source.
source_id string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
tag_scope string: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

bmsExternalId String: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName String: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
id String: ID of the data source.
sourceId String: Filter by source (bare metal controller) ID. Default is empty (no filtering).
tag String: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
tagScope String: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

bmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
id string: ID of the data source.
sourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
tagScope string: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

bms_external_id str: Filter by parent bare metal server external ID. Default is empty (no filtering).
display_name str: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
id str: ID of the data source.
source_id str: Filter by source (bare metal controller) ID. Default is empty (no filtering).
tag str: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
tag_scope str: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

bmsExternalId String: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName String: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
id String: ID of the data source.
sourceId String: Filter by source (bare metal controller) ID. Default is empty (no filtering).
tag String: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).
tagScope String: Filter by tag scope. This filter is applied server-side for better performance. Default is empty (no filtering).

getPolicyBaremetalServerInterfaces Result

The following output properties are available:

Id string: ID of the data source.
Results List<GetPolicyBaremetalServerInterfacesResult>: List of bare metal server interfaces matching the criteria. Each interface contains:
BmsExternalId string: External ID of the parent bare metal server.
DisplayName string: Display name of the bare metal server interface.
SourceId string: Source ID of the bare metal server interface.
Tag string: Tag value.
TagScope string

Id string: ID of the data source.
Results []GetPolicyBaremetalServerInterfacesResult: List of bare metal server interfaces matching the criteria. Each interface contains:
BmsExternalId string: External ID of the parent bare metal server.
DisplayName string: Display name of the bare metal server interface.
SourceId string: Source ID of the bare metal server interface.
Tag string: Tag value.
TagScope string

id string: ID of the data source.
results list(object): List of bare metal server interfaces matching the criteria. Each interface contains:
bms_external_id string: External ID of the parent bare metal server.
display_name string: Display name of the bare metal server interface.
source_id string: Source ID of the bare metal server interface.
tag string: Tag value.
tag_scope string

id String: ID of the data source.
results List<GetPolicyBaremetalServerInterfacesResult>: List of bare metal server interfaces matching the criteria. Each interface contains:
bmsExternalId String: External ID of the parent bare metal server.
displayName String: Display name of the bare metal server interface.
sourceId String: Source ID of the bare metal server interface.
tag String: Tag value.
tagScope String

id string: ID of the data source.
results GetPolicyBaremetalServerInterfacesResult[]: List of bare metal server interfaces matching the criteria. Each interface contains:
bmsExternalId string: External ID of the parent bare metal server.
displayName string: Display name of the bare metal server interface.
sourceId string: Source ID of the bare metal server interface.
tag string: Tag value.
tagScope string

id str: ID of the data source.
results Sequence[GetPolicyBaremetalServerInterfacesResult]: List of bare metal server interfaces matching the criteria. Each interface contains:
bms_external_id str: External ID of the parent bare metal server.
display_name str: Display name of the bare metal server interface.
source_id str: Source ID of the bare metal server interface.
tag str: Tag value.
tag_scope str

id String: ID of the data source.
results List<Property Map>: List of bare metal server interfaces matching the criteria. Each interface contains:
bmsExternalId String: External ID of the parent bare metal server.
displayName String: Display name of the bare metal server interface.
sourceId String: Source ID of the bare metal server interface.
tag String: Tag value.
tagScope String

Supporting Types

GetPolicyBaremetalServerInterfacesResult

BmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
DisplayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
ExternalId string: External ID of the bare metal server interface.
IpAddresses List<string>: List of IP addresses assigned to the interface.
IsMgmtInterface bool: Whether this is a management interface.
LastSyncTime double: Last synchronization time.
ResourceType string: Resource type.
SourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
State string: State of the interface (UP, DOWN, etc.).
Tags List<GetPolicyBaremetalServerInterfacesResultTag>: List of tags applied to the interface. Each tag contains:

BmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
DisplayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
ExternalId string: External ID of the bare metal server interface.
IpAddresses []string: List of IP addresses assigned to the interface.
IsMgmtInterface bool: Whether this is a management interface.
LastSyncTime float64: Last synchronization time.
ResourceType string: Resource type.
SourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
State string: State of the interface (UP, DOWN, etc.).
Tags []GetPolicyBaremetalServerInterfacesResultTag: List of tags applied to the interface. Each tag contains:

bms_external_id string: Filter by parent bare metal server external ID. Default is empty (no filtering).
display_name string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
external_id string: External ID of the bare metal server interface.
ip_addresses list(string): List of IP addresses assigned to the interface.
is_mgmt_interface bool: Whether this is a management interface.
last_sync_time number: Last synchronization time.
resource_type string: Resource type.
source_id string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
state string: State of the interface (UP, DOWN, etc.).
tags list(object): List of tags applied to the interface. Each tag contains:

bmsExternalId String: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName String: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
externalId String: External ID of the bare metal server interface.
ipAddresses List<String>: List of IP addresses assigned to the interface.
isMgmtInterface Boolean: Whether this is a management interface.
lastSyncTime Double: Last synchronization time.
resourceType String: Resource type.
sourceId String: Filter by source (bare metal controller) ID. Default is empty (no filtering).
state String: State of the interface (UP, DOWN, etc.).
tags List<GetPolicyBaremetalServerInterfacesResultTag>: List of tags applied to the interface. Each tag contains:

bmsExternalId string: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName string: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
externalId string: External ID of the bare metal server interface.
ipAddresses string[]: List of IP addresses assigned to the interface.
isMgmtInterface boolean: Whether this is a management interface.
lastSyncTime number: Last synchronization time.
resourceType string: Resource type.
sourceId string: Filter by source (bare metal controller) ID. Default is empty (no filtering).
state string: State of the interface (UP, DOWN, etc.).
tags GetPolicyBaremetalServerInterfacesResultTag[]: List of tags applied to the interface. Each tag contains:

bms_external_id str: Filter by parent bare metal server external ID. Default is empty (no filtering).
display_name str: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
external_id str: External ID of the bare metal server interface.
ip_addresses Sequence[str]: List of IP addresses assigned to the interface.
is_mgmt_interface bool: Whether this is a management interface.
last_sync_time float: Last synchronization time.
resource_type str: Resource type.
source_id str: Filter by source (bare metal controller) ID. Default is empty (no filtering).
state str: State of the interface (UP, DOWN, etc.).
tags Sequence[GetPolicyBaremetalServerInterfacesResultTag]: List of tags applied to the interface. Each tag contains:

bmsExternalId String: Filter by parent bare metal server external ID. Default is empty (no filtering).
displayName String: Regex pattern to filter bare metal server interfaces by display name. Default is empty (no filtering).
externalId String: External ID of the bare metal server interface.
ipAddresses List<String>: List of IP addresses assigned to the interface.
isMgmtInterface Boolean: Whether this is a management interface.
lastSyncTime Number: Last synchronization time.
resourceType String: Resource type.
sourceId String: Filter by source (bare metal controller) ID. Default is empty (no filtering).
state String: State of the interface (UP, DOWN, etc.).
tags List<Property Map>: List of tags applied to the interface. Each tag contains:

GetPolicyBaremetalServerInterfacesResultTag

Scope string: Tag scope.
Tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

Scope string: Tag scope.
Tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

scope string: Tag scope.
tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

scope String: Tag scope.
tag String: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

scope string: Tag scope.
tag string: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

scope str: Tag scope.
tag str: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

scope String: Tag scope.
tag String: Filter by tag value. This filter is applied server-side for better performance. Default is empty (no filtering).

Package Details

Repository: nsxt vmware/terraform-provider-nsxt
License
Notes: This Pulumi package is based on the nsxt Terraform Provider.

Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-nsxt

nsxt.getPolicyBaremetalServerInterfaces

On this page

On this page

Example Usage

Using getPolicyBaremetalServerInterfaces

getPolicyBaremetalServerInterfaces Result

Supporting Types

GetPolicyBaremetalServerInterfacesResult

GetPolicyBaremetalServerInterfacesResultTag

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

nsxt.getPolicyBaremetalServerInterfaces

On this page

On this page

Example Usage

Using getPolicyBaremetalServerInterfaces

getPolicyBaremetalServerInterfaces Result

Supporting Types

GetPolicyBaremetalServerInterfacesResult

GetPolicyBaremetalServerInterfacesResultTag

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.