Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementCommandGetInterfaces
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementCommandGetInterfaces

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

    This resource allows you to execute Check Point Get Interfaces.

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

const getInterfaces = new checkpoint.ManagementCommandGetInterfaces("getInterfaces", {targetUid: "2220d9ad-a251-5555-9a0a-4772a6511111"});

    import pulumi
import pulumi_checkpoint as checkpoint

get_interfaces = checkpoint.ManagementCommandGetInterfaces("getInterfaces", target_uid="2220d9ad-a251-5555-9a0a-4772a6511111")

    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.NewManagementCommandGetInterfaces(ctx, "getInterfaces", &checkpoint.ManagementCommandGetInterfacesArgs{
			TargetUid: pulumi.String("2220d9ad-a251-5555-9a0a-4772a6511111"),
		})
		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 getInterfaces = new Checkpoint.ManagementCommandGetInterfaces("getInterfaces", new()
    {
        TargetUid = "2220d9ad-a251-5555-9a0a-4772a6511111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.ManagementCommandGetInterfaces;
import com.pulumi.checkpoint.ManagementCommandGetInterfacesArgs;
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) {
        var getInterfaces = new ManagementCommandGetInterfaces("getInterfaces", ManagementCommandGetInterfacesArgs.builder()
            .targetUid("2220d9ad-a251-5555-9a0a-4772a6511111")
            .build());

    }
}

    resources:
  getInterfaces:
    type: checkpoint:ManagementCommandGetInterfaces
    properties:
      targetUid: 2220d9ad-a251-5555-9a0a-4772a6511111

    Create ManagementCommandGetInterfaces Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ManagementCommandGetInterfaces(name: string, args?: ManagementCommandGetInterfacesArgs, opts?: CustomResourceOptions);
    @overload
def ManagementCommandGetInterfaces(resource_name: str,
                                   args: Optional[ManagementCommandGetInterfacesArgs] = None,
                                   opts: Optional[ResourceOptions] = None)

@overload
def ManagementCommandGetInterfaces(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   group_interfaces_by_subnet: Optional[bool] = None,
                                   management_command_get_interfaces_id: Optional[str] = None,
                                   target_name: Optional[str] = None,
                                   target_uid: Optional[str] = None,
                                   use_defined_by_routes: Optional[bool] = None,
                                   with_topology: Optional[bool] = None)
    func NewManagementCommandGetInterfaces(ctx *Context, name string, args *ManagementCommandGetInterfacesArgs, opts ...ResourceOption) (*ManagementCommandGetInterfaces, error)
    public ManagementCommandGetInterfaces(string name, ManagementCommandGetInterfacesArgs? args = null, CustomResourceOptions? opts = null)
    public ManagementCommandGetInterfaces(String name, ManagementCommandGetInterfacesArgs args)
public ManagementCommandGetInterfaces(String name, ManagementCommandGetInterfacesArgs args, CustomResourceOptions options)

    type: checkpoint:ManagementCommandGetInterfaces
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ManagementCommandGetInterfacesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagementCommandGetInterfacesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagementCommandGetInterfacesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementCommandGetInterfacesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementCommandGetInterfacesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var managementCommandGetInterfacesResource = new Checkpoint.ManagementCommandGetInterfaces("managementCommandGetInterfacesResource", new()
{
    GroupInterfacesBySubnet = false,
    ManagementCommandGetInterfacesId = "string",
    TargetName = "string",
    TargetUid = "string",
    UseDefinedByRoutes = false,
    WithTopology = false,
});

    example, err := checkpoint.NewManagementCommandGetInterfaces(ctx, "managementCommandGetInterfacesResource", &checkpoint.ManagementCommandGetInterfacesArgs{
	GroupInterfacesBySubnet:          pulumi.Bool(false),
	ManagementCommandGetInterfacesId: pulumi.String("string"),
	TargetName:                       pulumi.String("string"),
	TargetUid:                        pulumi.String("string"),
	UseDefinedByRoutes:               pulumi.Bool(false),
	WithTopology:                     pulumi.Bool(false),
})

    var managementCommandGetInterfacesResource = new ManagementCommandGetInterfaces("managementCommandGetInterfacesResource", ManagementCommandGetInterfacesArgs.builder()
    .groupInterfacesBySubnet(false)
    .managementCommandGetInterfacesId("string")
    .targetName("string")
    .targetUid("string")
    .useDefinedByRoutes(false)
    .withTopology(false)
    .build());

    management_command_get_interfaces_resource = checkpoint.ManagementCommandGetInterfaces("managementCommandGetInterfacesResource",
    group_interfaces_by_subnet=False,
    management_command_get_interfaces_id="string",
    target_name="string",
    target_uid="string",
    use_defined_by_routes=False,
    with_topology=False)

    const managementCommandGetInterfacesResource = new checkpoint.ManagementCommandGetInterfaces("managementCommandGetInterfacesResource", {
    groupInterfacesBySubnet: false,
    managementCommandGetInterfacesId: "string",
    targetName: "string",
    targetUid: "string",
    useDefinedByRoutes: false,
    withTopology: false,
});

    type: checkpoint:ManagementCommandGetInterfaces
