1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyBfdProfile
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.getPolicyBfdProfile

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    This data source provides information about policy BFD Profile configured on NSX. This data source is applicable to NSX Global Manager, NSX Policy Manager and VMC (NSX version 3.0.0 onwards).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const test = nsxt.getPolicyBfdProfile({
        displayName: "profile1",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_policy_bfd_profile(display_name="profile1")
    
    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.GetPolicyBfdProfile(ctx, &nsxt.GetPolicyBfdProfileArgs{
    			DisplayName: pulumi.StringRef("profile1"),
    		}, 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.GetPolicyBfdProfile.Invoke(new()
        {
            DisplayName = "profile1",
        });
    
    });
    
    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.GetPolicyBfdProfileArgs;
    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.getPolicyBfdProfile(GetPolicyBfdProfileArgs.builder()
                .displayName("profile1")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getPolicyBfdProfile
          arguments:
            displayName: profile1
    

    Using getPolicyBfdProfile

    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 getPolicyBfdProfile(args: GetPolicyBfdProfileArgs, opts?: InvokeOptions): Promise<GetPolicyBfdProfileResult>
    function getPolicyBfdProfileOutput(args: GetPolicyBfdProfileOutputArgs, opts?: InvokeOptions): Output<GetPolicyBfdProfileResult>
    def get_policy_bfd_profile(description: Optional[str] = None,
                               display_name: Optional[str] = None,
                               id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetPolicyBfdProfileResult
    def get_policy_bfd_profile_output(description: Optional[pulumi.Input[str]] = None,
                               display_name: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetPolicyBfdProfileResult]
    func GetPolicyBfdProfile(ctx *Context, args *GetPolicyBfdProfileArgs, opts ...InvokeOption) (*GetPolicyBfdProfileResult, error)
    func GetPolicyBfdProfileOutput(ctx *Context, args *GetPolicyBfdProfileOutputArgs, opts ...InvokeOption) GetPolicyBfdProfileResultOutput

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

    public static class GetPolicyBfdProfile 
    {
        public static Task<GetPolicyBfdProfileResult> InvokeAsync(GetPolicyBfdProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyBfdProfileResult> Invoke(GetPolicyBfdProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyBfdProfileResult> getPolicyBfdProfile(GetPolicyBfdProfileArgs args, InvokeOptions options)
    public static Output<GetPolicyBfdProfileResult> getPolicyBfdProfile(GetPolicyBfdProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyBfdProfile:getPolicyBfdProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Profile to retrieve.
    Id string
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Profile to retrieve.
    Id string
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Profile to retrieve.
    id String
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the Profile to retrieve.
    id string
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the Profile to retrieve.
    id str
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Profile to retrieve.
    id String
    The ID of Profile to retrieve. If ID is specified, no additional argument should be configured.

    getPolicyBfdProfile Result

    The following output properties are available:

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

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware