Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. getManagementGuideline
Viewing docs for checkpoint 3.3.0
published on Thursday, Jul 30, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

checkpoint.getManagementGuideline

Viewing docs for checkpoint 3.3.0
published on Thursday, Jul 30, 2026 by checkpointsw
Schema (JSON)
checkpointsw/terraform-provider-checkpoint

    Use this data source to get information on an existing Check Point Guideline.

    Example Usage

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

const dataTest = checkpoint.getManagementGuideline({
    name: "guideline1",
});

    import pulumi
import pulumi_checkpoint as checkpoint

data_test = checkpoint.get_management_guideline(name="guideline1")

    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.LookupManagementGuideline(ctx, &checkpoint.LookupManagementGuidelineArgs{
			Name: pulumi.StringRef("guideline1"),
		}, 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 dataTest = Checkpoint.GetManagementGuideline.Invoke(new()
    {
        Name = "guideline1",
    });

});

    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.GetManagementGuidelineArgs;
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 dataTest = CheckpointFunctions.getManagementGuideline(GetManagementGuidelineArgs.builder()
            .name("guideline1")
            .build());

    }
}

    variables:
  dataTest:
    fn::invoke:
      function: checkpoint:getManagementGuideline
      arguments:
        name: guideline1

    Example coming soon!

    Using getManagementGuideline

    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 getManagementGuideline(args: GetManagementGuidelineArgs, opts?: InvokeOptions): Promise<GetManagementGuidelineResult>
function getManagementGuidelineOutput(args: GetManagementGuidelineOutputArgs, opts?: InvokeOptions): Output<GetManagementGuidelineResult>
    def get_management_guideline(dereference_group_members: Optional[bool] = None,
                             id: Optional[str] = None,
                             indexing_status_layer: Optional[str] = None,
                             name: Optional[str] = None,
                             show_indexing_status: Optional[bool] = None,
                             show_membership: Optional[bool] = None,
                             uid: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetManagementGuidelineResult
def get_management_guideline_output(dereference_group_members: pulumi.Input[Optional[bool]] = None,
                             id: pulumi.Input[Optional[str]] = None,
                             indexing_status_layer: pulumi.Input[Optional[str]] = None,
                             name: pulumi.Input[Optional[str]] = None,
                             show_indexing_status: pulumi.Input[Optional[bool]] = None,
                             show_membership: pulumi.Input[Optional[bool]] = None,
                             uid: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetManagementGuidelineResult]
    func LookupManagementGuideline(ctx *Context, args *LookupManagementGuidelineArgs, opts ...InvokeOption) (*LookupManagementGuidelineResult, error)
func LookupManagementGuidelineOutput(ctx *Context, args *LookupManagementGuidelineOutputArgs, opts ...InvokeOption) LookupManagementGuidelineResultOutput

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

    public static class GetManagementGuideline 
{
    public static Task<GetManagementGuidelineResult> InvokeAsync(GetManagementGuidelineArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementGuidelineResult> Invoke(GetManagementGuidelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetManagementGuidelineResult> getManagementGuideline(GetManagementGuidelineArgs args, InvokeOptions options)
public static Output<GetManagementGuidelineResult> getManagementGuideline(GetManagementGuidelineArgs args, InvokeOptions options)

    fn::invoke:
  function: checkpoint:index/getManagementGuideline:getManagementGuideline
  arguments:
    # arguments dictionary
    data "checkpoint_get_management_guideline" "name" {
    # arguments
}

    The following arguments are supported:

    DereferenceGroupMembers bool
    Indicates whether to dereference "members" field by details level for every object in reply.
    Id string
    IndexingStatusLayer string
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    Name string
    Object name.
    ShowIndexingStatus bool
    Control whether to show the indexing status of the guideline.
    ShowMembership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    Uid string
    Object unique identifier.
    DereferenceGroupMembers bool
    Indicates whether to dereference "members" field by details level for every object in reply.
    Id string
    IndexingStatusLayer string
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    Name string
    Object name.
    ShowIndexingStatus bool
    Control whether to show the indexing status of the guideline.
    ShowMembership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    Uid string
    Object unique identifier.
    dereference_group_members bool
    Indicates whether to dereference "members" field by details level for every object in reply.
    id string
    indexing_status_layer string
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    name string
    Object name.
    show_indexing_status bool
    Control whether to show the indexing status of the guideline.
    show_membership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid string
    Object unique identifier.
    dereferenceGroupMembers Boolean
    Indicates whether to dereference "members" field by details level for every object in reply.
    id String
    indexingStatusLayer String
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    name String
    Object name.
    showIndexingStatus Boolean
    Control whether to show the indexing status of the guideline.
    showMembership Boolean
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid String
    Object unique identifier.
    dereferenceGroupMembers boolean
    Indicates whether to dereference "members" field by details level for every object in reply.
    id string
    indexingStatusLayer string
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    name string
    Object name.
    showIndexingStatus boolean
    Control whether to show the indexing status of the guideline.
    showMembership boolean
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid string
    Object unique identifier.
    dereference_group_members bool
    Indicates whether to dereference "members" field by details level for every object in reply.
    id str
    indexing_status_layer str
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    name str
    Object name.
    show_indexing_status bool
    Control whether to show the indexing status of the guideline.
    show_membership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid str
    Object unique identifier.
    dereferenceGroupMembers Boolean
    Indicates whether to dereference "members" field by details level for every object in reply.
    id String
    indexingStatusLayer String
    Relevant only when show-indexing-status is true. The access-layer to show the indexing status of (identified by unique id or 'any' for all attached access-layers).
    name String
    Object name.
    showIndexingStatus Boolean
    Control whether to show the indexing status of the guideline.
    showMembership Boolean
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid String
    Object unique identifier.

    getManagementGuideline Result

    The following output properties are available:

    Supporting Types

    GetManagementGuidelineAccessLayer

    AccessLayer string
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    PolicyPackage string
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    AccessLayer string
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    PolicyPackage string
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    access_layer string
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    policy_package string
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    accessLayer String
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    policyPackage String
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    accessLayer string
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    policyPackage string
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    access_layer str
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    policy_package str
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    accessLayer String
    The access-layer object attached to the guideline identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    policyPackage String
    The policy-package object context for the access-layer (only for global access-layers) identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.

    GetManagementGuidelineCellActionsOverride

    Action string
    The action selected for the cell.
    From string
    Unique identifier of the segment of the cell in the 'from' axis.
    FromType string
    The type of the segment in the 'from' axis.
    To string
    Unique identifier of the segment of the cell in the 'to' axis.
    ToType string
    The type of the segment in the 'to' axis.
    Action string
    The action selected for the cell.
    From string
    Unique identifier of the segment of the cell in the 'from' axis.
    FromType string
    The type of the segment in the 'from' axis.
    To string
    Unique identifier of the segment of the cell in the 'to' axis.
    ToType string
    The type of the segment in the 'to' axis.
    action string
    The action selected for the cell.
    from string
    Unique identifier of the segment of the cell in the 'from' axis.
    from_type string
    The type of the segment in the 'from' axis.
    to string
    Unique identifier of the segment of the cell in the 'to' axis.
    to_type string
    The type of the segment in the 'to' axis.
    action String
    The action selected for the cell.
    from String
    Unique identifier of the segment of the cell in the 'from' axis.
    fromType String
    The type of the segment in the 'from' axis.
    to String
    Unique identifier of the segment of the cell in the 'to' axis.
    toType String
    The type of the segment in the 'to' axis.
    action string
    The action selected for the cell.
    from string
    Unique identifier of the segment of the cell in the 'from' axis.
    fromType string
    The type of the segment in the 'from' axis.
    to string
    Unique identifier of the segment of the cell in the 'to' axis.
    toType string
    The type of the segment in the 'to' axis.
    action str
    The action selected for the cell.
    from_ str
    Unique identifier of the segment of the cell in the 'from' axis.
    from_type str
    The type of the segment in the 'from' axis.
    to str
    Unique identifier of the segment of the cell in the 'to' axis.
    to_type str
    The type of the segment in the 'to' axis.
    action String
    The action selected for the cell.
    from String
    Unique identifier of the segment of the cell in the 'from' axis.
    fromType String
    The type of the segment in the 'from' axis.
    to String
    Unique identifier of the segment of the cell in the 'to' axis.
    toType String
    The type of the segment in the 'to' axis.

    GetManagementGuidelineGuidelineGroup

    GuidelineGroups List<string>
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    Members List<string>
    Group members.
    Position double
    The position of the guideline group in the axis.
    GuidelineGroups []string
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    Members []string
    Group members.
    Position float64
    The position of the guideline group in the axis.
    guideline_groups list(string)
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    members list(string)
    Group members.
    position number
    The position of the guideline group in the axis.
    guidelineGroups List<String>
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    members List<String>
    Group members.
    position Double
    The position of the guideline group in the axis.
    guidelineGroups string[]
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    members string[]
    Group members.
    position number
    The position of the guideline group in the axis.
    guideline_groups Sequence[str]
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    members Sequence[str]
    Group members.
    position float
    The position of the guideline group in the axis.
    guidelineGroups List<String>
    The network-group object identified by the name or UID. Level of details in the output corresponds to the number of details for search. This table shows the level of details in the Standard level.
    members List<String>
    Group members.
    position Number
    The position of the guideline group in the axis.

    GetManagementGuidelineIndexingStatus

    AccessLayerId string
    The id of the access-layer that is being indexed.
    IndexingMessage string
    Message which offers more details on The indexing task.
    IndexingTask string
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    LastUpdateTimes List<GetManagementGuidelineIndexingStatusLastUpdateTime>
    Last time the indexing status was updated. last_update_time blocks are documented below.
    PolicyPackageId string
    The id of the policy Package that is being indexed.(only used if the layer is global).
    Status string
    The status of the indexing task.
    AccessLayerId string
    The id of the access-layer that is being indexed.
    IndexingMessage string
    Message which offers more details on The indexing task.
    IndexingTask string
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    LastUpdateTimes []GetManagementGuidelineIndexingStatusLastUpdateTime
    Last time the indexing status was updated. last_update_time blocks are documented below.
    PolicyPackageId string
    The id of the policy Package that is being indexed.(only used if the layer is global).
    Status string
    The status of the indexing task.
    access_layer_id string
    The id of the access-layer that is being indexed.
    indexing_message string
    Message which offers more details on The indexing task.
    indexing_task string
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    last_update_times list(object)
    Last time the indexing status was updated. last_update_time blocks are documented below.
    policy_package_id string
    The id of the policy Package that is being indexed.(only used if the layer is global).
    status string
    The status of the indexing task.
    accessLayerId String
    The id of the access-layer that is being indexed.
    indexingMessage String
    Message which offers more details on The indexing task.
    indexingTask String
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    lastUpdateTimes List<GetManagementGuidelineIndexingStatusLastUpdateTime>
    Last time the indexing status was updated. last_update_time blocks are documented below.
    policyPackageId String
    The id of the policy Package that is being indexed.(only used if the layer is global).
    status String
    The status of the indexing task.
    accessLayerId string
    The id of the access-layer that is being indexed.
    indexingMessage string
    Message which offers more details on The indexing task.
    indexingTask string
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    lastUpdateTimes GetManagementGuidelineIndexingStatusLastUpdateTime[]
    Last time the indexing status was updated. last_update_time blocks are documented below.
    policyPackageId string
    The id of the policy Package that is being indexed.(only used if the layer is global).
    status string
    The status of the indexing task.
    access_layer_id str
    The id of the access-layer that is being indexed.
    indexing_message str
    Message which offers more details on The indexing task.
    indexing_task str
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    last_update_times Sequence[GetManagementGuidelineIndexingStatusLastUpdateTime]
    Last time the indexing status was updated. last_update_time blocks are documented below.
    policy_package_id str
    The id of the policy Package that is being indexed.(only used if the layer is global).
    status str
    The status of the indexing task.
    accessLayerId String
    The id of the access-layer that is being indexed.
    indexingMessage String
    Message which offers more details on The indexing task.
    indexingTask String
    The id of the task that is indexing the access-layer. Relevant only if the task is in progress.
    lastUpdateTimes List<Property Map>
    Last time the indexing status was updated. last_update_time blocks are documented below.
    policyPackageId String
    The id of the policy Package that is being indexed.(only used if the layer is global).
    status String
    The status of the indexing task.

    GetManagementGuidelineIndexingStatusLastUpdateTime

    Iso8601 string
    Date and time represented in international ISO 8601 format.
    Posix double
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    Iso8601 string
    Date and time represented in international ISO 8601 format.
    Posix float64
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    iso8601 string
    Date and time represented in international ISO 8601 format.
    posix number
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    iso8601 String
    Date and time represented in international ISO 8601 format.
    posix Double
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    iso8601 string
    Date and time represented in international ISO 8601 format.
    posix number
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    iso8601 str
    Date and time represented in international ISO 8601 format.
    posix float
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.
    iso8601 String
    Date and time represented in international ISO 8601 format.
    posix Number
    Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    Viewing docs for checkpoint 3.3.0
    published on Thursday, Jul 30, 2026 by checkpointsw
    Schema (JSON)
    checkpointsw/terraform-provider-checkpoint

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial