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

checkpoint.getManagementShowObjects

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

    This resource allows you to execute Check Point Show Objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const query = checkpoint.getManagementShowObjects({
        filter: "13+",
        type: "service-tcp",
    });
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    query = checkpoint.get_management_show_objects(filter="13+",
        type="service-tcp")
    
    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.GetManagementShowObjects(ctx, &checkpoint.GetManagementShowObjectsArgs{
    			Filter: pulumi.StringRef("13+"),
    			Type:   pulumi.StringRef("service-tcp"),
    		}, 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 query = Checkpoint.GetManagementShowObjects.Invoke(new()
        {
            Filter = "13+",
            Type = "service-tcp",
        });
    
    });
    
    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.GetManagementShowObjectsArgs;
    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 query = CheckpointFunctions.getManagementShowObjects(GetManagementShowObjectsArgs.builder()
                .filter("13+")
                .type("service-tcp")
                .build());
    
        }
    }
    
    variables:
      query:
        fn::invoke:
          function: checkpoint:getManagementShowObjects
          arguments:
            filter: 13+
            type: service-tcp
    

    Using getManagementShowObjects

    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 getManagementShowObjects(args: GetManagementShowObjectsArgs, opts?: InvokeOptions): Promise<GetManagementShowObjectsResult>
    function getManagementShowObjectsOutput(args: GetManagementShowObjectsOutputArgs, opts?: InvokeOptions): Output<GetManagementShowObjectsResult>
    def get_management_show_objects(filter: Optional[str] = None,
                                    id: Optional[str] = None,
                                    ip_only: Optional[bool] = None,
                                    limit: Optional[float] = None,
                                    offset: Optional[float] = None,
                                    orders: Optional[Sequence[GetManagementShowObjectsOrder]] = None,
                                    type: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetManagementShowObjectsResult
    def get_management_show_objects_output(filter: Optional[pulumi.Input[str]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    ip_only: Optional[pulumi.Input[bool]] = None,
                                    limit: Optional[pulumi.Input[float]] = None,
                                    offset: Optional[pulumi.Input[float]] = None,
                                    orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementShowObjectsOrderArgs]]]] = None,
                                    type: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetManagementShowObjectsResult]
    func GetManagementShowObjects(ctx *Context, args *GetManagementShowObjectsArgs, opts ...InvokeOption) (*GetManagementShowObjectsResult, error)
    func GetManagementShowObjectsOutput(ctx *Context, args *GetManagementShowObjectsOutputArgs, opts ...InvokeOption) GetManagementShowObjectsResultOutput

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

    public static class GetManagementShowObjects 
    {
        public static Task<GetManagementShowObjectsResult> InvokeAsync(GetManagementShowObjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetManagementShowObjectsResult> Invoke(GetManagementShowObjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetManagementShowObjectsResult> getManagementShowObjects(GetManagementShowObjectsArgs args, InvokeOptions options)
    public static Output<GetManagementShowObjectsResult> getManagementShowObjects(GetManagementShowObjectsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: checkpoint:index/getManagementShowObjects:getManagementShowObjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filter string
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    Id string
    IpOnly bool
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    Limit double
    The maximal number of returned results.
    Offset double
    Number of the results to initially skip.
    Orders List<GetManagementShowObjectsOrder>
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    Type string
    The objects' type, e.g.: host, service-tcp, network, address-range.
    Filter string
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    Id string
    IpOnly bool
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    Limit float64
    The maximal number of returned results.
    Offset float64
    Number of the results to initially skip.
    Orders []GetManagementShowObjectsOrder
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    Type string
    The objects' type, e.g.: host, service-tcp, network, address-range.
    filter String
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    id String
    ipOnly Boolean
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    limit Double
    The maximal number of returned results.
    offset Double
    Number of the results to initially skip.
    orders List<GetManagementShowObjectsOrder>
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    type String
    The objects' type, e.g.: host, service-tcp, network, address-range.
    filter string
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    id string
    ipOnly boolean
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    limit number
    The maximal number of returned results.
    offset number
    Number of the results to initially skip.
    orders GetManagementShowObjectsOrder[]
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    type string
    The objects' type, e.g.: host, service-tcp, network, address-range.
    filter str
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    id str
    ip_only bool
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    limit float
    The maximal number of returned results.
    offset float
    Number of the results to initially skip.
    orders Sequence[GetManagementShowObjectsOrder]
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    type str
    The objects' type, e.g.: host, service-tcp, network, address-range.
    filter String
    Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.
    id String
    ipOnly Boolean
    If using "filter", use this field to search objects by their IP address only, without involving the textual search.
    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. order blocks are documented below.
    type String
    The objects' type, e.g.: host, service-tcp, network, address-range.

    getManagementShowObjects Result

    The following output properties are available:

    from Number
    id String
    objects List<Property Map>
    to Number
    total Number
    filter String
    ipOnly Boolean
    limit Number
    offset Number
    orders List<Property Map>
    type String

    Supporting Types

    GetManagementShowObjectsObject

    Domain Dictionary<string, string>
    Information about the domain that holds the Object. domain blocks are documented below.
    Name string
    Object name. Must be unique in the domain.
    Type string
    Object type.
    Uid string
    Object unique identifier.
    Domain map[string]string
    Information about the domain that holds the Object. domain blocks are documented below.
    Name string
    Object name. Must be unique in the domain.
    Type string
    Object type.
    Uid string
    Object unique identifier.
    domain Map<String,String>
    Information about the domain that holds the Object. domain blocks are documented below.
    name String
    Object name. Must be unique in the domain.
    type String
    Object type.
    uid String
    Object unique identifier.
    domain {[key: string]: string}
    Information about the domain that holds the Object. domain blocks are documented below.
    name string
    Object name. Must be unique in the domain.
    type string
    Object type.
    uid string
    Object unique identifier.
    domain Mapping[str, str]
    Information about the domain that holds the Object. domain blocks are documented below.
    name str
    Object name. Must be unique in the domain.
    type str
    Object type.
    uid str
    Object unique identifier.
    domain Map<String>
    Information about the domain that holds the Object. domain blocks are documented below.
    name String
    Object name. Must be unique in the domain.
    type String
    Object type.
    uid String
    Object unique identifier.

    GetManagementShowObjectsOrder

    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.

    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