checkpoint 2.10.0 published on Thursday, May 29, 2025 by checkpointsw
checkpoint.getManagementShowObjects
Explore with Pulumi AI
checkpoint 2.10.0 published on Thursday, May 29, 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(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[GetManagementShowObjectsOrder]] = None,
show_membership: Optional[bool] = None,
type: Optional[str] = None,
uids: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> GetManagementShowObjectsResult
def get_management_show_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[GetManagementShowObjectsOrderArgs]]]] = 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[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:
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Domains
To List<string>Processes - 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
- Ip
Only 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<Get
Management Show Objects Order> - 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 string
- The objects' type, e.g.: host, service-tcp, network, address-range.
- Uids List<string>
- List of UIDs of the objects to retrieve.
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Domains
To []stringProcesses - 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
- Ip
Only 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
[]Get
Management Show Objects Order - 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 string
- The objects' type, e.g.: host, service-tcp, network, address-range.
- Uids []string
- List of UIDs of the objects to retrieve.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- domains
To List<String>Processes - 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
- ip
Only 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<Get
Management Show Objects Order> - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
- show
Membership 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.
- dereference
Group booleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- domains
To string[]Processes - 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
- ip
Only 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
Get
Management Show Objects Order[] - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
- show
Membership 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_ boolmembers - Indicates whether to dereference "members" field by details level for every object in reply.
- domains_
to_ Sequence[str]processes - 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
- Number of the results to initially skip.
- orders
Sequence[Get
Management Show Objects Order] - 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.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- domains
To List<String>Processes - 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
- ip
Only 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.
- show
Membership 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.
getManagementShowObjects Result
The following output properties are available:
- From double
- Id string
- Objects
List<Get
Management Show Objects Object> - Response string
- To double
- Total double
- Dereference
Group boolMembers - Domains
To List<string>Processes - Filter string
- Ip
Only bool - Limit double
- Offset double
- Orders
List<Get
Management Show Objects Order> - Show
Membership bool - Type string
- Uids List<string>
- From float64
- Id string
- Objects
[]Get
Management Show Objects Object - Response string
- To float64
- Total float64
- Dereference
Group boolMembers - Domains
To []stringProcesses - Filter string
- Ip
Only bool - Limit float64
- Offset float64
- Orders
[]Get
Management Show Objects Order - Show
Membership bool - Type string
- Uids []string
- from Double
- id String
- objects
List<Get
Management Show Objects Object> - response String
- to Double
- total Double
- dereference
Group BooleanMembers - domains
To List<String>Processes - filter String
- ip
Only Boolean - limit Double
- offset Double
- orders
List<Get
Management Show Objects Order> - show
Membership Boolean - type String
- uids List<String>
- from number
- id string
- objects
Get
Management Show Objects Object[] - response string
- to number
- total number
- dereference
Group booleanMembers - domains
To string[]Processes - filter string
- ip
Only boolean - limit number
- offset number
- orders
Get
Management Show Objects Order[] - show
Membership boolean - type string
- uids string[]
- from_ float
- id str
- objects
Sequence[Get
Management Show Objects Object] - response str
- to float
- total float
- dereference_
group_ boolmembers - domains_
to_ Sequence[str]processes - filter str
- ip_
only bool - limit float
- offset float
- orders
Sequence[Get
Management Show Objects Order] - show_
membership bool - type str
- uids Sequence[str]
- from Number
- id String
- objects List<Property Map>
- response String
- to Number
- total Number
- dereference
Group BooleanMembers - domains
To List<String>Processes - filter String
- ip
Only Boolean - limit Number
- offset Number
- orders List<Property Map>
- show
Membership Boolean - type String
- uids List<String>
Supporting Types
GetManagementShowObjectsObject
GetManagementShowObjectsOrder
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpoint
Terraform Provider.
checkpoint 2.10.0 published on Thursday, May 29, 2025 by checkpointsw