checkpoint.getManagementObjects

Explore with Pulumi AI

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

checkpointsw/terraform-provider-checkpoint

Example Usage

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

const dataObjects = checkpoint.getManagementObjects({
    limit: 10,
});

import pulumi
import pulumi_checkpoint as checkpoint

data_objects = checkpoint.get_management_objects(limit=10)

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.GetManagementObjects(ctx, &checkpoint.GetManagementObjectsArgs{
			Limit: pulumi.Float64Ref(10),
		}, 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 dataObjects = Checkpoint.GetManagementObjects.Invoke(new()
    {
        Limit = 10,
    });

});

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.GetManagementObjectsArgs;
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 dataObjects = CheckpointFunctions.getManagementObjects(GetManagementObjectsArgs.builder()
            .limit(10)
            .build());

    }
}

variables:
  dataObjects:
    fn::invoke:
      function: checkpoint:getManagementObjects
      arguments:
        limit: 10

Using getManagementObjects

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 getManagementObjects(args: GetManagementObjectsArgs, opts?: InvokeOptions): Promise<GetManagementObjectsResult>
function getManagementObjectsOutput(args: GetManagementObjectsOutputArgs, opts?: InvokeOptions): Output<GetManagementObjectsResult>

def get_management_objects(dereference_group_members: Optional[bool] = None,
                           domains_to_processes: Optional[Sequence[str]] = None,
                           filter: Optional[str] = None,
                           id: Optional[str] = None,
                           ip_only: Optional[bool] = None,
                           limit: Optional[float] = None,
                           offset: Optional[float] = None,
                           orders: Optional[Sequence[GetManagementObjectsOrder]] = None,
                           show_membership: Optional[bool] = None,
                           type: Optional[str] = None,
                           uids: Optional[Sequence[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetManagementObjectsResult
def get_management_objects_output(dereference_group_members: Optional[pulumi.Input[bool]] = None,
                           domains_to_processes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           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[GetManagementObjectsOrderArgs]]]] = None,
                           show_membership: Optional[pulumi.Input[bool]] = None,
                           type: Optional[pulumi.Input[str]] = None,
                           uids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetManagementObjectsResult]

func GetManagementObjects(ctx *Context, args *GetManagementObjectsArgs, opts ...InvokeOption) (*GetManagementObjectsResult, error)
func GetManagementObjectsOutput(ctx *Context, args *GetManagementObjectsOutputArgs, opts ...InvokeOption) GetManagementObjectsResultOutput

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

public static class GetManagementObjects 
{
    public static Task<GetManagementObjectsResult> InvokeAsync(GetManagementObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementObjectsResult> Invoke(GetManagementObjectsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementObjectsResult> getManagementObjects(GetManagementObjectsArgs args, InvokeOptions options)
public static Output<GetManagementObjectsResult> getManagementObjects(GetManagementObjectsArgs args, InvokeOptions options)

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

The following arguments are supported:

DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
DomainsToProcesses List<string>: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
Orders List<GetManagementObjectsOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Type string: The objects' type, e.g.: host, service-tcp, network, address-range...
Uids List<string>: List of UIDs of the objects to retrieve.

DereferenceGroupMembers bool: Indicates whether to dereference "members" field by details level for every object in reply.
DomainsToProcesses []string: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
Orders []GetManagementObjectsOrder: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
ShowMembership bool: Indicates whether to calculate and show "groups" field for every object in reply.
Type string: The objects' type, e.g.: host, service-tcp, network, address-range...
Uids []string: List of UIDs of the objects to retrieve.

dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
domainsToProcesses List<String>: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
orders List<GetManagementObjectsOrder>: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
type String: The objects' type, e.g.: host, service-tcp, network, address-range...
uids List<String>: List of UIDs of the objects to retrieve.

dereferenceGroupMembers boolean: Indicates whether to dereference "members" field by details level for every object in reply.
domainsToProcesses string[]: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
orders GetManagementObjectsOrder[]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
showMembership boolean: Indicates whether to calculate and show "groups" field for every object in reply.
type string: The objects' type, e.g.: host, service-tcp, network, address-range...
uids string[]: List of UIDs of the objects to retrieve.

dereference_group_members bool: Indicates whether to dereference "members" field by details level for every object in reply.
domains_to_processes Sequence[str]: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
orders Sequence[GetManagementObjectsOrder]: Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
show_membership bool: Indicates whether to calculate and show "groups" field for every object in reply.
type str: The objects' type, e.g.: host, service-tcp, network, address-range...
uids Sequence[str]: List of UIDs of the objects to retrieve.

dereferenceGroupMembers Boolean: Indicates whether to dereference "members" field by details level for every object in reply.
domainsToProcesses List<String>: Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
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: The maximal number of returned results.
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.
showMembership Boolean: Indicates whether to calculate and show "groups" field for every object in reply.
type String: The objects' type, e.g.: host, service-tcp, network, address-range...
uids List<String>: List of UIDs of the objects to retrieve.