published on Monday, May 18, 2026 by vmware
published on Monday, May 18, 2026 by vmware
This data source provides information about an existing Intrusion Service Gateway Policy configured on NSX. It can be useful for fetching the IDPS Gateway Policy including all its embedded rules.
NOTE: This data source retrieves the policy including embedded rules, allowing you to refer IDPS Gateway policy details and its rules in other resources. For different use cases, consider:
nsxt.PolicyParentIntrusionServiceGatewayPolicy- For IDPS Gateway policy metadata only (no rules)nsxt.PolicyIntrusionServiceGatewayPolicyRule- For individual standalone IDPS Gateway rules
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 idpsGatewayPolicy = nsxt.getPolicyIntrusionServiceGatewayPolicy({
displayName: "intrusion-service-gateway-policy",
});
import pulumi
import pulumi_nsxt as nsxt
idps_gateway_policy = nsxt.get_policy_intrusion_service_gateway_policy(display_name="intrusion-service-gateway-policy")
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.LookupPolicyIntrusionServiceGatewayPolicy(ctx, &nsxt.LookupPolicyIntrusionServiceGatewayPolicyArgs{
DisplayName: pulumi.StringRef("intrusion-service-gateway-policy"),
}, 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 idpsGatewayPolicy = Nsxt.GetPolicyIntrusionServiceGatewayPolicy.Invoke(new()
{
DisplayName = "intrusion-service-gateway-policy",
});
});
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.GetPolicyIntrusionServiceGatewayPolicyArgs;
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 idpsGatewayPolicy = NsxtFunctions.getPolicyIntrusionServiceGatewayPolicy(GetPolicyIntrusionServiceGatewayPolicyArgs.builder()
.displayName("intrusion-service-gateway-policy")
.build());
}
}
variables:
idpsGatewayPolicy:
fn::invoke:
function: nsxt:getPolicyIntrusionServiceGatewayPolicy
arguments:
displayName: intrusion-service-gateway-policy
Example coming soon!
Using getPolicyIntrusionServiceGatewayPolicy
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 getPolicyIntrusionServiceGatewayPolicy(args: GetPolicyIntrusionServiceGatewayPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyIntrusionServiceGatewayPolicyResult>
function getPolicyIntrusionServiceGatewayPolicyOutput(args: GetPolicyIntrusionServiceGatewayPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyIntrusionServiceGatewayPolicyResult>def get_policy_intrusion_service_gateway_policy(category: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
domain: Optional[str] = None,
id: Optional[str] = None,
rules: Optional[Sequence[GetPolicyIntrusionServiceGatewayPolicyRule]] = None,
tags: Optional[Sequence[GetPolicyIntrusionServiceGatewayPolicyTag]] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyIntrusionServiceGatewayPolicyResult
def get_policy_intrusion_service_gateway_policy_output(category: pulumi.Input[Optional[str]] = None,
description: pulumi.Input[Optional[str]] = None,
display_name: pulumi.Input[Optional[str]] = None,
domain: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
rules: pulumi.Input[Optional[Sequence[pulumi.Input[GetPolicyIntrusionServiceGatewayPolicyRuleArgs]]]] = None,
tags: pulumi.Input[Optional[Sequence[pulumi.Input[GetPolicyIntrusionServiceGatewayPolicyTagArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPolicyIntrusionServiceGatewayPolicyResult]func LookupPolicyIntrusionServiceGatewayPolicy(ctx *Context, args *LookupPolicyIntrusionServiceGatewayPolicyArgs, opts ...InvokeOption) (*LookupPolicyIntrusionServiceGatewayPolicyResult, error)
func LookupPolicyIntrusionServiceGatewayPolicyOutput(ctx *Context, args *LookupPolicyIntrusionServiceGatewayPolicyOutputArgs, opts ...InvokeOption) LookupPolicyIntrusionServiceGatewayPolicyResultOutput> Note: This function is named LookupPolicyIntrusionServiceGatewayPolicy in the Go SDK.
public static class GetPolicyIntrusionServiceGatewayPolicy
{
public static Task<GetPolicyIntrusionServiceGatewayPolicyResult> InvokeAsync(GetPolicyIntrusionServiceGatewayPolicyArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyIntrusionServiceGatewayPolicyResult> Invoke(GetPolicyIntrusionServiceGatewayPolicyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPolicyIntrusionServiceGatewayPolicyResult> getPolicyIntrusionServiceGatewayPolicy(GetPolicyIntrusionServiceGatewayPolicyArgs args, InvokeOptions options)
public static Output<GetPolicyIntrusionServiceGatewayPolicyResult> getPolicyIntrusionServiceGatewayPolicy(GetPolicyIntrusionServiceGatewayPolicyArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getPolicyIntrusionServiceGatewayPolicy:getPolicyIntrusionServiceGatewayPolicy
arguments:
# arguments dictionarydata "nsxt_getpolicyintrusionservicegatewaypolicy" "name" {
# arguments
}The following arguments are supported:
- Category string
- Category of the policy.
- Description string
- The description of the rule.
- Display
Name string - The display name of the policy to retrieve.
- Domain string
- The domain of the policy. Defaults to
default. - Id string
- The ID of the policy to retrieve.
- Rules
List<Get
Policy Intrusion Service Gateway Policy Rule> - A list of rules in this policy. Each rule contains:
-
List<Get
Policy Intrusion Service Gateway Policy Tag> - A list of scope + tag pairs associated with this rule.
- Category string
- Category of the policy.
- Description string
- The description of the rule.
- Display
Name string - The display name of the policy to retrieve.
- Domain string
- The domain of the policy. Defaults to
default. - Id string
- The ID of the policy to retrieve.
- Rules
[]Get
Policy Intrusion Service Gateway Policy Rule Type - A list of rules in this policy. Each rule contains:
-
[]Get
Policy Intrusion Service Gateway Policy Tag - A list of scope + tag pairs associated with this rule.
- category string
- Category of the policy.
- description string
- The description of the rule.
- display_
name string - The display name of the policy to retrieve.
- domain string
- The domain of the policy. Defaults to
default. - id string
- The ID of the policy to retrieve.
- rules list(object)
- A list of rules in this policy. Each rule contains:
- list(object)
- A list of scope + tag pairs associated with this rule.
- category String
- Category of the policy.
- description String
- The description of the rule.
- display
Name String - The display name of the policy to retrieve.
- domain String
- The domain of the policy. Defaults to
default. - id String
- The ID of the policy to retrieve.
- rules
List<Get
Policy Intrusion Service Gateway Policy Rule> - A list of rules in this policy. Each rule contains:
-
List<Get
Policy Intrusion Service Gateway Policy Tag> - A list of scope + tag pairs associated with this rule.
- category string
- Category of the policy.
- description string
- The description of the rule.
- display
Name string - The display name of the policy to retrieve.
- domain string
- The domain of the policy. Defaults to
default. - id string
- The ID of the policy to retrieve.
- rules
Get
Policy Intrusion Service Gateway Policy Rule[] - A list of rules in this policy. Each rule contains:
-
Get
Policy Intrusion Service Gateway Policy Tag[] - A list of scope + tag pairs associated with this rule.
- category str
- Category of the policy.
- description str
- The description of the rule.
- display_
name str - The display name of the policy to retrieve.
- domain str
- The domain of the policy. Defaults to
default. - id str
- The ID of the policy to retrieve.
- rules
Sequence[Get
Policy Intrusion Service Gateway Policy Rule] - A list of rules in this policy. Each rule contains:
-
Sequence[Get
Policy Intrusion Service Gateway Policy Tag] - A list of scope + tag pairs associated with this rule.
- category String
- Category of the policy.
- description String
- The description of the rule.
- display
Name String - The display name of the policy to retrieve.
- domain String
- The domain of the policy. Defaults to
default. - id String
- The ID of the policy to retrieve.
- rules List<Property Map>
- A list of rules in this policy. Each rule contains:
- List<Property Map>
- A list of scope + tag pairs associated with this rule.
getPolicyIntrusionServiceGatewayPolicy Result
The following output properties are available:
- Category string
- Comments string
- Comments for security policy lock/unlock.
- Description string
- The description of the rule.
- Display
Name string - The display name of the rule.
- Id string
- Locked bool
- Indicates whether a security policy should be locked.
- Path string
- The NSX path of the policy resource.
- Revision double
- Indicates current revision number of the rule.
- Sequence
Number double - The sequence number of the rule.
- Stateful bool
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- Domain string
- Rules
List<Get
Policy Intrusion Service Gateway Policy Rule> - A list of rules in this policy. Each rule contains:
-
List<Get
Policy Intrusion Service Gateway Policy Tag> - A list of scope + tag pairs associated with this rule.
- Category string
- Comments string
- Comments for security policy lock/unlock.
- Description string
- The description of the rule.
- Display
Name string - The display name of the rule.
- Id string
- Locked bool
- Indicates whether a security policy should be locked.
- Path string
- The NSX path of the policy resource.
- Revision float64
- Indicates current revision number of the rule.
- Sequence
Number float64 - The sequence number of the rule.
- Stateful bool
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- Domain string
- Rules
[]Get
Policy Intrusion Service Gateway Policy Rule Type - A list of rules in this policy. Each rule contains:
-
[]Get
Policy Intrusion Service Gateway Policy Tag - A list of scope + tag pairs associated with this rule.
- category string
- comments string
- Comments for security policy lock/unlock.
- description string
- The description of the rule.
- display_
name string - The display name of the rule.
- id string
- locked bool
- Indicates whether a security policy should be locked.
- path string
- The NSX path of the policy resource.
- revision number
- Indicates current revision number of the rule.
- sequence_
number number - The sequence number of the rule.
- stateful bool
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- domain string
- rules list(object)
- A list of rules in this policy. Each rule contains:
- list(object)
- A list of scope + tag pairs associated with this rule.
- category String
- comments String
- Comments for security policy lock/unlock.
- description String
- The description of the rule.
- display
Name String - The display name of the rule.
- id String
- locked Boolean
- Indicates whether a security policy should be locked.
- path String
- The NSX path of the policy resource.
- revision Double
- Indicates current revision number of the rule.
- sequence
Number Double - The sequence number of the rule.
- stateful Boolean
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- domain String
- rules
List<Get
Policy Intrusion Service Gateway Policy Rule> - A list of rules in this policy. Each rule contains:
-
List<Get
Policy Intrusion Service Gateway Policy Tag> - A list of scope + tag pairs associated with this rule.
- category string
- comments string
- Comments for security policy lock/unlock.
- description string
- The description of the rule.
- display
Name string - The display name of the rule.
- id string
- locked boolean
- Indicates whether a security policy should be locked.
- path string
- The NSX path of the policy resource.
- revision number
- Indicates current revision number of the rule.
- sequence
Number number - The sequence number of the rule.
- stateful boolean
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- domain string
- rules
Get
Policy Intrusion Service Gateway Policy Rule[] - A list of rules in this policy. Each rule contains:
-
Get
Policy Intrusion Service Gateway Policy Tag[] - A list of scope + tag pairs associated with this rule.
- category str
- comments str
- Comments for security policy lock/unlock.
- description str
- The description of the rule.
- display_
name str - The display name of the rule.
- id str
- locked bool
- Indicates whether a security policy should be locked.
- path str
- The NSX path of the policy resource.
- revision float
- Indicates current revision number of the rule.
- sequence_
number float - The sequence number of the rule.
- stateful bool
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- domain str
- rules
Sequence[Get
Policy Intrusion Service Gateway Policy Rule] - A list of rules in this policy. Each rule contains:
-
Sequence[Get
Policy Intrusion Service Gateway Policy Tag] - A list of scope + tag pairs associated with this rule.
- category String
- comments String
- Comments for security policy lock/unlock.
- description String
- The description of the rule.
- display
Name String - The display name of the rule.
- id String
- locked Boolean
- Indicates whether a security policy should be locked.
- path String
- The NSX path of the policy resource.
- revision Number
- Indicates current revision number of the rule.
- sequence
Number Number - The sequence number of the rule.
- stateful Boolean
- When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Note: Intrusion Service Gateway Policies are always stateful.
- domain String
- rules List<Property Map>
- A list of rules in this policy. Each rule contains:
- List<Property Map>
- A list of scope + tag pairs associated with this rule.
Supporting Types
GetPolicyIntrusionServiceGatewayPolicyRule
- Display
Name string - The display name of the policy to retrieve.
- Ids
Profiles List<string> - List of IDS profiles for this rule.
- Nsx
Id string - NSX ID for this resource
- Path string
- The NSX path of the policy resource.
- Revision double
- Indicates current revision number of the rule.
- Rule
Id double - Unique positive number assigned by the system.
- Scopes List<string>
- List of objects where the rule is enforced.
- Sequence
Number double - The sequence number of the rule.
- Action string
- Action for this rule (DETECT, DETECT_PREVENT).
- Description string
- The description of the rule.
- Destination
Groups List<string> - List of destination groups.
- Destinations
Excluded bool - Flag to indicate whether destinations are negated.
- Direction string
- Traffic direction.
- Disabled bool
- Flag to disable the rule.
- Ip
Version string - IP version.
- Log
Label string - Additional information which will be propagated to the rule syslog.
- Logged bool
- Flag to enable logging.
- Notes string
- Additional notes for the rule.
- Services List<string>
- List of services.
- Source
Groups List<string> - List of source groups.
- Sources
Excluded bool - Flag to indicate whether sources are negated.
-
List<Get
Policy Intrusion Service Gateway Policy Rule Tag> - A list of scope + tag pairs associated with this rule.
- Display
Name string - The display name of the policy to retrieve.
- Ids
Profiles []string - List of IDS profiles for this rule.
- Nsx
Id string - NSX ID for this resource
- Path string
- The NSX path of the policy resource.
- Revision float64
- Indicates current revision number of the rule.
- Rule
Id float64 - Unique positive number assigned by the system.
- Scopes []string
- List of objects where the rule is enforced.
- Sequence
Number float64 - The sequence number of the rule.
- Action string
- Action for this rule (DETECT, DETECT_PREVENT).
- Description string
- The description of the rule.
- Destination
Groups []string - List of destination groups.
- Destinations
Excluded bool - Flag to indicate whether destinations are negated.
- Direction string
- Traffic direction.
- Disabled bool
- Flag to disable the rule.
- Ip
Version string - IP version.
- Log
Label string - Additional information which will be propagated to the rule syslog.
- Logged bool
- Flag to enable logging.
- Notes string
- Additional notes for the rule.
- Services []string
- List of services.
- Source
Groups []string - List of source groups.
- Sources
Excluded bool - Flag to indicate whether sources are negated.
-
[]Get
Policy Intrusion Service Gateway Policy Rule Tag - A list of scope + tag pairs associated with this rule.
- display_
name string - The display name of the policy to retrieve.
- ids_
profiles list(string) - List of IDS profiles for this rule.
- nsx_
id string - NSX ID for this resource
- path string
- The NSX path of the policy resource.
- revision number
- Indicates current revision number of the rule.
- rule_
id number - Unique positive number assigned by the system.
- scopes list(string)
- List of objects where the rule is enforced.
- sequence_
number number - The sequence number of the rule.
- action string
- Action for this rule (DETECT, DETECT_PREVENT).
- description string
- The description of the rule.
- destination_
groups list(string) - List of destination groups.
- destinations_
excluded bool - Flag to indicate whether destinations are negated.
- direction string
- Traffic direction.
- disabled bool
- Flag to disable the rule.
- ip_
version string - IP version.
- log_
label string - Additional information which will be propagated to the rule syslog.
- logged bool
- Flag to enable logging.
- notes string
- Additional notes for the rule.
- services list(string)
- List of services.
- source_
groups list(string) - List of source groups.
- sources_
excluded bool - Flag to indicate whether sources are negated.
- list(object)
- A list of scope + tag pairs associated with this rule.
- display
Name String - The display name of the policy to retrieve.
- ids
Profiles List<String> - List of IDS profiles for this rule.
- nsx
Id String - NSX ID for this resource
- path String
- The NSX path of the policy resource.
- revision Double
- Indicates current revision number of the rule.
- rule
Id Double - Unique positive number assigned by the system.
- scopes List<String>
- List of objects where the rule is enforced.
- sequence
Number Double - The sequence number of the rule.
- action String
- Action for this rule (DETECT, DETECT_PREVENT).
- description String
- The description of the rule.
- destination
Groups List<String> - List of destination groups.
- destinations
Excluded Boolean - Flag to indicate whether destinations are negated.
- direction String
- Traffic direction.
- disabled Boolean
- Flag to disable the rule.
- ip
Version String - IP version.
- log
Label String - Additional information which will be propagated to the rule syslog.
- logged Boolean
- Flag to enable logging.
- notes String
- Additional notes for the rule.
- services List<String>
- List of services.
- source
Groups List<String> - List of source groups.
- sources
Excluded Boolean - Flag to indicate whether sources are negated.
-
List<Get
Policy Intrusion Service Gateway Policy Rule Tag> - A list of scope + tag pairs associated with this rule.
- display
Name string - The display name of the policy to retrieve.
- ids
Profiles string[] - List of IDS profiles for this rule.
- nsx
Id string - NSX ID for this resource
- path string
- The NSX path of the policy resource.
- revision number
- Indicates current revision number of the rule.
- rule
Id number - Unique positive number assigned by the system.
- scopes string[]
- List of objects where the rule is enforced.
- sequence
Number number - The sequence number of the rule.
- action string
- Action for this rule (DETECT, DETECT_PREVENT).
- description string
- The description of the rule.
- destination
Groups string[] - List of destination groups.
- destinations
Excluded boolean - Flag to indicate whether destinations are negated.
- direction string
- Traffic direction.
- disabled boolean
- Flag to disable the rule.
- ip
Version string - IP version.
- log
Label string - Additional information which will be propagated to the rule syslog.
- logged boolean
- Flag to enable logging.
- notes string
- Additional notes for the rule.
- services string[]
- List of services.
- source
Groups string[] - List of source groups.
- sources
Excluded boolean - Flag to indicate whether sources are negated.
-
Get
Policy Intrusion Service Gateway Policy Rule Tag[] - A list of scope + tag pairs associated with this rule.
- display_
name str - The display name of the policy to retrieve.
- ids_
profiles Sequence[str] - List of IDS profiles for this rule.
- nsx_
id str - NSX ID for this resource
- path str
- The NSX path of the policy resource.
- revision float
- Indicates current revision number of the rule.
- rule_
id float - Unique positive number assigned by the system.
- scopes Sequence[str]
- List of objects where the rule is enforced.
- sequence_
number float - The sequence number of the rule.
- action str
- Action for this rule (DETECT, DETECT_PREVENT).
- description str
- The description of the rule.
- destination_
groups Sequence[str] - List of destination groups.
- destinations_
excluded bool - Flag to indicate whether destinations are negated.
- direction str
- Traffic direction.
- disabled bool
- Flag to disable the rule.
- ip_
version str - IP version.
- log_
label str - Additional information which will be propagated to the rule syslog.
- logged bool
- Flag to enable logging.
- notes str
- Additional notes for the rule.
- services Sequence[str]
- List of services.
- source_
groups Sequence[str] - List of source groups.
- sources_
excluded bool - Flag to indicate whether sources are negated.
-
Sequence[Get
Policy Intrusion Service Gateway Policy Rule Tag] - A list of scope + tag pairs associated with this rule.
- display
Name String - The display name of the policy to retrieve.
- ids
Profiles List<String> - List of IDS profiles for this rule.
- nsx
Id String - NSX ID for this resource
- path String
- The NSX path of the policy resource.
- revision Number
- Indicates current revision number of the rule.
- rule
Id Number - Unique positive number assigned by the system.
- scopes List<String>
- List of objects where the rule is enforced.
- sequence
Number Number - The sequence number of the rule.
- action String
- Action for this rule (DETECT, DETECT_PREVENT).
- description String
- The description of the rule.
- destination
Groups List<String> - List of destination groups.
- destinations
Excluded Boolean - Flag to indicate whether destinations are negated.
- direction String
- Traffic direction.
- disabled Boolean
- Flag to disable the rule.
- ip
Version String - IP version.
- log
Label String - Additional information which will be propagated to the rule syslog.
- logged Boolean
- Flag to enable logging.
- notes String
- Additional notes for the rule.
- services List<String>
- List of services.
- source
Groups List<String> - List of source groups.
- sources
Excluded Boolean - Flag to indicate whether sources are negated.
- List<Property Map>
- A list of scope + tag pairs associated with this rule.
GetPolicyIntrusionServiceGatewayPolicyRuleTag
GetPolicyIntrusionServiceGatewayPolicyTag
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
published on Monday, May 18, 2026 by vmware