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

checkpoint.getManagementAccessRulebase

Explore with Pulumi AI

checkpoint logo
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:

    DereferenceGroupMembers bool
    Indicates whether to dereference "members" field by details level for every object in reply.
    Filter string
    APN name.
    FilterSettings Dictionary<string, string>
    Enable enforce end user domain. filter_settings blocks are documented below.
    HitsSettings 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<GetManagementAccessRulebaseOrder>
    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
    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.
    ShowHits bool
    show hits.
    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
    APN name.
    FilterSettings map[string]string
    Enable enforce end user domain. filter_settings blocks are documented below.
    HitsSettings 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 []GetManagementAccessRulebaseOrder
    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
    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.
    ShowHits bool
    show hits.
    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
    APN name.
    filterSettings Map<String,String>
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings 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<GetManagementAccessRulebaseOrder>
    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
    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.
    showHits Boolean
    show hits.
    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
    APN name.
    filterSettings {[key: string]: string}
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings {[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 GetManagementAccessRulebaseOrder[]
    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
    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.
    showHits boolean
    show hits.
    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
    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[GetManagementAccessRulebaseOrder]
    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
    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.
    dereferenceGroupMembers Boolean
    Indicates whether to dereference "members" field by details level for every object in reply.
    filter String
    APN name.
    filterSettings Map<String>
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings 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.
    showAsRanges Boolean
    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.
    showHits Boolean
    show hits.
    showMembership 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:

    Supporting Types

    GetManagementAccessRulebaseOrder

    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.

    GetManagementAccessRulebaseRulebase

    GetManagementAccessRulebaseRulebaseObjectsDictionary

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

    GetManagementAccessRulebaseRulebaseRulebase

    Action string
    ActionSettings Dictionary<string, string>
    Comments string
    ContentDirection string
    ContentNegate bool
    Contents List<string>
    CustomFields Dictionary<string, string>
    DestinationNegate bool
    Destinations List<string>
    Enabled bool
    From double
    InlineLayer string
    InstallOns List<string>
    Name string
    Object name. Must be unique in the domain.
    RuleNumber double
    Rulebases List<GetManagementAccessRulebaseRulebaseRulebaseRulebase>
    ServiceNegate bool
    ServiceResource string
    Services List<string>
    SourceNegate 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
    ActionSettings map[string]string
    Comments string
    ContentDirection string
    ContentNegate bool
    Contents []string
    CustomFields map[string]string
    DestinationNegate bool
    Destinations []string
    Enabled bool
    From float64
    InlineLayer string
    InstallOns []string
    Name string
    Object name. Must be unique in the domain.
    RuleNumber float64
    Rulebases []GetManagementAccessRulebaseRulebaseRulebaseRulebase
    ServiceNegate bool
    ServiceResource string
    Services []string
    SourceNegate bool
    Sources []string
    Times []string
    To float64
    Track map[string]string
    Type string
    Uid string
    Object unique identifier.
    Vpns []string
    action String
    actionSettings Map<String,String>
    comments String
    contentDirection String
    contentNegate Boolean
    contents List<String>
    customFields Map<String,String>
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    from Double
    inlineLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    ruleNumber Double
    rulebases List<GetManagementAccessRulebaseRulebaseRulebaseRulebase>
    serviceNegate Boolean
    serviceResource String
    services List<String>
    sourceNegate 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
    actionSettings {[key: string]: string}
    comments string
    contentDirection string
    contentNegate boolean
    contents string[]
    customFields {[key: string]: string}
    destinationNegate boolean
    destinations string[]
    enabled boolean
    from number
    inlineLayer string
    installOns string[]
    name string
    Object name. Must be unique in the domain.
    ruleNumber number
    rulebases GetManagementAccessRulebaseRulebaseRulebaseRulebase[]
    serviceNegate boolean
    serviceResource string
    services string[]
    sourceNegate 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[GetManagementAccessRulebaseRulebaseRulebaseRulebase]
    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
    actionSettings Map<String>
    comments String
    contentDirection String
    contentNegate Boolean
    contents List<String>
    customFields Map<String>
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    from Number
    inlineLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    ruleNumber Number
    rulebases List<Property Map>
    serviceNegate Boolean
    serviceResource String
    services List<String>
    sourceNegate 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
    ActionSettings Dictionary<string, string>
    Comments string
    ContentDirection string
    ContentNegate bool
    Contents List<string>
    CustomFields Dictionary<string, string>
    DestinationNegate bool
    Destinations List<string>
    Enabled bool
    InlineLayer string
    InstallOns List<string>
    Name string
    Object name. Must be unique in the domain.
    RuleNumber double
    ServiceNegate bool
    ServiceResource string
    Services List<string>
    SourceNegate bool
    Sources List<string>
    Times List<string>
    Track Dictionary<string, string>
    Type string
    Uid string
    Object unique identifier.
    Vpns List<string>
    Action string
    ActionSettings map[string]string
    Comments string
    ContentDirection string
    ContentNegate bool
    Contents []string
    CustomFields map[string]string
    DestinationNegate bool
    Destinations []string
    Enabled bool
    InlineLayer string
    InstallOns []string
    Name string
    Object name. Must be unique in the domain.
    RuleNumber float64
    ServiceNegate bool
    ServiceResource string
    Services []string
    SourceNegate bool
    Sources []string
    Times []string
    Track map[string]string
    Type string
    Uid string
    Object unique identifier.
    Vpns []string
    action String
    actionSettings Map<String,String>
    comments String
    contentDirection String
    contentNegate Boolean
    contents List<String>
    customFields Map<String,String>
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    inlineLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    ruleNumber Double
    serviceNegate Boolean
    serviceResource String
    services List<String>
    sourceNegate Boolean
    sources List<String>
    times List<String>
    track Map<String,String>
    type String
    uid String
    Object unique identifier.
    vpns List<String>
    action string
    actionSettings {[key: string]: string}
    comments string
    contentDirection string
    contentNegate boolean
    contents string[]
    customFields {[key: string]: string}
    destinationNegate boolean
    destinations string[]
    enabled boolean
    inlineLayer string
    installOns string[]
    name string
    Object name. Must be unique in the domain.
    ruleNumber number
    serviceNegate boolean
    serviceResource string
    services string[]
    sourceNegate 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
    actionSettings Map<String>
    comments String
    contentDirection String
    contentNegate Boolean
    contents List<String>
    customFields Map<String>
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    inlineLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    ruleNumber Number
    serviceNegate Boolean
    serviceResource String
    services List<String>
    sourceNegate 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 logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw