checkpoint 2.11.0, Sep 3 25

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

checkpointsw/terraform-provider-checkpoint

checkpoint.getManagementHosts

Start a Neo task

Explain and create a checkpoint.getManagementHosts resource

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

checkpointsw/terraform-provider-checkpoint

Example Usage

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

const myQuery = checkpoint.getManagementHosts({
    limit: 15,
});
const myQueryFetchAll = checkpoint.getManagementHosts({
    fetchAll: true,
});

import pulumi
import pulumi_checkpoint as checkpoint

my_query = checkpoint.get_management_hosts(limit=15)
my_query_fetch_all = checkpoint.get_management_hosts(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.GetManagementHosts(ctx, &checkpoint.GetManagementHostsArgs{
			Limit: pulumi.Float64Ref(15),
		}, nil)
		if err != nil {
			return err
		}
		_, err = checkpoint.GetManagementHosts(ctx, &checkpoint.GetManagementHostsArgs{
			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.GetManagementHosts.Invoke(new()
    {
        Limit = 15,
    });

    var myQueryFetchAll = Checkpoint.GetManagementHosts.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.GetManagementHostsArgs;
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.getManagementHosts(GetManagementHostsArgs.builder()
            .limit(15)
            .build());

        final var myQueryFetchAll = CheckpointFunctions.getManagementHosts(GetManagementHostsArgs.builder()
            .fetchAll(true)
            .build());

    }
}

variables:
  myQuery:
    fn::invoke:
      function: checkpoint:getManagementHosts
      arguments:
        limit: 15
  myQueryFetchAll:
    fn::invoke:
      function: checkpoint:getManagementHosts
      arguments:
        fetchAll: true

Using getManagementHosts

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 getManagementHosts(args: GetManagementHostsArgs, opts?: InvokeOptions): Promise<GetManagementHostsResult>
function getManagementHostsOutput(args: GetManagementHostsOutputArgs, opts?: InvokeOptions): Output<GetManagementHostsResult>

def get_management_hosts(fetch_all: Optional[bool] = None,
                         filter: Optional[str] = None,
                         id: Optional[str] = None,
                         limit: Optional[float] = None,
                         offset: Optional[float] = None,
                         orders: Optional[Sequence[GetManagementHostsOrder]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagementHostsResult
def get_management_hosts_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[GetManagementHostsOrderArgs]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagementHostsResult]

func GetManagementHosts(ctx *Context, args *GetManagementHostsArgs, opts ...InvokeOption) (*GetManagementHostsResult, error)
func GetManagementHostsOutput(ctx *Context, args *GetManagementHostsOutputArgs, opts ...InvokeOption) GetManagementHostsResultOutput

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

public static class GetManagementHosts 
{
    public static Task<GetManagementHostsResult> InvokeAsync(GetManagementHostsArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementHostsResult> Invoke(GetManagementHostsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementHostsResult> getManagementHosts(GetManagementHostsArgs args, InvokeOptions options)
public static Output<GetManagementHostsResult> getManagementHosts(GetManagementHostsArgs args, InvokeOptions options)

fn::invoke:
  function: checkpoint:index/getManagementHosts:getManagementHosts
  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<GetManagementHostsOrder>: 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 []GetManagementHostsOrder: 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<GetManagementHostsOrder>: 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 GetManagementHostsOrder[]: 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[GetManagementHostsOrder]: 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.

getManagementHosts Result

The following output properties are available:

From double
Id string
Objects List<GetManagementHostsObject>
To double
Total double
FetchAll bool
Filter string
Limit double
Offset double
Orders List<GetManagementHostsOrder>

From float64
Id string
Objects []GetManagementHostsObject
To float64
Total float64
FetchAll bool
Filter string
Limit float64
Offset float64
Orders []GetManagementHostsOrder

from Double
id String
objects List<GetManagementHostsObject>
to Double
total Double
fetchAll Boolean
filter String
limit Double
offset Double
orders List<GetManagementHostsOrder>

from number
id string
objects GetManagementHostsObject[]
to number
total number
fetchAll boolean
filter string
limit number
offset number
orders GetManagementHostsOrder[]

from_ float
id str
objects Sequence[GetManagementHostsObject]
to float
total float
fetch_all bool
filter str
limit float
offset float
orders Sequence[GetManagementHostsOrder]

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

GetManagementHostsObject

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 information blocks are documented below.
Groups List<string>: Collection of group identifiers.
HostServers List<GetManagementHostsObjectHostServer>: Servers Configuration. Servers Configuration blocks are documented below.
Icon string: Object icon.
Interfaces List<GetManagementHostsObjectInterface>: Host interfaces. Host interfaces blocks are documented below.
Ipv4Address string: IPv4 address.
Ipv6Address string: IPv6 address.
Name string: Object name. Should be unique in the domain.
NatSettings List<GetManagementHostsObjectNatSetting>: NAT settings. NAT settings blocks are documented below.
Tags List<string>: Collection of tag identifiers.
Type string
Uid string: Object unique identifier.

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 information blocks are documented below.
Groups []string: Collection of group identifiers.
HostServers []GetManagementHostsObjectHostServer: Servers Configuration. Servers Configuration blocks are documented below.
Icon string: Object icon.
Interfaces []GetManagementHostsObjectInterface: Host interfaces. Host interfaces blocks are documented below.
Ipv4Address string: IPv4 address.
Ipv6Address string: IPv6 address.
Name string: Object name. Should be unique in the domain.
NatSettings []GetManagementHostsObjectNatSetting: NAT settings. NAT settings blocks are documented below.
Tags []string: Collection of tag identifiers.
Type string
Uid string: Object unique identifier.

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 information blocks are documented below.
groups List<String>: Collection of group identifiers.
hostServers List<GetManagementHostsObjectHostServer>: Servers Configuration. Servers Configuration blocks are documented below.
icon String: Object icon.
interfaces List<GetManagementHostsObjectInterface>: Host interfaces. Host interfaces blocks are documented below.
ipv4Address String: IPv4 address.
ipv6Address String: IPv6 address.
name String: Object name. Should be unique in the domain.
natSettings List<GetManagementHostsObjectNatSetting>: NAT settings. NAT settings blocks are documented below.
tags List<String>: Collection of tag identifiers.
type String
uid String: Object unique identifier.

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 information blocks are documented below.
groups string[]: Collection of group identifiers.
hostServers GetManagementHostsObjectHostServer[]: Servers Configuration. Servers Configuration blocks are documented below.
icon string: Object icon.
interfaces GetManagementHostsObjectInterface[]: Host interfaces. Host interfaces blocks are documented below.
ipv4Address string: IPv4 address.
ipv6Address string: IPv6 address.
name string: Object name. Should be unique in the domain.
natSettings GetManagementHostsObjectNatSetting[]: NAT settings. NAT settings blocks are documented below.
tags string[]: Collection of tag identifiers.
type string
uid string: Object unique identifier.

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 information blocks are documented below.
groups Sequence[str]: Collection of group identifiers.
host_servers Sequence[GetManagementHostsObjectHostServer]: Servers Configuration. Servers Configuration blocks are documented below.
icon str: Object icon.
interfaces Sequence[GetManagementHostsObjectInterface]: Host interfaces. Host interfaces blocks are documented below.
ipv4_address str: IPv4 address.
ipv6_address str: IPv6 address.
name str: Object name. Should be unique in the domain.
nat_settings Sequence[GetManagementHostsObjectNatSetting]: NAT settings. NAT settings blocks are documented below.
tags Sequence[str]: Collection of tag identifiers.
type str
uid str: Object unique identifier.

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 information blocks are documented below.
groups List<String>: Collection of group identifiers.
hostServers List<Property Map>: Servers Configuration. Servers Configuration blocks are documented below.
icon String: Object icon.
interfaces List<Property Map>: Host interfaces. Host interfaces blocks are documented below.
ipv4Address String: IPv4 address.
ipv6Address String: IPv6 address.
name String: Object name. Should be unique in the domain.
natSettings List<Property Map>: NAT settings. NAT settings blocks are documented below.
tags List<String>: Collection of tag identifiers.
type String
uid String: Object unique identifier.

GetManagementHostsObjectHostServer

DnsServer bool: Gets True if this server is a DNS Server.
MailServer bool: Gets True if this server is a Mail Server.
WebServer bool: Gets True if this server is a Web Server.
WebServerConfigs List<GetManagementHostsObjectHostServerWebServerConfig>: Web Server configuration. Web Server configuration blocks are documented below.

DnsServer bool: Gets True if this server is a DNS Server.
MailServer bool: Gets True if this server is a Mail Server.
WebServer bool: Gets True if this server is a Web Server.
WebServerConfigs []GetManagementHostsObjectHostServerWebServerConfig: Web Server configuration. Web Server configuration blocks are documented below.

dnsServer Boolean: Gets True if this server is a DNS Server.
mailServer Boolean: Gets True if this server is a Mail Server.
webServer Boolean: Gets True if this server is a Web Server.
webServerConfigs List<GetManagementHostsObjectHostServerWebServerConfig>: Web Server configuration. Web Server configuration blocks are documented below.

dnsServer boolean: Gets True if this server is a DNS Server.
mailServer boolean: Gets True if this server is a Mail Server.
webServer boolean: Gets True if this server is a Web Server.
webServerConfigs GetManagementHostsObjectHostServerWebServerConfig[]: Web Server configuration. Web Server configuration blocks are documented below.

dns_server bool: Gets True if this server is a DNS Server.
mail_server bool: Gets True if this server is a Mail Server.
web_server bool: Gets True if this server is a Web Server.
web_server_configs Sequence[GetManagementHostsObjectHostServerWebServerConfig]: Web Server configuration. Web Server configuration blocks are documented below.

dnsServer Boolean: Gets True if this server is a DNS Server.
mailServer Boolean: Gets True if this server is a Mail Server.
webServer Boolean: Gets True if this server is a Web Server.
webServerConfigs List<Property Map>: Web Server configuration. Web Server configuration blocks are documented below.

GetManagementHostsObjectHostServerWebServerConfig

AdditionalPorts List<string>: Server additional ports.
ApplicationEngines List<string>: Application engines of this web server.
ListenStandardPort bool: "Whether server listens to standard port.
OperatingSystem string: Operating System.
ProtectedBy string: Network object which protects this server identified by the name or UID.

AdditionalPorts []string: Server additional ports.
ApplicationEngines []string: Application engines of this web server.
ListenStandardPort bool: "Whether server listens to standard port.
OperatingSystem string: Operating System.
ProtectedBy string: Network object which protects this server identified by the name or UID.

additionalPorts List<String>: Server additional ports.
applicationEngines List<String>: Application engines of this web server.
listenStandardPort Boolean: "Whether server listens to standard port.
operatingSystem String: Operating System.
protectedBy String: Network object which protects this server identified by the name or UID.

additionalPorts string[]: Server additional ports.
applicationEngines string[]: Application engines of this web server.
listenStandardPort boolean: "Whether server listens to standard port.
operatingSystem string: Operating System.
protectedBy string: Network object which protects this server identified by the name or UID.

additional_ports Sequence[str]: Server additional ports.
application_engines Sequence[str]: Application engines of this web server.
listen_standard_port bool: "Whether server listens to standard port.
operating_system str: Operating System.
protected_by str: Network object which protects this server identified by the name or UID.

additionalPorts List<String>: Server additional ports.
applicationEngines List<String>: Application engines of this web server.
listenStandardPort Boolean: "Whether server listens to standard port.
operatingSystem String: Operating System.
protectedBy String: Network object which protects this server identified by the name or UID.

GetManagementHostsObjectInterface

Color string: Color of the object. Should be one of existing colors.
Comments string: Comments string.
MaskLength4 double: IPv4 network mask length.
MaskLength6 double: IPv6 network mask length.
Name string: Object name. Should be unique in the domain.
Subnet4 string: IPv4 network address.
Subnet6 string: IPv6 network address.

Color string: Color of the object. Should be one of existing colors.
Comments string: Comments string.
MaskLength4 float64: IPv4 network mask length.
MaskLength6 float64: IPv6 network mask length.
Name string: Object name. Should be unique in the domain.
Subnet4 string: IPv4 network address.
Subnet6 string: IPv6 network address.

color String: Color of the object. Should be one of existing colors.
comments String: Comments string.
maskLength4 Double: IPv4 network mask length.
maskLength6 Double: IPv6 network mask length.
name String: Object name. Should be unique in the domain.
subnet4 String: IPv4 network address.
subnet6 String: IPv6 network address.

color string: Color of the object. Should be one of existing colors.
comments string: Comments string.
maskLength4 number: IPv4 network mask length.
maskLength6 number: IPv6 network mask length.
name string: Object name. Should be unique in the domain.
subnet4 string: IPv4 network address.
subnet6 string: IPv6 network address.

color str: Color of the object. Should be one of existing colors.
comments str: Comments string.
mask_length4 float: IPv4 network mask length.
mask_length6 float: IPv6 network mask length.
name str: Object name. Should be unique in the domain.
subnet4 str: IPv4 network address.
subnet6 str: IPv6 network address.

color String: Color of the object. Should be one of existing colors.
comments String: Comments string.
maskLength4 Number: IPv4 network mask length.
maskLength6 Number: IPv6 network mask length.
name String: Object name. Should be unique in the domain.
subnet4 String: IPv4 network address.
subnet6 String: IPv6 network address.

GetManagementHostsObjectNatSetting

AutoRule bool: Whether to add automatic address translation rules.
HideBehind string: Hide behind method. This parameter is not required in case "method" parameter is "static".
InstallOn string: Which gateway should apply the NAT translation.
Ipv4Address string: IPv4 address.
Ipv6Address string: IPv6 address.
Method string: NAT translation method.

AutoRule bool: Whether to add automatic address translation rules.
HideBehind string: Hide behind method. This parameter is not required in case "method" parameter is "static".
InstallOn string: Which gateway should apply the NAT translation.
Ipv4Address string: IPv4 address.
Ipv6Address string: IPv6 address.
Method string: NAT translation method.

autoRule Boolean: Whether to add automatic address translation rules.
hideBehind String: Hide behind method. This parameter is not required in case "method" parameter is "static".
installOn String: Which gateway should apply the NAT translation.
ipv4Address String: IPv4 address.
ipv6Address String: IPv6 address.
method String: NAT translation method.

autoRule boolean: Whether to add automatic address translation rules.
hideBehind string: Hide behind method. This parameter is not required in case "method" parameter is "static".
installOn string: Which gateway should apply the NAT translation.
ipv4Address string: IPv4 address.
ipv6Address string: IPv6 address.
method string: NAT translation method.

auto_rule bool: Whether to add automatic address translation rules.
hide_behind str: Hide behind method. This parameter is not required in case "method" parameter is "static".
install_on str: Which gateway should apply the NAT translation.
ipv4_address str: IPv4 address.
ipv6_address str: IPv6 address.
method str: NAT translation method.

autoRule Boolean: Whether to add automatic address translation rules.
hideBehind String: Hide behind method. This parameter is not required in case "method" parameter is "static".
installOn String: Which gateway should apply the NAT translation.
ipv4Address String: IPv4 address.
ipv6Address String: IPv6 address.
method String: NAT translation method.

GetManagementHostsOrder

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 2.11.0 published on Wednesday, Sep 3, 2025 by checkpointsw

checkpointsw/terraform-provider-checkpoint

checkpoint.getManagementHosts

On this page

On this page

Example Usage

Using getManagementHosts

getManagementHosts Result

Supporting Types

GetManagementHostsObject

GetManagementHostsObjectHostServer

GetManagementHostsObjectHostServerWebServerConfig

GetManagementHostsObjectInterface

GetManagementHostsObjectNatSetting

GetManagementHostsOrder

Package Details

On this page

On this page