1. Registry
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getPolicyRouteControllerInterface
Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware

    This data source provides information about a Route Controller Interface configured in NSX.

    This data source is applicable to NSX Policy Manager.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const test = nsxt.getPolicyRouteControllerInterface({
        displayName: "my-interface",
        parentPath: "/infra/route-controllers/my-controller",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_policy_route_controller_interface(display_name="my-interface",
        parent_path="/infra/route-controllers/my-controller")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nsxt.LookupPolicyRouteControllerInterface(ctx, &nsxt.LookupPolicyRouteControllerInterfaceArgs{
    			DisplayName: pulumi.StringRef("my-interface"),
    			ParentPath:  pulumi.StringRef("/infra/route-controllers/my-controller"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Nsxt.GetPolicyRouteControllerInterface.Invoke(new()
        {
            DisplayName = "my-interface",
            ParentPath = "/infra/route-controllers/my-controller",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyRouteControllerInterfaceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = NsxtFunctions.getPolicyRouteControllerInterface(GetPolicyRouteControllerInterfaceArgs.builder()
                .displayName("my-interface")
                .parentPath("/infra/route-controllers/my-controller")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getPolicyRouteControllerInterface
          arguments:
            displayName: my-interface
            parentPath: /infra/route-controllers/my-controller
    
    Example coming soon!
    

    Using getPolicyRouteControllerInterface

    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 getPolicyRouteControllerInterface(args: GetPolicyRouteControllerInterfaceArgs, opts?: InvokeOptions): Promise<GetPolicyRouteControllerInterfaceResult>
    function getPolicyRouteControllerInterfaceOutput(args: GetPolicyRouteControllerInterfaceOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyRouteControllerInterfaceResult>
    def get_policy_route_controller_interface(description: Optional[str] = None,
                                              display_name: Optional[str] = None,
                                              id: Optional[str] = None,
                                              parent_path: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetPolicyRouteControllerInterfaceResult
    def get_policy_route_controller_interface_output(description: pulumi.Input[Optional[str]] = None,
                                              display_name: pulumi.Input[Optional[str]] = None,
                                              id: pulumi.Input[Optional[str]] = None,
                                              parent_path: pulumi.Input[Optional[str]] = None,
                                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyRouteControllerInterfaceResult]
    func LookupPolicyRouteControllerInterface(ctx *Context, args *LookupPolicyRouteControllerInterfaceArgs, opts ...InvokeOption) (*LookupPolicyRouteControllerInterfaceResult, error)
    func LookupPolicyRouteControllerInterfaceOutput(ctx *Context, args *LookupPolicyRouteControllerInterfaceOutputArgs, opts ...InvokeOption) LookupPolicyRouteControllerInterfaceResultOutput

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

    public static class GetPolicyRouteControllerInterface 
    {
        public static Task<GetPolicyRouteControllerInterfaceResult> InvokeAsync(GetPolicyRouteControllerInterfaceArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyRouteControllerInterfaceResult> Invoke(GetPolicyRouteControllerInterfaceInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyRouteControllerInterfaceResult> Invoke(GetPolicyRouteControllerInterfaceInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPolicyRouteControllerInterfaceResult> getPolicyRouteControllerInterface(GetPolicyRouteControllerInterfaceArgs args, InvokeOptions options)
    public static Output<GetPolicyRouteControllerInterfaceResult> getPolicyRouteControllerInterface(GetPolicyRouteControllerInterfaceArgs args, InvokeOptions options)
    public static Output<GetPolicyRouteControllerInterfaceResult> getPolicyRouteControllerInterface(GetPolicyRouteControllerInterfaceArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyRouteControllerInterface:getPolicyRouteControllerInterface
      arguments:
        # arguments dictionary
    data "nsxt_get_policy_route_controller_interface" "name" {
        # arguments
    }

    The following arguments are supported:

    Description string
    The description of the Interface to retrieve.
    DisplayName string
    The Display Name of the Interface to retrieve.
    Id string
    The ID of the Interface to retrieve.
    ParentPath string
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    Description string
    The description of the Interface to retrieve.
    DisplayName string
    The Display Name of the Interface to retrieve.
    Id string
    The ID of the Interface to retrieve.
    ParentPath string
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    description string
    The description of the Interface to retrieve.
    display_name string
    The Display Name of the Interface to retrieve.
    id string
    The ID of the Interface to retrieve.
    parent_path string
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    description String
    The description of the Interface to retrieve.
    displayName String
    The Display Name of the Interface to retrieve.
    id String
    The ID of the Interface to retrieve.
    parentPath String
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    description string
    The description of the Interface to retrieve.
    displayName string
    The Display Name of the Interface to retrieve.
    id string
    The ID of the Interface to retrieve.
    parentPath string
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    description str
    The description of the Interface to retrieve.
    display_name str
    The Display Name of the Interface to retrieve.
    id str
    The ID of the Interface to retrieve.
    parent_path str
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.
    description String
    The description of the Interface to retrieve.
    displayName String
    The Display Name of the Interface to retrieve.
    id String
    The ID of the Interface to retrieve.
    parentPath String
    Policy path of the parent Route Controller. Narrows the search to interfaces belonging to this Route Controller.

    getPolicyRouteControllerInterface Result

    The following output properties are available:

    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Description string
    ParentPath string
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Description string
    ParentPath string
    display_name string
    id string
    path string
    The NSX path of the policy resource.
    description string
    parent_path string
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    parentPath String
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    description string
    parentPath string
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    description str
    parent_path str
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    parentPath String

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial