checkpoint.getManagementNatRulebase

checkpoint 3.0.0, Mar 30 26

Viewing docs for checkpoint 3.0.0
published on Monday, Mar 30, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Viewing docs for checkpoint 3.0.0
published on Monday, Mar 30, 2026 by checkpointsw

checkpointsw/terraform-provider-checkpoint

Example Usage

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

const natRulebase = checkpoint.getManagementNatRulebase({
    "package": "Standard",
});

import pulumi
import pulumi_checkpoint as checkpoint

nat_rulebase = checkpoint.get_management_nat_rulebase(package="Standard")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v3/checkpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkpoint.GetManagementNatRulebase(ctx, &checkpoint.GetManagementNatRulebaseArgs{
			Package: "Standard",
		}, 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 natRulebase = Checkpoint.GetManagementNatRulebase.Invoke(new()
    {
        Package = "Standard",
    });

});

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.GetManagementNatRulebaseArgs;
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 natRulebase = CheckpointFunctions.getManagementNatRulebase(GetManagementNatRulebaseArgs.builder()
            .package_("Standard")
            .build());

    }
}

variables:
  natRulebase:
    fn::invoke:
      function: checkpoint:getManagementNatRulebase
      arguments:
        package: Standard

Using getManagementNatRulebase

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 getManagementNatRulebase(args: GetManagementNatRulebaseArgs, opts?: InvokeOptions): Promise<GetManagementNatRulebaseResult>
function getManagementNatRulebaseOutput(args: GetManagementNatRulebaseOutputArgs, opts?: InvokeOptions): Output<GetManagementNatRulebaseResult>

