checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpoint.getManagementAccessRulebase
Explore with Pulumi AI
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
Use this data source to get information on an existing access RuleBase.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
const accessRulebase = checkpoint.getManagementAccessRulebase({
name: "Network",
});
import pulumi
import pulumi_checkpoint as checkpoint
access_rulebase = checkpoint.get_management_access_rulebase(name="Network")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v2/checkpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := checkpoint.GetManagementAccessRulebase(ctx, &checkpoint.GetManagementAccessRulebaseArgs{
Name: pulumi.StringRef("Network"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;
return await Deployment.RunAsync(() =>
{
var accessRulebase = Checkpoint.GetManagementAccessRulebase.Invoke(new()
{
Name = "Network",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.CheckpointFunctions;
import com.pulumi.checkpoint.inputs.GetManagementAccessRulebaseArgs;
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 accessRulebase = CheckpointFunctions.getManagementAccessRulebase(GetManagementAccessRulebaseArgs.builder()
.name("Network")
.build());
}
}
variables:
accessRulebase:
fn::invoke:
function: checkpoint:getManagementAccessRulebase
arguments:
name: Network
Using getManagementAccessRulebase
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 getManagementAccessRulebase(args: GetManagementAccessRulebaseArgs, opts?: InvokeOptions): Promise<GetManagementAccessRulebaseResult>
function getManagementAccessRulebaseOutput(args: GetManagementAccessRulebaseOutputArgs, opts?: InvokeOptions): Output<GetManagementAccessRulebaseResult>
def get_management_access_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[GetManagementAccessRulebaseOrder]] = 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) -> GetManagementAccessRulebaseResult
def get_management_access_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[GetManagementAccessRulebaseOrderArgs]]]] = 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[GetManagementAccessRulebaseResult]
func GetManagementAccessRulebase(ctx *Context, args *GetManagementAccessRulebaseArgs, opts ...InvokeOption) (*GetManagementAccessRulebaseResult, error)
func GetManagementAccessRulebaseOutput(ctx *Context, args *GetManagementAccessRulebaseOutputArgs, opts ...InvokeOption) GetManagementAccessRulebaseResultOutput
> Note: This function is named GetManagementAccessRulebase
in the Go SDK.
public static class GetManagementAccessRulebase
{
public static Task<GetManagementAccessRulebaseResult> InvokeAsync(GetManagementAccessRulebaseArgs args, InvokeOptions? opts = null)
public static Output<GetManagementAccessRulebaseResult> Invoke(GetManagementAccessRulebaseInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetManagementAccessRulebaseResult> getManagementAccessRulebase(GetManagementAccessRulebaseArgs args, InvokeOptions options)
public static Output<GetManagementAccessRulebaseResult> getManagementAccessRulebase(GetManagementAccessRulebaseArgs args, InvokeOptions options)
fn::invoke:
function: checkpoint:index/getManagementAccessRulebase:getManagementAccessRulebase
arguments:
# arguments dictionary
The following arguments are supported:
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Filter string
- APN name.
- Filter
Settings Dictionary<string, string> - Enable enforce end user domain. filter_settings blocks are documented below.
- Hits
Settings Dictionary<string, string> - hits_settings blocks are documented below.
- 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<Get
Management Access Rulebase Order> - 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.
- Show
As boolRanges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- Show
Hits bool - show hits.
- Show
Membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- Uid string
- Object unique identifier.
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Filter string
- APN name.
- Filter
Settings map[string]string - Enable enforce end user domain. filter_settings blocks are documented below.
- Hits
Settings map[string]string - hits_settings blocks are documented below.
- 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
[]Get
Management Access Rulebase Order - 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.
- Show
As boolRanges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- Show
Hits bool - show hits.
- Show
Membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- Uid string
- Object unique identifier.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter String
- APN name.
- filter
Settings Map<String,String> - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings Map<String,String> - hits_settings blocks are documented below.
- 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<Get
Management Access Rulebase Order> - 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.
- show
As BooleanRanges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- show
Hits Boolean - show hits.
- show
Membership Boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid String
- Object unique identifier.
- dereference
Group booleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter string
- APN name.
- filter
Settings {[key: string]: string} - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings {[key: string]: string} - hits_settings blocks are documented below.
- 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
Get
Management Access Rulebase Order[] - 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.
- show
As booleanRanges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- show
Hits boolean - show hits.
- show
Membership boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid string
- Object unique identifier.
- dereference_
group_ boolmembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter str
- APN name.
- filter_
settings Mapping[str, str] - Enable enforce end user domain. filter_settings blocks are documented below.
- hits_
settings Mapping[str, str] - hits_settings blocks are documented below.
- 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[Get
Management Access Rulebase Order] - 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_ boolranges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- show_
hits bool - show hits.
- show_
membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- uid str
- Object unique identifier.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter String
- APN name.
- filter
Settings Map<String> - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings Map<String> - hits_settings blocks are documented below.
- 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.
- show
As BooleanRanges - When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters: source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters:source-ranges, destination-ranges and service-ranges. Note: Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request.
- show
Hits Boolean - show hits.
- show
Membership Boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid String
- Object unique identifier.
getManagementAccessRulebase Result
The following output properties are available:
- Id string
- Rulebases
List<Get
Management Access Rulebase Rulebase> - Dereference
Group boolMembers - Filter string
- Filter
Settings Dictionary<string, string> - Hits
Settings Dictionary<string, string> - Limit double
- Name string
- Offset double
- Orders
List<Get
Management Access Rulebase Order> - Package string
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Uid string
- Id string
- Rulebases
[]Get
Management Access Rulebase Rulebase - Dereference
Group boolMembers - Filter string
- Filter
Settings map[string]string - Hits
Settings map[string]string - Limit float64
- Name string
- Offset float64
- Orders
[]Get
Management Access Rulebase Order - Package string
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Uid string
- id String
- rulebases
List<Get
Management Access Rulebase Rulebase> - dereference
Group BooleanMembers - filter String
- filter
Settings Map<String,String> - hits
Settings Map<String,String> - limit Double
- name String
- offset Double
- orders
List<Get
Management Access Rulebase Order> - package_ String
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - uid String
- id string
- rulebases
Get
Management Access Rulebase Rulebase[] - dereference
Group booleanMembers - filter string
- filter
Settings {[key: string]: string} - hits
Settings {[key: string]: string} - limit number
- name string
- offset number
- orders
Get
Management Access Rulebase Order[] - package string
- show
As booleanRanges - show
Hits boolean - show
Membership boolean - uid string
- id str
- rulebases
Sequence[Get
Management Access Rulebase Rulebase] - dereference_
group_ boolmembers - filter str
- filter_
settings Mapping[str, str] - hits_
settings Mapping[str, str] - limit float
- name str
- offset float
- orders
Sequence[Get
Management Access Rulebase Order] - package str
- show_
as_ boolranges - show_
hits bool - show_
membership bool - uid str
- id String
- rulebases List<Property Map>
- dereference
Group BooleanMembers - filter String
- filter
Settings Map<String> - hits
Settings Map<String> - limit Number
- name String
- offset Number
- orders List<Property Map>
- package String
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - uid String
Supporting Types
GetManagementAccessRulebaseOrder
GetManagementAccessRulebaseRulebase
- from Number
- objects
Dictionaries List<Property Map> - rulebases List<Property Map>
- to Number
- total Number
GetManagementAccessRulebaseRulebaseObjectsDictionary
GetManagementAccessRulebaseRulebaseRulebase
- Action string
- Action
Settings Dictionary<string, string> - Comments string
- Content
Direction string - Content
Negate bool - Contents List<string>
- Custom
Fields Dictionary<string, string> - Destination
Negate bool - Destinations List<string>
- Enabled bool
- From double
- Inline
Layer string - Install
Ons List<string> - Name string
- Object name. Must be unique in the domain.
- Rule
Number double - Rulebases
List<Get
Management Access Rulebase Rulebase Rulebase Rulebase> - Service
Negate bool - Service
Resource string - Services List<string>
- Source
Negate bool - Sources List<string>
- Times List<string>
- To double
- Track Dictionary<string, string>
- Type string
- Uid string
- Object unique identifier.
- Vpns List<string>
- Action string
- Action
Settings map[string]string - Comments string
- Content
Direction string - Content
Negate bool - Contents []string
- Custom
Fields map[string]string - Destination
Negate bool - Destinations []string
- Enabled bool
- From float64
- Inline
Layer string - Install
Ons []string - Name string
- Object name. Must be unique in the domain.
- Rule
Number float64 - Rulebases
[]Get
Management Access Rulebase Rulebase Rulebase Rulebase - Service
Negate bool - Service
Resource string - Services []string
- Source
Negate bool - Sources []string
- Times []string
- To float64
- Track map[string]string
- Type string
- Uid string
- Object unique identifier.
- Vpns []string
- action String
- action
Settings Map<String,String> - comments String
- content
Direction String - content
Negate Boolean - contents List<String>
- custom
Fields Map<String,String> - destination
Negate Boolean - destinations List<String>
- enabled Boolean
- from Double
- inline
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- rule
Number Double - rulebases
List<Get
Management Access Rulebase Rulebase Rulebase Rulebase> - service
Negate Boolean - service
Resource String - services List<String>
- source
Negate Boolean - sources List<String>
- times List<String>
- to Double
- track Map<String,String>
- type String
- uid String
- Object unique identifier.
- vpns List<String>
- action string
- action
Settings {[key: string]: string} - comments string
- content
Direction string - content
Negate boolean - contents string[]
- custom
Fields {[key: string]: string} - destination
Negate boolean - destinations string[]
- enabled boolean
- from number
- inline
Layer string - install
Ons string[] - name string
- Object name. Must be unique in the domain.
- rule
Number number - rulebases
Get
Management Access Rulebase Rulebase Rulebase Rulebase[] - service
Negate boolean - service
Resource string - services string[]
- source
Negate boolean - sources string[]
- times string[]
- to number
- track {[key: string]: string}
- type string
- uid string
- Object unique identifier.
- vpns string[]
- action str
- action_
settings Mapping[str, str] - comments str
- content_
direction str - content_
negate bool - contents Sequence[str]
- custom_
fields Mapping[str, str] - destination_
negate bool - destinations Sequence[str]
- enabled bool
- from_ float
- inline_
layer str - install_
ons Sequence[str] - name str
- Object name. Must be unique in the domain.
- rule_
number float - rulebases
Sequence[Get
Management Access Rulebase Rulebase Rulebase Rulebase] - service_
negate bool - service_
resource str - services Sequence[str]
- source_
negate bool - sources Sequence[str]
- times Sequence[str]
- to float
- track Mapping[str, str]
- type str
- uid str
- Object unique identifier.
- vpns Sequence[str]
- action String
- action
Settings Map<String> - comments String
- content
Direction String - content
Negate Boolean - contents List<String>
- custom
Fields Map<String> - destination
Negate Boolean - destinations List<String>
- enabled Boolean
- from Number
- inline
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- rule
Number Number - rulebases List<Property Map>
- service
Negate Boolean - service
Resource String - services List<String>
- source
Negate Boolean - sources List<String>
- times List<String>
- to Number
- track Map<String>
- type String
- uid String
- Object unique identifier.
- vpns List<String>
GetManagementAccessRulebaseRulebaseRulebaseRulebase
- Action string
- Action
Settings Dictionary<string, string> - Comments string
- Content
Direction string - Content
Negate bool - Contents List<string>
- Custom
Fields Dictionary<string, string> - Destination
Negate bool - Destinations List<string>
- Enabled bool
- Inline
Layer string - Install
Ons List<string> - Name string
- Object name. Must be unique in the domain.
- Rule
Number double - Service
Negate bool - Service
Resource string - Services List<string>
- Source
Negate bool - Sources List<string>
- Times List<string>
- Track Dictionary<string, string>
- Type string
- Uid string
- Object unique identifier.
- Vpns List<string>
- Action string
- Action
Settings map[string]string - Comments string
- Content
Direction string - Content
Negate bool - Contents []string
- Custom
Fields map[string]string - Destination
Negate bool - Destinations []string
- Enabled bool
- Inline
Layer string - Install
Ons []string - Name string
- Object name. Must be unique in the domain.
- Rule
Number float64 - Service
Negate bool - Service
Resource string - Services []string
- Source
Negate bool - Sources []string
- Times []string
- Track map[string]string
- Type string
- Uid string
- Object unique identifier.
- Vpns []string
- action String
- action
Settings Map<String,String> - comments String
- content
Direction String - content
Negate Boolean - contents List<String>
- custom
Fields Map<String,String> - destination
Negate Boolean - destinations List<String>
- enabled Boolean
- inline
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- rule
Number Double - service
Negate Boolean - service
Resource String - services List<String>
- source
Negate Boolean - sources List<String>
- times List<String>
- track Map<String,String>
- type String
- uid String
- Object unique identifier.
- vpns List<String>
- action string
- action
Settings {[key: string]: string} - comments string
- content
Direction string - content
Negate boolean - contents string[]
- custom
Fields {[key: string]: string} - destination
Negate boolean - destinations string[]
- enabled boolean
- inline
Layer string - install
Ons string[] - name string
- Object name. Must be unique in the domain.
- rule
Number number - service
Negate boolean - service
Resource string - services string[]
- source
Negate boolean - sources string[]
- times string[]
- track {[key: string]: string}
- type string
- uid string
- Object unique identifier.
- vpns string[]
- action str
- action_
settings Mapping[str, str] - comments str
- content_
direction str - content_
negate bool - contents Sequence[str]
- custom_
fields Mapping[str, str] - destination_
negate bool - destinations Sequence[str]
- enabled bool
- inline_
layer str - install_
ons Sequence[str] - name str
- Object name. Must be unique in the domain.
- rule_
number float - service_
negate bool - service_
resource str - services Sequence[str]
- source_
negate bool - sources Sequence[str]
- times Sequence[str]
- track Mapping[str, str]
- type str
- uid str
- Object unique identifier.
- vpns Sequence[str]
- action String
- action
Settings Map<String> - comments String
- content
Direction String - content
Negate Boolean - contents List<String>
- custom
Fields Map<String> - destination
Negate Boolean - destinations List<String>
- enabled Boolean
- inline
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- rule
Number Number - service
Negate Boolean - service
Resource String - services List<String>
- source
Negate Boolean - sources List<String>
- times List<String>
- track Map<String>
- type String
- uid String
- Object unique identifier.
- vpns List<String>
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpoint
Terraform Provider.
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw