1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. getManagementThreatRulebase
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.getManagementThreatRulebase

Explore with Pulumi AI

Use this data source to get information on an existing threat RuleBase.

Using getManagementThreatRulebase

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 getManagementThreatRulebase(args: GetManagementThreatRulebaseArgs, opts?: InvokeOptions): Promise<GetManagementThreatRulebaseResult>
function getManagementThreatRulebaseOutput(args: GetManagementThreatRulebaseOutputArgs, opts?: InvokeOptions): Output<GetManagementThreatRulebaseResult>
Copy
def get_management_threat_rulebase(dereference_group_members: Optional[bool] = None,
                                   filter: Optional[str] = None,
                                   filter_settings: Optional[Mapping[str, str]] = None,
                                   hits_settings: Optional[Mapping[str, str]] = None,
                                   id: Optional[str] = None,
                                   limit: Optional[float] = None,
                                   name: Optional[str] = None,
                                   offset: Optional[float] = None,
                                   orders: Optional[Sequence[GetManagementThreatRulebaseOrder]] = None,
                                   package: Optional[str] = None,
                                   show_as_ranges: Optional[bool] = None,
                                   show_hits: Optional[bool] = None,
                                   show_membership: Optional[bool] = None,
                                   uid: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetManagementThreatRulebaseResult
def get_management_threat_rulebase_output(dereference_group_members: Optional[pulumi.Input[bool]] = None,
                                   filter: Optional[pulumi.Input[str]] = None,
                                   filter_settings: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                   hits_settings: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                   id: Optional[pulumi.Input[str]] = None,
                                   limit: Optional[pulumi.Input[float]] = None,
                                   name: Optional[pulumi.Input[str]] = None,
                                   offset: Optional[pulumi.Input[float]] = None,
                                   orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementThreatRulebaseOrderArgs]]]] = None,
                                   package: Optional[pulumi.Input[str]] = None,
                                   show_as_ranges: Optional[pulumi.Input[bool]] = None,
                                   show_hits: Optional[pulumi.Input[bool]] = None,
                                   show_membership: Optional[pulumi.Input[bool]] = None,
                                   uid: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetManagementThreatRulebaseResult]
Copy
func GetManagementThreatRulebase(ctx *Context, args *GetManagementThreatRulebaseArgs, opts ...InvokeOption) (*GetManagementThreatRulebaseResult, error)
func GetManagementThreatRulebaseOutput(ctx *Context, args *GetManagementThreatRulebaseOutputArgs, opts ...InvokeOption) GetManagementThreatRulebaseResultOutput
Copy

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