def get_management_nat_rulebase(dereference_group_members: Optional[bool] = None,
                                filter: Optional[str] = None,
                                filter_settings: Optional[GetManagementNatRulebaseFilterSettings] = None,
                                id: Optional[str] = None,
                                limit: Optional[float] = None,
                                offset: Optional[float] = None,
                                orders: Optional[Sequence[GetManagementNatRulebaseOrder]] = None,
                                package: Optional[str] = None,
                                show_membership: Optional[bool] = None,
                                uid: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetManagementNatRulebaseResult
def get_management_nat_rulebase_output(dereference_group_members: pulumi.Input[Optional[bool]] = None,
                                filter: pulumi.Input[Optional[str]] = None,
                                filter_settings: pulumi.Input[Optional[GetManagementNatRulebaseFilterSettingsArgs]] = None,
                                id: pulumi.Input[Optional[str]] = None,
                                limit: pulumi.Input[Optional[float]] = None,
                                offset: pulumi.Input[Optional[float]] = None,
                                orders: pulumi.Input[Optional[Sequence[pulumi.Input[GetManagementNatRulebaseOrderArgs]]]] = None,
                                package: pulumi.Input[Optional[str]] = None,
                                show_membership: pulumi.Input[Optional[bool]] = None,
                                uid: pulumi.Input[Optional[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetManagementNatRulebaseResult]

func GetManagementNatRulebase(ctx *Context, args *GetManagementNatRulebaseArgs, opts ...InvokeOption) (*GetManagementNatRulebaseResult, error)
func GetManagementNatRulebaseOutput(ctx *Context, args *GetManagementNatRulebaseOutputArgs, opts ...InvokeOption) GetManagementNatRulebaseResultOutput

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

public static class GetManagementNatRulebase 
{
    public static Task<GetManagementNatRulebaseResult> InvokeAsync(GetManagementNatRulebaseArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementNatRulebaseResult> Invoke(GetManagementNatRulebaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementNatRulebaseResult> getManagementNatRulebase(GetManagementNatRulebaseArgs args, InvokeOptions options)
public static Output<GetManagementNatRulebaseResult> getManagementNatRulebase(GetManagementNatRulebaseArgs args, InvokeOptions options)

fn::invoke:
  function: checkpoint:index/getManagementNatRulebase:getManagementNatRulebase
  arguments:
    # arguments dictionary

The following arguments are supported:

Package string: Name of the package.
DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
Filter string: APN name.
FilterSettings GetManagementNatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
Id string
Limit double: The maximal number of returned results.
Offset double: Number of the results to initially skip.
Orders List<GetManagementNatRulebaseOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Uid string

Package string: Name of the package.
DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
Filter string: APN name.
FilterSettings GetManagementNatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
Id string
Limit float64: The maximal number of returned results.
Offset float64: Number of the results to initially skip.
Orders []GetManagementNatRulebaseOrder: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Uid string

package_ String: Name of the package.
dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter String: APN name.
filterSettings GetManagementNatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
id String
limit Double: The maximal number of returned results.
offset Double: Number of the results to initially skip.
orders List<GetManagementNatRulebaseOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid String

package string: Name of the package.
dereferenceGroupMembers boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter string: APN name.
filterSettings GetManagementNatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
id string
limit number: The maximal number of returned results.
offset number: Number of the results to initially skip.
orders GetManagementNatRulebaseOrder[]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
showMembership boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid string

package str: Name of the package.
dereference_group_members bool: Indicates whether to dereference "members" field by details level for every object in reply.
filter str: APN name.
filter_settings GetManagementNatRulebaseFilterSettings: Enable enforce end user domain. filter_settings blocks are documented below.
id str
limit float: The maximal number of returned results.
offset float: Number of the results to initially skip.
orders Sequence[GetManagementNatRulebaseOrder]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
show_membership bool: Indicates whether to calculate and show "groups" field for every object in reply.
uid str

package String: Name of the package.
dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
filter String: APN name.
filterSettings Property Map: Enable enforce end user domain. filter_settings blocks are documented below.
id String
limit Number: The maximal number of returned results.
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.
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
uid String

getManagementNatRulebase Result

The following output properties are available:

Id string
Package string
Rulebases List<GetManagementNatRulebaseRulebase>
DereferenceGroupMembers bool
Filter string
FilterSettings GetManagementNatRulebaseFilterSettings
Limit double
Offset double
Orders List<GetManagementNatRulebaseOrder>
ShowMembership bool
Uid string

Id string
Package string
Rulebases []GetManagementNatRulebaseRulebase
DereferenceGroupMembers bool
Filter string
FilterSettings GetManagementNatRulebaseFilterSettings
Limit float64
Offset float64
Orders []GetManagementNatRulebaseOrder
ShowMembership bool
Uid string

id String
package_ String
rulebases List<GetManagementNatRulebaseRulebase>
dereferenceGroupMembers Boolean
filter String
filterSettings GetManagementNatRulebaseFilterSettings
limit Double
offset Double
orders List<GetManagementNatRulebaseOrder>
showMembership Boolean
uid String

id string
package string
rulebases GetManagementNatRulebaseRulebase[]
dereferenceGroupMembers boolean
filter string
filterSettings GetManagementNatRulebaseFilterSettings
limit number
offset number
orders GetManagementNatRulebaseOrder[]
showMembership boolean
uid string

id str
package str
rulebases Sequence[GetManagementNatRulebaseRulebase]
dereference_group_members bool
filter str
filter_settings GetManagementNatRulebaseFilterSettings
limit float
offset float
orders Sequence[GetManagementNatRulebaseOrder]
show_membership bool
uid str

id String
package String
rulebases List<Property Map>
dereferenceGroupMembers Boolean
filter String
filterSettings Property Map
limit Number
offset Number
orders List<Property Map>
showMembership Boolean
uid String

Supporting Types

GetManagementNatRulebaseFilterSettings

ExpandGroupMembers bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
ExpandGroupWithExclusionMembers bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
MatchOnAny bool: Whether to match on 'Any' object.
MatchOnGroupWithExclusion bool: Whether to match on a group-with-exclusion.
MatchOnNegate bool: Whether to match on a negated cell.
SearchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

ExpandGroupMembers bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
ExpandGroupWithExclusionMembers bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
MatchOnAny bool: Whether to match on 'Any' object.
MatchOnGroupWithExclusion bool: Whether to match on a group-with-exclusion.
MatchOnNegate bool: Whether to match on a negated cell.
SearchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers Boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers Boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny Boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion Boolean: Whether to match on a group-with-exclusion.
matchOnNegate Boolean: Whether to match on a negated cell.
searchMode String: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion boolean: Whether to match on a group-with-exclusion.
matchOnNegate boolean: Whether to match on a negated cell.
searchMode string: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expand_group_members bool: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expand_group_with_exclusion_members bool: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
match_on_any bool: Whether to match on 'Any' object.
match_on_group_with_exclusion bool: Whether to match on a group-with-exclusion.
match_on_negate bool: Whether to match on a negated cell.
search_mode str: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.

expandGroupMembers Boolean: When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group.
expandGroupWithExclusionMembers Boolean: When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part.
matchOnAny Boolean: Whether to match on 'Any' object.
matchOnGroupWithExclusion Boolean: Whether to match on a group-with-exclusion.
matchOnNegate Boolean: Whether to match on a negated cell.
searchMode String: When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to ' packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior.