1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. getManagementNetworks
checkpoint 2.11.0 published on Wednesday, Sep 3, 2025 by checkpointsw

checkpoint.getManagementNetworks

Explore with Pulumi AI

checkpoint logo
checkpoint 2.11.0 published on Wednesday, Sep 3, 2025 by checkpointsw

    Use this data source to get information on networks.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const myQuery = checkpoint.getManagementNetworks({
        limit: 15,
    });
    const myQueryFetchAll = checkpoint.getManagementNetworks({
        fetchAll: true,
    });
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    my_query = checkpoint.get_management_networks(limit=15)
    my_query_fetch_all = checkpoint.get_management_networks(fetch_all=True)
    
    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.GetManagementNetworks(ctx, &checkpoint.GetManagementNetworksArgs{
    			Limit: pulumi.Float64Ref(15),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = checkpoint.GetManagementNetworks(ctx, &checkpoint.GetManagementNetworksArgs{
    			FetchAll: pulumi.BoolRef(true),
    		}, 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 myQuery = Checkpoint.GetManagementNetworks.Invoke(new()
        {
            Limit = 15,
        });
    
        var myQueryFetchAll = Checkpoint.GetManagementNetworks.Invoke(new()
        {
            FetchAll = true,
        });
    
    });
    
    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.GetManagementNetworksArgs;
    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 myQuery = CheckpointFunctions.getManagementNetworks(GetManagementNetworksArgs.builder()
                .limit(15)
                .build());
    
            final var myQueryFetchAll = CheckpointFunctions.getManagementNetworks(GetManagementNetworksArgs.builder()
                .fetchAll(true)
                .build());
    
        }
    }
    
    variables:
      myQuery:
        fn::invoke:
          function: checkpoint:getManagementNetworks
          arguments:
            limit: 15
      myQueryFetchAll:
        fn::invoke:
          function: checkpoint:getManagementNetworks
          arguments:
            fetchAll: true
    

    Using getManagementNetworks

    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 getManagementNetworks(args: GetManagementNetworksArgs, opts?: InvokeOptions): Promise<GetManagementNetworksResult>
    function getManagementNetworksOutput(args: GetManagementNetworksOutputArgs, opts?: InvokeOptions): Output<GetManagementNetworksResult>
    def get_management_networks(fetch_all: Optional[bool] = None,
                                filter: Optional[str] = None,
                                id: Optional[str] = None,
                                limit: Optional[float] = None,
                                offset: Optional[float] = None,
                                orders: Optional[Sequence[GetManagementNetworksOrder]] = None,
                                opts: Optional[InvokeOptions] = None) -> GetManagementNetworksResult
    def get_management_networks_output(fetch_all: Optional[pulumi.Input[bool]] = None,
                                filter: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                limit: Optional[pulumi.Input[float]] = None,
                                offset: Optional[pulumi.Input[float]] = None,
                                orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementNetworksOrderArgs]]]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetManagementNetworksResult]
    func GetManagementNetworks(ctx *Context, args *GetManagementNetworksArgs, opts ...InvokeOption) (*GetManagementNetworksResult, error)
    func GetManagementNetworksOutput(ctx *Context, args *GetManagementNetworksOutputArgs, opts ...InvokeOption) GetManagementNetworksResultOutput

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

    public static class GetManagementNetworks 
    {
        public static Task<GetManagementNetworksResult> InvokeAsync(GetManagementNetworksArgs args, InvokeOptions? opts = null)
        public static Output<GetManagementNetworksResult> Invoke(GetManagementNetworksInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetManagementNetworksResult> getManagementNetworks(GetManagementNetworksArgs args, InvokeOptions options)
    public static Output<GetManagementNetworksResult> getManagementNetworks(GetManagementNetworksArgs args, InvokeOptions options)
    
    fn::invoke:
      function: checkpoint:index/getManagementNetworks:getManagementNetworks
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FetchAll bool
    If true, fetches all results.
    Filter string
    Search expression to filter objects by.
    Id string
    Limit double
    The maximal number of returned results.
    Offset double
    Number of the results to initially skip.
    Orders List<GetManagementNetworksOrder>
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    FetchAll bool
    If true, fetches all results.
    Filter string
    Search expression to filter objects by.
    Id string
    Limit float64
    The maximal number of returned results.
    Offset float64
    Number of the results to initially skip.
    Orders []GetManagementNetworksOrder
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    fetchAll Boolean
    If true, fetches all results.
    filter String
    Search expression to filter objects by.
    id String
    limit Double
    The maximal number of returned results.
    offset Double
    Number of the results to initially skip.
    orders List<GetManagementNetworksOrder>
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    fetchAll boolean
    If true, fetches all results.
    filter string
    Search expression to filter objects by.
    id string
    limit number
    The maximal number of returned results.
    offset number
    Number of the results to initially skip.
    orders GetManagementNetworksOrder[]
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    fetch_all bool
    If true, fetches all results.
    filter str
    Search expression to filter objects by.
    id str
    limit float
    The maximal number of returned results.
    offset float
    Number of the results to initially skip.
    orders Sequence[GetManagementNetworksOrder]
    Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. order blocks are documented below.
    fetchAll Boolean
    If true, fetches all results.
    filter String
    Search expression to filter objects by.
    id String
    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.

    getManagementNetworks Result

    The following output properties are available:

    from Number
    id String
    objects List<Property Map>
    to Number
    total Number
    fetchAll Boolean
    filter String
    limit Number
    offset Number
    orders List<Property Map>

    Supporting Types

    GetManagementNetworksObject

    Broadcast string
    Allow broadcast address inclusion.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    Domain Dictionary<string, string>
    Information about the domain that holds the Object. domain blocks are documented below.
    Groups List<string>
    Collection of group identifiers.
    Icon string
    Object icon.
    MaskLength4 double
    IPv4 network mask length.
    MaskLength6 double
    IPv6 network mask length.
    Name string
    Object name. Should be unique in the domain.
    NatSettings Dictionary<string, string>
    NAT settings. nat_settings blocks are documented below.
    Subnet4 string
    IPv4 network address.
    Subnet6 string
    IPv6 network address.
    SubnetMask string
    IPv4 network mask.
    Tags List<string>
    Collection of tag identifiers.
    Uid string
    Object unique identifier.
    Broadcast string
    Allow broadcast address inclusion.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    Domain map[string]string
    Information about the domain that holds the Object. domain blocks are documented below.
    Groups []string
    Collection of group identifiers.
    Icon string
    Object icon.
    MaskLength4 float64
    IPv4 network mask length.
    MaskLength6 float64
    IPv6 network mask length.
    Name string
    Object name. Should be unique in the domain.
    NatSettings map[string]string
    NAT settings. nat_settings blocks are documented below.
    Subnet4 string
    IPv4 network address.
    Subnet6 string
    IPv6 network address.
    SubnetMask string
    IPv4 network mask.
    Tags []string
    Collection of tag identifiers.
    Uid string
    Object unique identifier.
    broadcast String
    Allow broadcast address inclusion.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    domain Map<String,String>
    Information about the domain that holds the Object. domain blocks are documented below.
    groups List<String>
    Collection of group identifiers.
    icon String
    Object icon.
    maskLength4 Double
    IPv4 network mask length.
    maskLength6 Double
    IPv6 network mask length.
    name String
    Object name. Should be unique in the domain.
    natSettings Map<String,String>
    NAT settings. nat_settings blocks are documented below.
    subnet4 String
    IPv4 network address.
    subnet6 String
    IPv6 network address.
    subnetMask String
    IPv4 network mask.
    tags List<String>
    Collection of tag identifiers.
    uid String
    Object unique identifier.
    broadcast string
    Allow broadcast address inclusion.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    domain {[key: string]: string}
    Information about the domain that holds the Object. domain blocks are documented below.
    groups string[]
    Collection of group identifiers.
    icon string
    Object icon.
    maskLength4 number
    IPv4 network mask length.
    maskLength6 number
    IPv6 network mask length.
    name string
    Object name. Should be unique in the domain.
    natSettings {[key: string]: string}
    NAT settings. nat_settings blocks are documented below.
    subnet4 string
    IPv4 network address.
    subnet6 string
    IPv6 network address.
    subnetMask string
    IPv4 network mask.
    tags string[]
    Collection of tag identifiers.
    uid string
    Object unique identifier.
    broadcast str
    Allow broadcast address inclusion.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    domain Mapping[str, str]
    Information about the domain that holds the Object. domain blocks are documented below.
    groups Sequence[str]
    Collection of group identifiers.
    icon str
    Object icon.
    mask_length4 float
    IPv4 network mask length.
    mask_length6 float
    IPv6 network mask length.
    name str
    Object name. Should be unique in the domain.
    nat_settings Mapping[str, str]
    NAT settings. nat_settings blocks are documented below.
    subnet4 str
    IPv4 network address.
    subnet6 str
    IPv6 network address.
    subnet_mask str
    IPv4 network mask.
    tags Sequence[str]
    Collection of tag identifiers.
    uid str
    Object unique identifier.
    broadcast String
    Allow broadcast address inclusion.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    domain Map<String>
    Information about the domain that holds the Object. domain blocks are documented below.
    groups List<String>
    Collection of group identifiers.
    icon String
    Object icon.
    maskLength4 Number
    IPv4 network mask length.
    maskLength6 Number
    IPv6 network mask length.
    name String
    Object name. Should be unique in the domain.
    natSettings Map<String>
    NAT settings. nat_settings blocks are documented below.
    subnet4 String
    IPv4 network address.
    subnet6 String
    IPv6 network address.
    subnetMask String
    IPv4 network mask.
    tags List<String>
    Collection of tag identifiers.
    uid String
    Object unique identifier.

    GetManagementNetworksOrder

    Asc string
    Sorts results by the given field in ascending order.
    Desc string
    Sorts results by the given field in descending order.
    Asc string
    Sorts results by the given field in ascending order.
    Desc string
    Sorts results by the given field in descending order.
    asc String
    Sorts results by the given field in ascending order.
    desc String
    Sorts results by the given field in descending order.
    asc string
    Sorts results by the given field in ascending order.
    desc string
    Sorts results by the given field in descending order.
    asc str
    Sorts results by the given field in ascending order.
    desc str
    Sorts results by the given field in descending order.
    asc String
    Sorts results by the given field in ascending order.
    desc String
    Sorts results by the given field in descending order.

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    checkpoint logo
    checkpoint 2.11.0 published on Wednesday, Sep 3, 2025 by checkpointsw