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

checkpoint.getManagementInterface

Explore with Pulumi AI

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

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const example = new checkpoint.ManagementInterface("example", {
        antiSpoofing: true,
        clusterNetworkType: "cluster",
        gatewayUid: "20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17",
        ignoreWarnings: false,
        ipv4Address: "1.1.1.111",
        ipv4MaskLength: 24,
        topology: "internal",
    });
    const data = checkpoint.getManagementInterfaceOutput({
        gatewayUid: example.gatewayUid,
        name: example.name,
    });
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    example = checkpoint.ManagementInterface("example",
        anti_spoofing=True,
        cluster_network_type="cluster",
        gateway_uid="20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17",
        ignore_warnings=False,
        ipv4_address="1.1.1.111",
        ipv4_mask_length=24,
        topology="internal")
    data = checkpoint.get_management_interface_output(gateway_uid=example.gateway_uid,
        name=example.name)
    
    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 {
    		example, err := checkpoint.NewManagementInterface(ctx, "example", &checkpoint.ManagementInterfaceArgs{
    			AntiSpoofing:       pulumi.Bool(true),
    			ClusterNetworkType: pulumi.String("cluster"),
    			GatewayUid:         pulumi.String("20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17"),
    			IgnoreWarnings:     pulumi.Bool(false),
    			Ipv4Address:        pulumi.String("1.1.1.111"),
    			Ipv4MaskLength:     pulumi.Float64(24),
    			Topology:           pulumi.String("internal"),
    		})
    		if err != nil {
    			return err
    		}
    		_ = checkpoint.LookupManagementInterfaceOutput(ctx, checkpoint.GetManagementInterfaceOutputArgs{
    			GatewayUid: example.GatewayUid,
    			Name:       example.Name,
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkpoint = Pulumi.Checkpoint;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Checkpoint.ManagementInterface("example", new()
        {
            AntiSpoofing = true,
            ClusterNetworkType = "cluster",
            GatewayUid = "20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17",
            IgnoreWarnings = false,
            Ipv4Address = "1.1.1.111",
            Ipv4MaskLength = 24,
            Topology = "internal",
        });
    
        var data = Checkpoint.GetManagementInterface.Invoke(new()
        {
            GatewayUid = example.GatewayUid,
            Name = example.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkpoint.ManagementInterface;
    import com.pulumi.checkpoint.ManagementInterfaceArgs;
    import com.pulumi.checkpoint.CheckpointFunctions;
    import com.pulumi.checkpoint.inputs.GetManagementInterfaceArgs;
    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 example = new ManagementInterface("example", ManagementInterfaceArgs.builder()
                .antiSpoofing(true)
                .clusterNetworkType("cluster")
                .gatewayUid("20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17")
                .ignoreWarnings(false)
                .ipv4Address("1.1.1.111")
                .ipv4MaskLength(24)
                .topology("internal")
                .build());
    
            final var data = CheckpointFunctions.getManagementInterface(GetManagementInterfaceArgs.builder()
                .gatewayUid(example.gatewayUid())
                .name(example.name())
                .build());
    
        }
    }
    
    resources:
      example:
        type: checkpoint:ManagementInterface
        properties:
          antiSpoofing: true
          clusterNetworkType: cluster
          gatewayUid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17
          ignoreWarnings: false
          ipv4Address: 1.1.1.111
          ipv4MaskLength: 24
          topology: internal
    variables:
      data:
        fn::invoke:
          function: checkpoint:getManagementInterface
          arguments:
            gatewayUid: ${example.gatewayUid}
            name: ${example.name}
    

    Using getManagementInterface

    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 getManagementInterface(args: GetManagementInterfaceArgs, opts?: InvokeOptions): Promise<GetManagementInterfaceResult>
    function getManagementInterfaceOutput(args: GetManagementInterfaceOutputArgs, opts?: InvokeOptions): Output<GetManagementInterfaceResult>
    def get_management_interface(color: Optional[str] = None,
                                 comments: Optional[str] = None,
                                 gateway_uid: Optional[str] = None,
                                 id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 uid: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetManagementInterfaceResult
    def get_management_interface_output(color: Optional[pulumi.Input[str]] = None,
                                 comments: Optional[pulumi.Input[str]] = None,
                                 gateway_uid: Optional[pulumi.Input[str]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 uid: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetManagementInterfaceResult]
    func LookupManagementInterface(ctx *Context, args *LookupManagementInterfaceArgs, opts ...InvokeOption) (*LookupManagementInterfaceResult, error)
    func LookupManagementInterfaceOutput(ctx *Context, args *LookupManagementInterfaceOutputArgs, opts ...InvokeOption) LookupManagementInterfaceResultOutput

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

    public static class GetManagementInterface 
    {
        public static Task<GetManagementInterfaceResult> InvokeAsync(GetManagementInterfaceArgs args, InvokeOptions? opts = null)
        public static Output<GetManagementInterfaceResult> Invoke(GetManagementInterfaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetManagementInterfaceResult> getManagementInterface(GetManagementInterfaceArgs args, InvokeOptions options)
    public static Output<GetManagementInterfaceResult> getManagementInterface(GetManagementInterfaceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: checkpoint:index/getManagementInterface:getManagementInterface
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    GatewayUid string
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    Id string
    Name string
    Object name.
    Uid string
    Object unique identifier.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    GatewayUid string
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    Id string
    Name string
    Object name.
    Uid string
    Object unique identifier.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    gatewayUid String
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    id String
    name String
    Object name.
    uid String
    Object unique identifier.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    gatewayUid string
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    id string
    name string
    Object name.
    uid string
    Object unique identifier.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    gateway_uid str
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    id str
    name str
    Object name.
    uid str
    Object unique identifier.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    gatewayUid String
    Gateway or cluster object uid that the interface belongs to. Required only if name was specified.
    id String
    name String
    Object name.
    uid String
    Object unique identifier.

    getManagementInterface Result

    The following output properties are available:

    Supporting Types

    GetManagementInterfaceAntiSpoofingSetting

    Action string
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    ExcludePackets bool
    Don't check packets from excluded network.
    ExcludedNetworkName string
    Excluded network name.
    ExcludedNetworkUid string
    Excluded network UID.
    SpoofTracking string
    Spoof tracking.
    Action string
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    ExcludePackets bool
    Don't check packets from excluded network.
    ExcludedNetworkName string
    Excluded network name.
    ExcludedNetworkUid string
    Excluded network UID.
    SpoofTracking string
    Spoof tracking.
    action String
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    excludePackets Boolean
    Don't check packets from excluded network.
    excludedNetworkName String
    Excluded network name.
    excludedNetworkUid String
    Excluded network UID.
    spoofTracking String
    Spoof tracking.
    action string
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    excludePackets boolean
    Don't check packets from excluded network.
    excludedNetworkName string
    Excluded network name.
    excludedNetworkUid string
    Excluded network UID.
    spoofTracking string
    Spoof tracking.
    action str
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    exclude_packets bool
    Don't check packets from excluded network.
    excluded_network_name str
    Excluded network name.
    excluded_network_uid str
    Excluded network UID.
    spoof_tracking str
    Spoof tracking.
    action String
    If packets will be rejected (the Prevent option) or whether the packets will be monitored (the Detect option).
    excludePackets Boolean
    Don't check packets from excluded network.
    excludedNetworkName String
    Excluded network name.
    excludedNetworkUid String
    Excluded network UID.
    spoofTracking String
    Spoof tracking.

    GetManagementInterfaceClusterMember

    Ipv4Address string
    IPv4 address.
    Ipv4MaskLength string
    IPv4 network mask length.
    Ipv4NetworkMask string
    IPv4 network address.
    Ipv6Address string
    IPv6 address.
    Ipv6MaskLength string
    IPv6 network mask length.
    Ipv6NetworkMask string
    IPv6 network address.
    MemberName string
    Cluster member object name.
    MemberUid string
    Cluster member object uid.
    Name string
    Cluster member network interface name.
    NetworkMask string
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.
    Ipv4Address string
    IPv4 address.
    Ipv4MaskLength string
    IPv4 network mask length.
    Ipv4NetworkMask string
    IPv4 network address.
    Ipv6Address string
    IPv6 address.
    Ipv6MaskLength string
    IPv6 network mask length.
    Ipv6NetworkMask string
    IPv6 network address.
    MemberName string
    Cluster member object name.
    MemberUid string
    Cluster member object uid.
    Name string
    Cluster member network interface name.
    NetworkMask string
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.
    ipv4Address String
    IPv4 address.
    ipv4MaskLength String
    IPv4 network mask length.
    ipv4NetworkMask String
    IPv4 network address.
    ipv6Address String
    IPv6 address.
    ipv6MaskLength String
    IPv6 network mask length.
    ipv6NetworkMask String
    IPv6 network address.
    memberName String
    Cluster member object name.
    memberUid String
    Cluster member object uid.
    name String
    Cluster member network interface name.
    networkMask String
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.
    ipv4Address string
    IPv4 address.
    ipv4MaskLength string
    IPv4 network mask length.
    ipv4NetworkMask string
    IPv4 network address.
    ipv6Address string
    IPv6 address.
    ipv6MaskLength string
    IPv6 network mask length.
    ipv6NetworkMask string
    IPv6 network address.
    memberName string
    Cluster member object name.
    memberUid string
    Cluster member object uid.
    name string
    Cluster member network interface name.
    networkMask string
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.
    ipv4_address str
    IPv4 address.
    ipv4_mask_length str
    IPv4 network mask length.
    ipv4_network_mask str
    IPv4 network address.
    ipv6_address str
    IPv6 address.
    ipv6_mask_length str
    IPv6 network mask length.
    ipv6_network_mask str
    IPv6 network address.
    member_name str
    Cluster member object name.
    member_uid str
    Cluster member object uid.
    name str
    Cluster member network interface name.
    network_mask str
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.
    ipv4Address String
    IPv4 address.
    ipv4MaskLength String
    IPv4 network mask length.
    ipv4NetworkMask String
    IPv4 network address.
    ipv6Address String
    IPv6 address.
    ipv6MaskLength String
    IPv6 network mask length.
    ipv6NetworkMask String
    IPv6 network address.
    memberName String
    Cluster member object name.
    memberUid String
    Cluster member object uid.
    name String
    Cluster member network interface name.
    networkMask String
    IPv4 or IPv6 network mask. If both masks are required use ipv4-network-mask and ipv6-network-mask fields explicitly. Instead of providing mask itself it is possible to specify IPv4 or IPv6 mask length in mask-length field. If both masks length are required use ipv4-mask-length and ipv6-mask-length fields explicitly.

    GetManagementInterfaceSecurityZoneSetting

    AutoCalculated bool
    Security Zone is calculated according to where the interface leads to.
    AutoCalculatedZone string
    N/A
    AutoCalculatedZoneUid string
    N/A
    SpecificSecurityZoneEnabled bool
    N/A
    SpecificZone string
    Security Zone specified manually.
    SpecificZoneUid string
    AutoCalculated bool
    Security Zone is calculated according to where the interface leads to.
    AutoCalculatedZone string
    N/A
    AutoCalculatedZoneUid string
    N/A
    SpecificSecurityZoneEnabled bool
    N/A
    SpecificZone string
    Security Zone specified manually.
    SpecificZoneUid string
    autoCalculated Boolean
    Security Zone is calculated according to where the interface leads to.
    autoCalculatedZone String
    N/A
    autoCalculatedZoneUid String
    N/A
    specificSecurityZoneEnabled Boolean
    N/A
    specificZone String
    Security Zone specified manually.
    specificZoneUid String
    autoCalculated boolean
    Security Zone is calculated according to where the interface leads to.
    autoCalculatedZone string
    N/A
    autoCalculatedZoneUid string
    N/A
    specificSecurityZoneEnabled boolean
    N/A
    specificZone string
    Security Zone specified manually.
    specificZoneUid string
    auto_calculated bool
    Security Zone is calculated according to where the interface leads to.
    auto_calculated_zone str
    N/A
    auto_calculated_zone_uid str
    N/A
    specific_security_zone_enabled bool
    N/A
    specific_zone str
    Security Zone specified manually.
    specific_zone_uid str
    autoCalculated Boolean
    Security Zone is calculated according to where the interface leads to.
    autoCalculatedZone String
    N/A
    autoCalculatedZoneUid String
    N/A
    specificSecurityZoneEnabled Boolean
    N/A
    specificZone String
    Security Zone specified manually.
    specificZoneUid String

    GetManagementInterfaceTopologySetting

    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A
    interfaceLeadsToDmz boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface string
    Network settings behind this interface.
    specificNetwork string
    Network behind this interface.
    specificNetworkUid string
    N/A
    interface_leads_to_dmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    ip_address_behind_this_interface str
    Network settings behind this interface.
    specific_network str
    Network behind this interface.
    specific_network_uid str
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A

    GetManagementInterfaceTopologySettingsAutomatic

    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A
    interfaceLeadsToDmz boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface string
    Network settings behind this interface.
    specificNetwork string
    Network behind this interface.
    specificNetworkUid string
    N/A
    interface_leads_to_dmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    ip_address_behind_this_interface str
    Network settings behind this interface.
    specific_network str
    Network behind this interface.
    specific_network_uid str
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A

    GetManagementInterfaceTopologySettingsManual

    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    InterfaceLeadsToDmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    IpAddressBehindThisInterface string
    Network settings behind this interface.
    SpecificNetwork string
    Network behind this interface.
    SpecificNetworkUid string
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A
    interfaceLeadsToDmz boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface string
    Network settings behind this interface.
    specificNetwork string
    Network behind this interface.
    specificNetworkUid string
    N/A
    interface_leads_to_dmz bool
    Whether this interface leads to demilitarized zone (perimeter network).
    ip_address_behind_this_interface str
    Network settings behind this interface.
    specific_network str
    Network behind this interface.
    specific_network_uid str
    N/A
    interfaceLeadsToDmz Boolean
    Whether this interface leads to demilitarized zone (perimeter network).
    ipAddressBehindThisInterface String
    Network settings behind this interface.
    specificNetwork String
    Network behind this interface.
    specificNetworkUid String
    N/A

    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