properties:
    groupInterfacesBySubnet: false
    managementCommandGetInterfacesId: string
    targetName: string
    targetUid: string
    useDefinedByRoutes: false
    withTopology: false

    ManagementCommandGetInterfaces Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ManagementCommandGetInterfaces resource accepts the following input properties:

    GroupInterfacesBySubnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    ManagementCommandGetInterfacesId string
    TargetName string
    Target name.
    TargetUid string
    Target unique identifier.
    UseDefinedByRoutes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    WithTopology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    GroupInterfacesBySubnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    ManagementCommandGetInterfacesId string
    TargetName string
    Target name.
    TargetUid string
    Target unique identifier.
    UseDefinedByRoutes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    WithTopology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet Boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId String
    targetName String
    Target name.
    targetUid String
    Target unique identifier.
    useDefinedByRoutes Boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology Boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId string
    targetName string
    Target name.
    targetUid string
    Target unique identifier.
    useDefinedByRoutes boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    group_interfaces_by_subnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    management_command_get_interfaces_id str
    target_name str
    Target name.
    target_uid str
    Target unique identifier.
    use_defined_by_routes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    with_topology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet Boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId String
    targetName String
    Target name.
    targetUid String
    Target unique identifier.
    useDefinedByRoutes Boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology Boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ManagementCommandGetInterfaces resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    id string
    The provider-assigned unique ID for this managed resource.
    taskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    id str
    The provider-assigned unique ID for this managed resource.
    task_id str
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.

    Look up Existing ManagementCommandGetInterfaces Resource

    Get an existing ManagementCommandGetInterfaces resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ManagementCommandGetInterfacesState, opts?: CustomResourceOptions): ManagementCommandGetInterfaces
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_interfaces_by_subnet: Optional[bool] = None,
        management_command_get_interfaces_id: Optional[str] = None,
        target_name: Optional[str] = None,
        target_uid: Optional[str] = None,
        task_id: Optional[str] = None,
        use_defined_by_routes: Optional[bool] = None,
        with_topology: Optional[bool] = None) -> ManagementCommandGetInterfaces
    func GetManagementCommandGetInterfaces(ctx *Context, name string, id IDInput, state *ManagementCommandGetInterfacesState, opts ...ResourceOption) (*ManagementCommandGetInterfaces, error)
    public static ManagementCommandGetInterfaces Get(string name, Input<string> id, ManagementCommandGetInterfacesState? state, CustomResourceOptions? opts = null)
    public static ManagementCommandGetInterfaces get(String name, Output<String> id, ManagementCommandGetInterfacesState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementCommandGetInterfaces    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GroupInterfacesBySubnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    ManagementCommandGetInterfacesId string
    TargetName string
    Target name.
    TargetUid string
    Target unique identifier.
    TaskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    UseDefinedByRoutes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    WithTopology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    GroupInterfacesBySubnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    ManagementCommandGetInterfacesId string
    TargetName string
    Target name.
    TargetUid string
    Target unique identifier.
    TaskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    UseDefinedByRoutes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    WithTopology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet Boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId String
    targetName String
    Target name.
    targetUid String
    Target unique identifier.
    taskId String
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    useDefinedByRoutes Boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology Boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId string
    targetName string
    Target name.
    targetUid string
    Target unique identifier.
    taskId string
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    useDefinedByRoutes boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    group_interfaces_by_subnet bool
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    management_command_get_interfaces_id str
    target_name str
    Target name.
    target_uid str
    Target unique identifier.
    task_id str
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    use_defined_by_routes bool
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    with_topology bool
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.
    groupInterfacesBySubnet Boolean
    Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.
    managementCommandGetInterfacesId String
    targetName String
    Target name.
    targetUid String
    Target unique identifier.
    taskId String
    The UID of the "get-interfaces" task. Use the "show-task" command to check the progress of the "get-interfaces" task.
    useDefinedByRoutes Boolean
    Specify whether to configure the topology "Defined by Routes" where applicable. Otherwise, configure the topology to "This Network" as default for internal interfaces.
    withTopology Boolean
    Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.

    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
    checkpointsw/terraform-provider-checkpoint