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

checkpoint.getManagementNatRulebase

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 nat RuleBase.

    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/v2/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[Mapping[str, str]] = 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: Optional[pulumi.Input[bool]] = None,
                                    filter: Optional[pulumi.Input[str]] = None,
                                    filter_settings: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    limit: Optional[pulumi.Input[float]] = None,
                                    offset: Optional[pulumi.Input[float]] = None,
                                    orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementNatRulebaseOrderArgs]]]] = None,
                                    package: Optional[pulumi.Input[str]] = None,
                                    show_membership: Optional[pulumi.Input[bool]] = None,
                                    uid: Optional[pulumi.Input[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 Dictionary<string, string>
    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 map[string]string
    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 Map<String,String>
    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 {[key: string]: string}
    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 Mapping[str, str]
    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 Map<String>
    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:

    Supporting Types

    GetManagementNatRulebaseOrder

    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.

    GetManagementNatRulebaseRulebase

    GetManagementNatRulebaseRulebaseObjectsDictionary

    Name string
    Type string
    Uid string
    Name string
    Type string
    Uid string
    name String
    type String
    uid String
    name string
    type string
    uid string
    name str
    type str
    uid str
    name String
    type String
    uid String

    GetManagementNatRulebaseRulebaseRulebase

    GetManagementNatRulebaseRulebaseRulebaseRulebase

    autoGenerated Boolean
    comments String
    enabled Boolean
    installOns List<String>
    method String
    name String
    originalDestination String
    originalService String
    originalSource String
    ruleNumber Double
    translatedDestination String
    translatedService String
    translatedSource String
    type String
    uid String
    autoGenerated Boolean
    comments String
    enabled Boolean
    installOns List<String>
    method String
    name String
    originalDestination String
    originalService String
    originalSource String
    ruleNumber Number
    translatedDestination String
    translatedService String
    translatedSource String
    type String
    uid 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