public static class GetManagementThreatRulebase 
{
    public static Task<GetManagementThreatRulebaseResult> InvokeAsync(GetManagementThreatRulebaseArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementThreatRulebaseResult> Invoke(GetManagementThreatRulebaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)
public static Output<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: checkpoint:index/getManagementThreatRulebase:getManagementThreatRulebase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DereferenceGroupMembers bool
Indicates whether to dereference "members" field by details level for every object in reply.
Filter string
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
FilterSettings Dictionary<string, string>
Enable enforce end user domain. filter_settings blocks are documented below.
HitsSettings Dictionary<string, string>
Id string
Limit double
The maximal number of returned results.
Name string
Object name. Must be unique in the domain.
Offset double
Number of the results to initially skip.
Orders List<GetManagementThreatRulebaseOrder>
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
Package string
Name of the package.
ShowAsRanges bool
ShowHits bool
ShowMembership bool
Indicates whether to calculate and show "groups" field for every object in reply.
Uid string
Object unique identifier.
DereferenceGroupMembers bool
Indicates whether to dereference "members" field by details level for every object in reply.
Filter string
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
FilterSettings map[string]string
Enable enforce end user domain. filter_settings blocks are documented below.
HitsSettings map[string]string
Id string
Limit float64
The maximal number of returned results.
Name string
Object name. Must be unique in the domain.
Offset float64
Number of the results to initially skip.
Orders []GetManagementThreatRulebaseOrder
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
Package string
Name of the package.
ShowAsRanges bool
ShowHits bool
ShowMembership bool
Indicates whether to calculate and show "groups" field for every object in reply.
Uid string
Object unique identifier.
dereferenceGroupMembers Boolean
Indicates whether to dereference "members" field by details level for every object in reply.
filter String
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings Map<String,String>
Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings Map<String,String>
id String
limit Double
The maximal number of returned results.
name String
Object name. Must be unique in the domain.
offset Double
Number of the results to initially skip.
orders List<GetManagementThreatRulebaseOrder>
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package_ String
Name of the package.
showAsRanges Boolean
showHits Boolean
showMembership Boolean
Indicates whether to calculate and show "groups" field for every object in reply.
uid String
Object unique identifier.
dereferenceGroupMembers boolean
Indicates whether to dereference "members" field by details level for every object in reply.
filter string
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings {[key: string]: string}
Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings {[key: string]: string}
id string
limit number
The maximal number of returned results.
name string
Object name. Must be unique in the domain.
offset number
Number of the results to initially skip.
orders GetManagementThreatRulebaseOrder[]
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package string
Name of the package.
showAsRanges boolean
showHits boolean
showMembership boolean
Indicates whether to calculate and show "groups" field for every object in reply.
uid string
Object unique identifier.
dereference_group_members bool
Indicates whether to dereference "members" field by details level for every object in reply.
filter str
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filter_settings Mapping[str, str]
Enable enforce end user domain. filter_settings blocks are documented below.
hits_settings Mapping[str, str]
id str
limit float
The maximal number of returned results.
name str
Object name. Must be unique in the domain.
offset float
Number of the results to initially skip.
orders Sequence[GetManagementThreatRulebaseOrder]
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package str
Name of the package.
show_as_ranges bool
show_hits bool
show_membership bool
Indicates whether to calculate and show "groups" field for every object in reply.
uid str
Object unique identifier.
dereferenceGroupMembers Boolean
Indicates whether to dereference "members" field by details level for every object in reply.
filter String
Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
filterSettings Map<String>
Enable enforce end user domain. filter_settings blocks are documented below.
hitsSettings Map<String>
id String
limit Number
The maximal number of returned results.
name String
Object name. Must be unique in the domain.
offset Number
Number of the results to initially skip.
orders List<Property Map>
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
package String
Name of the package.
showAsRanges Boolean
showHits Boolean
showMembership Boolean
Indicates whether to calculate and show "groups" field for every object in reply.
uid String
Object unique identifier.

getManagementThreatRulebase Result

The following output properties are available:

Supporting Types

GetManagementThreatRulebaseOrder

Asc string
Sorts results by the given field in ascending order.
Desc string
Sorts results by the given field in descending order.
Asc string
Sorts results by the given field in ascending order.
Desc string
Sorts results by the given field in descending order.
asc String
Sorts results by the given field in ascending order.
desc String
Sorts results by the given field in descending order.
asc string
Sorts results by the given field in ascending order.
desc string
Sorts results by the given field in descending order.
asc str
Sorts results by the given field in ascending order.
desc str
Sorts results by the given field in descending order.
asc String
Sorts results by the given field in ascending order.
desc String
Sorts results by the given field in descending order.

GetManagementThreatRulebaseRulebase

From This property is required. double
ObjectsDictionaries This property is required. List<GetManagementThreatRulebaseRulebaseObjectsDictionary>
Rulebases This property is required. List<GetManagementThreatRulebaseRulebaseRulebase>
To This property is required. double
Total This property is required. double
From This property is required. float64
ObjectsDictionaries This property is required. []GetManagementThreatRulebaseRulebaseObjectsDictionary
Rulebases This property is required. []GetManagementThreatRulebaseRulebaseRulebase
To This property is required. float64
Total This property is required. float64
from This property is required. Double
objectsDictionaries This property is required. List<GetManagementThreatRulebaseRulebaseObjectsDictionary>
rulebases This property is required. List<GetManagementThreatRulebaseRulebaseRulebase>
to This property is required. Double
total This property is required. Double
from This property is required. number
objectsDictionaries This property is required. GetManagementThreatRulebaseRulebaseObjectsDictionary[]
rulebases This property is required. GetManagementThreatRulebaseRulebaseRulebase[]
to This property is required. number
total This property is required. number
from_ This property is required. float
objects_dictionaries This property is required. Sequence[GetManagementThreatRulebaseRulebaseObjectsDictionary]
rulebases This property is required. Sequence[GetManagementThreatRulebaseRulebaseRulebase]
to This property is required. float
total This property is required. float
from This property is required. Number
objectsDictionaries This property is required. List<Property Map>
rulebases This property is required. List<Property Map>
to This property is required. Number
total This property is required. Number

GetManagementThreatRulebaseRulebaseObjectsDictionary

Name This property is required. string
Object name. Must be unique in the domain.
Type This property is required. string
Uid This property is required. string
Object unique identifier.
Name This property is required. string
Object name. Must be unique in the domain.
Type This property is required. string
Uid This property is required. string
Object unique identifier.
name This property is required. String
Object name. Must be unique in the domain.
type This property is required. String
uid This property is required. String
Object unique identifier.
name This property is required. string
Object name. Must be unique in the domain.
type This property is required. string
uid This property is required. string
Object unique identifier.
name This property is required. str
Object name. Must be unique in the domain.
type This property is required. str
uid This property is required. str
Object unique identifier.
name This property is required. String
Object name. Must be unique in the domain.
type This property is required. String
uid This property is required. String
Object unique identifier.

GetManagementThreatRulebaseRulebaseRulebase

Action This property is required. string
Comments This property is required. string
DestinationNegate This property is required. bool
Destinations This property is required. List<string>
Enabled This property is required. bool
Exceptions This property is required. List<string>
ExceptionsLayer This property is required. string
InstallOns This property is required. List<string>
Name This property is required. string
Object name. Must be unique in the domain.
ProtectedScopeNegate This property is required. bool
ProtectedScopes This property is required. List<string>
RuleNumber This property is required. double
ServiceNegate This property is required. bool
Services This property is required. List<string>
SourceNegate This property is required. bool
Sources This property is required. List<string>
Track This property is required. string
TrackSettings This property is required. Dictionary<string, string>
Type This property is required. string
Uid This property is required. string
Object unique identifier.
Action This property is required. string
Comments This property is required. string
DestinationNegate This property is required. bool
Destinations This property is required. []string
Enabled This property is required. bool
Exceptions This property is required. []string
ExceptionsLayer This property is required. string
InstallOns This property is required. []string
Name This property is required. string
Object name. Must be unique in the domain.
ProtectedScopeNegate This property is required. bool
ProtectedScopes This property is required. []string
RuleNumber This property is required. float64
ServiceNegate This property is required. bool
Services This property is required. []string
SourceNegate This property is required. bool
Sources This property is required. []string
Track This property is required. string
TrackSettings This property is required. map[string]string
Type This property is required. string
Uid This property is required. string
Object unique identifier.
action This property is required. String
comments This property is required. String
destinationNegate This property is required. Boolean
destinations This property is required. List<String>
enabled This property is required. Boolean
exceptions This property is required. List<String>
exceptionsLayer This property is required. String
installOns This property is required. List<String>
name This property is required. String
Object name. Must be unique in the domain.
protectedScopeNegate This property is required. Boolean
protectedScopes This property is required. List<String>
ruleNumber This property is required. Double
serviceNegate This property is required. Boolean
services This property is required. List<String>
sourceNegate This property is required. Boolean
sources This property is required. List<String>
track This property is required. String
trackSettings This property is required. Map<String,String>
type This property is required. String
uid This property is required. String
Object unique identifier.
action This property is required. string
comments This property is required. string
destinationNegate This property is required. boolean
destinations This property is required. string[]
enabled This property is required. boolean
exceptions This property is required. string[]
exceptionsLayer This property is required. string
installOns This property is required. string[]
name This property is required. string
Object name. Must be unique in the domain.
protectedScopeNegate This property is required. boolean
protectedScopes This property is required. string[]
ruleNumber This property is required. number
serviceNegate This property is required. boolean
services This property is required. string[]
sourceNegate This property is required. boolean
sources This property is required. string[]
track This property is required. string
trackSettings This property is required. {[key: string]: string}
type This property is required. string
uid This property is required. string
Object unique identifier.
action This property is required. str
comments This property is required. str
destination_negate This property is required. bool
destinations This property is required. Sequence[str]
enabled This property is required. bool
exceptions This property is required. Sequence[str]
exceptions_layer This property is required. str
install_ons This property is required. Sequence[str]
name This property is required. str
Object name. Must be unique in the domain.
protected_scope_negate This property is required. bool
protected_scopes This property is required. Sequence[str]
rule_number This property is required. float
service_negate This property is required. bool
services This property is required. Sequence[str]
source_negate This property is required. bool
sources This property is required. Sequence[str]
track This property is required. str
track_settings This property is required. Mapping[str, str]
type This property is required. str
uid This property is required. str
Object unique identifier.
action This property is required. String
comments This property is required. String
destinationNegate This property is required. Boolean
destinations This property is required. List<String>
enabled This property is required. Boolean
exceptions This property is required. List<String>
exceptionsLayer This property is required. String
installOns This property is required. List<String>
name This property is required. String
Object name. Must be unique in the domain.
protectedScopeNegate This property is required. Boolean
protectedScopes This property is required. List<String>
ruleNumber This property is required. Number
serviceNegate This property is required. Boolean
services This property is required. List<String>
sourceNegate This property is required. Boolean
sources This property is required. List<String>
track This property is required. String
trackSettings This property is required. Map<String>
type This property is required. String
uid This property is required. String
Object unique identifier.

Package Details

Repository
checkpoint checkpointsw/terraform-provider-checkpoint
License
Notes
This Pulumi package is based on the checkpoint Terraform Provider.