1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getPolicyIdpsClusterConfig
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware

    This data source provides information about an IDPS cluster configuration in NSX Policy manager.

    This data source is applicable to NSX Policy Manager (NSX version 4.2.0 onwards).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const cluster1 = nsxt.getPolicyIdpsClusterConfig({
        displayName: "cluster1-idps-config",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    cluster1 = nsxt.get_policy_idps_cluster_config(display_name="cluster1-idps-config")
    
    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.LookupPolicyIdpsClusterConfig(ctx, &nsxt.LookupPolicyIdpsClusterConfigArgs{
    			DisplayName: pulumi.StringRef("cluster1-idps-config"),
    		}, 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 cluster1 = Nsxt.GetPolicyIdpsClusterConfig.Invoke(new()
        {
            DisplayName = "cluster1-idps-config",
        });
    
    });
    
    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.GetPolicyIdpsClusterConfigArgs;
    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 cluster1 = NsxtFunctions.getPolicyIdpsClusterConfig(GetPolicyIdpsClusterConfigArgs.builder()
                .displayName("cluster1-idps-config")
                .build());
    
        }
    }
    
    variables:
      cluster1:
        fn::invoke:
          function: nsxt:getPolicyIdpsClusterConfig
          arguments:
            displayName: cluster1-idps-config
    
    Example coming soon!
    

    Using getPolicyIdpsClusterConfig

    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 getPolicyIdpsClusterConfig(args: GetPolicyIdpsClusterConfigArgs, opts?: InvokeOptions): Promise<GetPolicyIdpsClusterConfigResult>
    function getPolicyIdpsClusterConfigOutput(args: GetPolicyIdpsClusterConfigOutputArgs, opts?: InvokeOptions): Output<GetPolicyIdpsClusterConfigResult>
    def get_policy_idps_cluster_config(description: Optional[str] = None,
                                       display_name: Optional[str] = None,
                                       id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetPolicyIdpsClusterConfigResult
    def get_policy_idps_cluster_config_output(description: pulumi.Input[Optional[str]] = None,
                                       display_name: pulumi.Input[Optional[str]] = None,
                                       id: pulumi.Input[Optional[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetPolicyIdpsClusterConfigResult]
    func LookupPolicyIdpsClusterConfig(ctx *Context, args *LookupPolicyIdpsClusterConfigArgs, opts ...InvokeOption) (*LookupPolicyIdpsClusterConfigResult, error)
    func LookupPolicyIdpsClusterConfigOutput(ctx *Context, args *LookupPolicyIdpsClusterConfigOutputArgs, opts ...InvokeOption) LookupPolicyIdpsClusterConfigResultOutput

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

    public static class GetPolicyIdpsClusterConfig 
    {
        public static Task<GetPolicyIdpsClusterConfigResult> InvokeAsync(GetPolicyIdpsClusterConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyIdpsClusterConfigResult> Invoke(GetPolicyIdpsClusterConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyIdpsClusterConfigResult> getPolicyIdpsClusterConfig(GetPolicyIdpsClusterConfigArgs args, InvokeOptions options)
    public static Output<GetPolicyIdpsClusterConfigResult> getPolicyIdpsClusterConfig(GetPolicyIdpsClusterConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyIdpsClusterConfig:getPolicyIdpsClusterConfig
      arguments:
        # arguments dictionary
    data "nsxt_getpolicyidpsclusterconfig" "name" {
        # arguments
    }

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    Id string
    The ID of the IDPS cluster configuration to retrieve.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    Id string
    The ID of the IDPS cluster configuration to retrieve.
    description string
    The description of the resource.
    display_name string
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    id string
    The ID of the IDPS cluster configuration to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    id String
    The ID of the IDPS cluster configuration to retrieve.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    id string
    The ID of the IDPS cluster configuration to retrieve.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    id str
    The ID of the IDPS cluster configuration to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the IDPS cluster configuration to retrieve.
    id String
    The ID of the IDPS cluster configuration to retrieve.

    getPolicyIdpsClusterConfig Result

    The following output properties are available:

    Clusters List<GetPolicyIdpsClusterConfigCluster>
    Cluster reference configuration.
    Description string
    The description of the resource.
    DisplayName string
    Id string
    IdsEnabled bool
    Whether IDPS is enabled on this cluster.
    Path string
    The NSX path of the policy resource.
    Clusters []GetPolicyIdpsClusterConfigCluster
    Cluster reference configuration.
    Description string
    The description of the resource.
    DisplayName string
    Id string
    IdsEnabled bool
    Whether IDPS is enabled on this cluster.
    Path string
    The NSX path of the policy resource.
    clusters list(object)
    Cluster reference configuration.
    description string
    The description of the resource.
    display_name string
    id string
    ids_enabled bool
    Whether IDPS is enabled on this cluster.
    path string
    The NSX path of the policy resource.
    clusters List<GetPolicyIdpsClusterConfigCluster>
    Cluster reference configuration.
    description String
    The description of the resource.
    displayName String
    id String
    idsEnabled Boolean
    Whether IDPS is enabled on this cluster.
    path String
    The NSX path of the policy resource.
    clusters GetPolicyIdpsClusterConfigCluster[]
    Cluster reference configuration.
    description string
    The description of the resource.
    displayName string
    id string
    idsEnabled boolean
    Whether IDPS is enabled on this cluster.
    path string
    The NSX path of the policy resource.
    clusters Sequence[GetPolicyIdpsClusterConfigCluster]
    Cluster reference configuration.
    description str
    The description of the resource.
    display_name str
    id str
    ids_enabled bool
    Whether IDPS is enabled on this cluster.
    path str
    The NSX path of the policy resource.
    clusters List<Property Map>
    Cluster reference configuration.
    description String
    The description of the resource.
    displayName String
    id String
    idsEnabled Boolean
    Whether IDPS is enabled on this cluster.
    path String
    The NSX path of the policy resource.

    Supporting Types

    GetPolicyIdpsClusterConfigCluster

    TargetId string
    Cluster target ID (e.g., domain-c123).
    TargetType string
    Target type (e.g., VC_Cluster).
    TargetId string
    Cluster target ID (e.g., domain-c123).
    TargetType string
    Target type (e.g., VC_Cluster).
    target_id string
    Cluster target ID (e.g., domain-c123).
    target_type string
    Target type (e.g., VC_Cluster).
    targetId String
    Cluster target ID (e.g., domain-c123).
    targetType String
    Target type (e.g., VC_Cluster).
    targetId string
    Cluster target ID (e.g., domain-c123).
    targetType string
    Target type (e.g., VC_Cluster).
    target_id str
    Cluster target ID (e.g., domain-c123).
    target_type str
    Target type (e.g., VC_Cluster).
    targetId String
    Cluster target ID (e.g., domain-c123).
    targetType String
    Target type (e.g., VC_Cluster).

    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.0
    published on Monday, May 18, 2026 by vmware

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial