Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getPolicyIdpsCustomSignature
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

nsxt.getPolicyIdpsCustomSignature

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

    This data source reads one IDPS custom signature by ID. You can specify the ID as a composite value signature_version_id/signature_id or as a standalone signature ID together with signature_version_id.

    Applicable to NSX Policy Manager (NSX 4.2.0 onwards).

    Example Usage

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

// By composite ID (from resource)
const sig = nsxt.getPolicyIdpsCustomSignature({
    id: malware.id,
});
// By signature ID and version
const byId = nsxt.getPolicyIdpsCustomSignature({
    id: "5000001",
    signatureVersionId: "default",
});
export const validationStatus = sig.then(sig => sig.validationStatus);

    import pulumi
import pulumi_nsxt as nsxt

# By composite ID (from resource)
sig = nsxt.get_policy_idps_custom_signature(id=malware["id"])
# By signature ID and version
by_id = nsxt.get_policy_idps_custom_signature(id="5000001",
    signature_version_id="default")
pulumi.export("validationStatus", sig.validation_status)

    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 {
		// By composite ID (from resource)
		sig, err := nsxt.LookupPolicyIdpsCustomSignature(ctx, &nsxt.LookupPolicyIdpsCustomSignatureArgs{
			Id: malware.Id,
		}, nil)
		if err != nil {
			return err
		}
		// By signature ID and version
		_, err = nsxt.LookupPolicyIdpsCustomSignature(ctx, &nsxt.LookupPolicyIdpsCustomSignatureArgs{
			Id:                 "5000001",
			SignatureVersionId: pulumi.StringRef("default"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("validationStatus", sig.ValidationStatus)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // By composite ID (from resource)
    var sig = Nsxt.GetPolicyIdpsCustomSignature.Invoke(new()
    {
        Id = malware.Id,
    });

    // By signature ID and version
    var byId = Nsxt.GetPolicyIdpsCustomSignature.Invoke(new()
    {
        Id = "5000001",
        SignatureVersionId = "default",
    });

    return new Dictionary<string, object?>
    {
        ["validationStatus"] = sig.Apply(getPolicyIdpsCustomSignatureResult => getPolicyIdpsCustomSignatureResult.ValidationStatus),
    };
});

    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.GetPolicyIdpsCustomSignatureArgs;
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) {
        // By composite ID (from resource)
        final var sig = NsxtFunctions.getPolicyIdpsCustomSignature(GetPolicyIdpsCustomSignatureArgs.builder()
            .id(malware.id())
            .build());

        // By signature ID and version
        final var byId = NsxtFunctions.getPolicyIdpsCustomSignature(GetPolicyIdpsCustomSignatureArgs.builder()
            .id("5000001")
            .signatureVersionId("default")
            .build());

        ctx.export("validationStatus", sig.validationStatus());
    }
}

    variables:
  # By composite ID (from resource)
  sig:
    fn::invoke:
      function: nsxt:getPolicyIdpsCustomSignature
      arguments:
        id: ${malware.id}
  # By signature ID and version
  byId:
    fn::invoke:
      function: nsxt:getPolicyIdpsCustomSignature
      arguments:
        id: '5000001'
        signatureVersionId: default
outputs:
  validationStatus: ${sig.validationStatus}

    Example coming soon!

    Using getPolicyIdpsCustomSignature

    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 getPolicyIdpsCustomSignature(args: GetPolicyIdpsCustomSignatureArgs, opts?: InvokeOptions): Promise<GetPolicyIdpsCustomSignatureResult>
function getPolicyIdpsCustomSignatureOutput(args: GetPolicyIdpsCustomSignatureOutputArgs, opts?: InvokeOptions): Output<GetPolicyIdpsCustomSignatureResult>
    def get_policy_idps_custom_signature(id: Optional[str] = None,
                                     signature_version_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPolicyIdpsCustomSignatureResult
def get_policy_idps_custom_signature_output(id: pulumi.Input[Optional[str]] = None,
                                     signature_version_id: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetPolicyIdpsCustomSignatureResult]
    func LookupPolicyIdpsCustomSignature(ctx *Context, args *LookupPolicyIdpsCustomSignatureArgs, opts ...InvokeOption) (*LookupPolicyIdpsCustomSignatureResult, error)
func LookupPolicyIdpsCustomSignatureOutput(ctx *Context, args *LookupPolicyIdpsCustomSignatureOutputArgs, opts ...InvokeOption) LookupPolicyIdpsCustomSignatureResultOutput

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

    public static class GetPolicyIdpsCustomSignature 
{
    public static Task<GetPolicyIdpsCustomSignatureResult> InvokeAsync(GetPolicyIdpsCustomSignatureArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyIdpsCustomSignatureResult> Invoke(GetPolicyIdpsCustomSignatureInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPolicyIdpsCustomSignatureResult> getPolicyIdpsCustomSignature(GetPolicyIdpsCustomSignatureArgs args, InvokeOptions options)
public static Output<GetPolicyIdpsCustomSignatureResult> getPolicyIdpsCustomSignature(GetPolicyIdpsCustomSignatureArgs args, InvokeOptions options)

    fn::invoke:
  function: nsxt:index/getPolicyIdpsCustomSignature:getPolicyIdpsCustomSignature
  arguments:
    # arguments dictionary
    data "nsxt_getpolicyidpscustomsignature" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    SignatureVersionId string
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    Id string
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    SignatureVersionId string
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    id string
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    signature_version_id string
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    id String
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    signatureVersionId String
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    id string
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    signatureVersionId string
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    id str
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    signature_version_id str
    Custom signature version ID (e.g. default). Required when id is only the signature ID.
    id String
    ID of the custom signature. Use format signature_version_id/signature_id (e.g. default/5000001), or the signature ID only when signature_version_id is set.
    signatureVersionId String
    Custom signature version ID (e.g. default). Required when id is only the signature ID.

    getPolicyIdpsCustomSignature Result

    The following output properties are available:

    DisplayName string
    Display name.
    Enable bool
    Whether the signature is enabled.
    Id string
    Name string
    Signature name (from msg in rule).
    OriginalSignature string
    Original raw signature (Snort rule).
    OriginalSignatureId string
    Original signature ID from the rule.
    Path string
    Absolute path of the custom signature.
    Revision double
    Revision of the custom signature.
    Severity string
    Severity of the signature.
    SignatureId string
    System-assigned signature ID.
    SignatureRevision string
    Signature revision from the rule.
    SignatureSeverity string
    Vendor-assigned signature severity.
    ValidationMessage string
    Validation message or error if invalid.
    ValidationStatus string
    One of: VALID, INVALID, PENDING, WARNING.
    SignatureVersionId string
    DisplayName string
    Display name.
    Enable bool
    Whether the signature is enabled.
    Id string
    Name string
    Signature name (from msg in rule).
    OriginalSignature string
    Original raw signature (Snort rule).
    OriginalSignatureId string
    Original signature ID from the rule.
    Path string
    Absolute path of the custom signature.
    Revision float64
    Revision of the custom signature.
    Severity string
    Severity of the signature.
    SignatureId string
    System-assigned signature ID.
    SignatureRevision string
    Signature revision from the rule.
    SignatureSeverity string
    Vendor-assigned signature severity.
    ValidationMessage string
    Validation message or error if invalid.
    ValidationStatus string
    One of: VALID, INVALID, PENDING, WARNING.
    SignatureVersionId string
    display_name string
    Display name.
    enable bool
    Whether the signature is enabled.
    id string
    name string
    Signature name (from msg in rule).
    original_signature string
    Original raw signature (Snort rule).
    original_signature_id string
    Original signature ID from the rule.
    path string
    Absolute path of the custom signature.
    revision number
    Revision of the custom signature.
    severity string
    Severity of the signature.
    signature_id string
    System-assigned signature ID.
    signature_revision string
    Signature revision from the rule.
    signature_severity string
    Vendor-assigned signature severity.
    validation_message string
    Validation message or error if invalid.
    validation_status string
    One of: VALID, INVALID, PENDING, WARNING.
    signature_version_id string
    displayName String
    Display name.
    enable Boolean
    Whether the signature is enabled.
    id String
    name String
    Signature name (from msg in rule).
    originalSignature String
    Original raw signature (Snort rule).
    originalSignatureId String
    Original signature ID from the rule.
    path String
    Absolute path of the custom signature.
    revision Double
    Revision of the custom signature.
    severity String
    Severity of the signature.
    signatureId String
    System-assigned signature ID.
    signatureRevision String
    Signature revision from the rule.
    signatureSeverity String
    Vendor-assigned signature severity.
    validationMessage String
    Validation message or error if invalid.
    validationStatus String
    One of: VALID, INVALID, PENDING, WARNING.
    signatureVersionId String
    displayName string
    Display name.
    enable boolean
    Whether the signature is enabled.
    id string
    name string
    Signature name (from msg in rule).
    originalSignature string
    Original raw signature (Snort rule).
    originalSignatureId string
    Original signature ID from the rule.
    path string
    Absolute path of the custom signature.
    revision number
    Revision of the custom signature.
    severity string
    Severity of the signature.
    signatureId string
    System-assigned signature ID.
    signatureRevision string
    Signature revision from the rule.
    signatureSeverity string
    Vendor-assigned signature severity.
    validationMessage string
    Validation message or error if invalid.
    validationStatus string
    One of: VALID, INVALID, PENDING, WARNING.
    signatureVersionId string
    display_name str
    Display name.
    enable bool
    Whether the signature is enabled.
    id str
    name str
    Signature name (from msg in rule).
    original_signature str
    Original raw signature (Snort rule).
    original_signature_id str
    Original signature ID from the rule.
    path str
    Absolute path of the custom signature.
    revision float
    Revision of the custom signature.
    severity str
    Severity of the signature.
    signature_id str
    System-assigned signature ID.
    signature_revision str
    Signature revision from the rule.
    signature_severity str
    Vendor-assigned signature severity.
    validation_message str
    Validation message or error if invalid.
    validation_status str
    One of: VALID, INVALID, PENDING, WARNING.
    signature_version_id str
    displayName String
    Display name.
    enable Boolean
    Whether the signature is enabled.
    id String
    name String
    Signature name (from msg in rule).
    originalSignature String
    Original raw signature (Snort rule).
    originalSignatureId String
    Original signature ID from the rule.
    path String
    Absolute path of the custom signature.
    revision Number
    Revision of the custom signature.
    severity String
    Severity of the signature.
    signatureId String
    System-assigned signature ID.
    signatureRevision String
    Signature revision from the rule.
    signatureSeverity String
    Vendor-assigned signature severity.
    validationMessage String
    Validation message or error if invalid.
    validationStatus String
    One of: VALID, INVALID, PENDING, WARNING.
    signatureVersionId 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.0
    published on Monday, May 18, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-nsxt

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial