Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Spectrocloud Provider
  3. API Docs
  4. PrivatecloudgatewayIppool
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud
spectrocloud/terraform-provider-spectrocloud

spectrocloud.PrivatecloudgatewayIppool

Explore with Pulumi AI

spectrocloud logo
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud
spectrocloud/terraform-provider-spectrocloud

    A Resource to manage IP pools for Private Cloud Gateway.

    You can learn more about Private Cloud Gateways IP Pools by revewing the Create and Manage IPAM Node Pools guide.

    Example Usage

    An example of creating an IP Pool for a Private Cloud Gateway using a range of IP addresses and restricting the IP Pool to a single cluster.

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

const pcg = spectrocloud.getPrivateCloudGateway({
    name: "wst-1-pcg",
});
const ippool = new spectrocloud.PrivatecloudgatewayIppool("ippool", {
    gateway: "192.168.1.1",
    networkType: "range",
    prefix: 24,
    privateCloudGatewayId: pcg.then(pcg => pcg.id),
    ipStartRange: "192.168.1.10",
    ipEndRange: "192.168.1.100",
    nameserverAddresses: ["192.168.1.8"],
    restrictToSingleCluster: true,
});

    import pulumi
import pulumi_spectrocloud as spectrocloud

pcg = spectrocloud.get_private_cloud_gateway(name="wst-1-pcg")
ippool = spectrocloud.PrivatecloudgatewayIppool("ippool",
    gateway="192.168.1.1",
    network_type="range",
    prefix=24,
    private_cloud_gateway_id=pcg.id,
    ip_start_range="192.168.1.10",
    ip_end_range="192.168.1.100",
    nameserver_addresses=["192.168.1.8"],
    restrict_to_single_cluster=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pcg, err := spectrocloud.GetPrivateCloudGateway(ctx, &spectrocloud.GetPrivateCloudGatewayArgs{
			Name: pulumi.StringRef("wst-1-pcg"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = spectrocloud.NewPrivatecloudgatewayIppool(ctx, "ippool", &spectrocloud.PrivatecloudgatewayIppoolArgs{
			Gateway:               pulumi.String("192.168.1.1"),
			NetworkType:           pulumi.String("range"),
			Prefix:                pulumi.Float64(24),
			PrivateCloudGatewayId: pulumi.String(pcg.Id),
			IpStartRange:          pulumi.String("192.168.1.10"),
			IpEndRange:            pulumi.String("192.168.1.100"),
			NameserverAddresses: pulumi.StringArray{
				pulumi.String("192.168.1.8"),
			},
			RestrictToSingleCluster: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Spectrocloud = Pulumi.Spectrocloud;

return await Deployment.RunAsync(() => 
{
    var pcg = Spectrocloud.GetPrivateCloudGateway.Invoke(new()
    {
        Name = "wst-1-pcg",
    });

    var ippool = new Spectrocloud.PrivatecloudgatewayIppool("ippool", new()
    {
        Gateway = "192.168.1.1",
        NetworkType = "range",
        Prefix = 24,
        PrivateCloudGatewayId = pcg.Apply(getPrivateCloudGatewayResult => getPrivateCloudGatewayResult.Id),
        IpStartRange = "192.168.1.10",
        IpEndRange = "192.168.1.100",
        NameserverAddresses = new[]
        {
            "192.168.1.8",
        },
        RestrictToSingleCluster = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spectrocloud.SpectrocloudFunctions;
import com.pulumi.spectrocloud.inputs.GetPrivateCloudGatewayArgs;
import com.pulumi.spectrocloud.PrivatecloudgatewayIppool;
import com.pulumi.spectrocloud.PrivatecloudgatewayIppoolArgs;
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 pcg = SpectrocloudFunctions.getPrivateCloudGateway(GetPrivateCloudGatewayArgs.builder()
            .name("wst-1-pcg")
            .build());

        var ippool = new PrivatecloudgatewayIppool("ippool", PrivatecloudgatewayIppoolArgs.builder()
            .gateway("192.168.1.1")
            .networkType("range")
            .prefix("24")
            .privateCloudGatewayId(pcg.applyValue(getPrivateCloudGatewayResult -> getPrivateCloudGatewayResult.id()))
            .ipStartRange("192.168.1.10")
            .ipEndRange("192.168.1.100")
            .nameserverAddresses("192.168.1.8")
            .restrictToSingleCluster(true)
            .build());

    }
}

    resources:
  ippool:
    type: spectrocloud:PrivatecloudgatewayIppool
    properties:
      gateway: 192.168.1.1
      networkType: range
      prefix: '24'
      privateCloudGatewayId: ${pcg.id}
      ipStartRange: 192.168.1.10
      ipEndRange: 192.168.1.100
      nameserverAddresses:
        - 192.168.1.8
      restrictToSingleCluster: true
variables:
  pcg:
    fn::invoke:
      function: spectrocloud:getPrivateCloudGateway
      arguments:
        name: wst-1-pcg

    An example of creating an IP Pool for a Private Cloud Gateway using a subnet of IP addresses.

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

const pcg = spectrocloud.getPrivateCloudGateway({
    name: "east-3-pcg",
});
const ippool = new spectrocloud.PrivatecloudgatewayIppool("ippool", {
    gateway: "10.10.192.1",
    networkType: "subnet",
    prefix: 24,
    subnetCidr: "10.10.100.0/24",
    privateCloudGatewayId: pcg.then(pcg => pcg.id),
    nameserverAddresses: ["192.168.1.8"],
});

    import pulumi
import pulumi_spectrocloud as spectrocloud

pcg = spectrocloud.get_private_cloud_gateway(name="east-3-pcg")
ippool = spectrocloud.PrivatecloudgatewayIppool("ippool",
    gateway="10.10.192.1",
    network_type="subnet",
    prefix=24,
    subnet_cidr="10.10.100.0/24",
    private_cloud_gateway_id=pcg.id,
    nameserver_addresses=["192.168.1.8"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pcg, err := spectrocloud.GetPrivateCloudGateway(ctx, &spectrocloud.GetPrivateCloudGatewayArgs{
			Name: pulumi.StringRef("east-3-pcg"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = spectrocloud.NewPrivatecloudgatewayIppool(ctx, "ippool", &spectrocloud.PrivatecloudgatewayIppoolArgs{
			Gateway:               pulumi.String("10.10.192.1"),
			NetworkType:           pulumi.String("subnet"),
			Prefix:                pulumi.Float64(24),
			SubnetCidr:            pulumi.String("10.10.100.0/24"),
			PrivateCloudGatewayId: pulumi.String(pcg.Id),
			NameserverAddresses: pulumi.StringArray{
				pulumi.String("192.168.1.8"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Spectrocloud = Pulumi.Spectrocloud;

return await Deployment.RunAsync(() => 
{
    var pcg = Spectrocloud.GetPrivateCloudGateway.Invoke(new()
    {
        Name = "east-3-pcg",
    });

    var ippool = new Spectrocloud.PrivatecloudgatewayIppool("ippool", new()
    {
        Gateway = "10.10.192.1",
        NetworkType = "subnet",
        Prefix = 24,
        SubnetCidr = "10.10.100.0/24",
        PrivateCloudGatewayId = pcg.Apply(getPrivateCloudGatewayResult => getPrivateCloudGatewayResult.Id),
        NameserverAddresses = new[]
        {
            "192.168.1.8",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spectrocloud.SpectrocloudFunctions;
import com.pulumi.spectrocloud.inputs.GetPrivateCloudGatewayArgs;
import com.pulumi.spectrocloud.PrivatecloudgatewayIppool;
import com.pulumi.spectrocloud.PrivatecloudgatewayIppoolArgs;
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 pcg = SpectrocloudFunctions.getPrivateCloudGateway(GetPrivateCloudGatewayArgs.builder()
            .name("east-3-pcg")
            .build());

        var ippool = new PrivatecloudgatewayIppool("ippool", PrivatecloudgatewayIppoolArgs.builder()
            .gateway("10.10.192.1")
            .networkType("subnet")
            .prefix("24")
            .subnetCidr("10.10.100.0/24")
            .privateCloudGatewayId(pcg.applyValue(getPrivateCloudGatewayResult -> getPrivateCloudGatewayResult.id()))
            .nameserverAddresses("192.168.1.8")
            .build());

    }
}

    resources:
  ippool:
    type: spectrocloud:PrivatecloudgatewayIppool
    properties:
      gateway: 10.10.192.1
      networkType: subnet
      prefix: '24'
      subnetCidr: 10.10.100.0/24
      privateCloudGatewayId: ${pcg.id}
      nameserverAddresses:
        - 192.168.1.8
variables:
  pcg:
    fn::invoke:
      function: spectrocloud:getPrivateCloudGateway
      arguments:
        name: east-3-pcg

    Create PrivatecloudgatewayIppool Resource

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

    Constructor syntax

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

@overload
def PrivatecloudgatewayIppool(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              network_type: Optional[str] = None,
                              private_cloud_gateway_id: Optional[str] = None,
                              prefix: Optional[float] = None,
                              gateway: Optional[str] = None,
                              name: Optional[str] = None,
                              nameserver_search_suffixes: Optional[Sequence[str]] = None,
                              nameserver_addresses: Optional[Sequence[str]] = None,
                              ip_start_range: Optional[str] = None,
                              ip_end_range: Optional[str] = None,
                              privatecloudgateway_ippool_id: Optional[str] = None,
                              restrict_to_single_cluster: Optional[bool] = None,
                              subnet_cidr: Optional[str] = None,
                              timeouts: Optional[PrivatecloudgatewayIppoolTimeoutsArgs] = None)
    func NewPrivatecloudgatewayIppool(ctx *Context, name string, args PrivatecloudgatewayIppoolArgs, opts ...ResourceOption) (*PrivatecloudgatewayIppool, error)
    public PrivatecloudgatewayIppool(string name, PrivatecloudgatewayIppoolArgs args, CustomResourceOptions? opts = null)
    public PrivatecloudgatewayIppool(String name, PrivatecloudgatewayIppoolArgs args)
public PrivatecloudgatewayIppool(String name, PrivatecloudgatewayIppoolArgs args, CustomResourceOptions options)

    type: spectrocloud:PrivatecloudgatewayIppool
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 PrivatecloudgatewayIppoolArgs
    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 PrivatecloudgatewayIppoolArgs
    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 PrivatecloudgatewayIppoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivatecloudgatewayIppoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivatecloudgatewayIppoolArgs
    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 privatecloudgatewayIppoolResource = new Spectrocloud.PrivatecloudgatewayIppool("privatecloudgatewayIppoolResource", new()
{
    NetworkType = "string",
    PrivateCloudGatewayId = "string",
    Prefix = 0,
    Gateway = "string",
    Name = "string",
    NameserverSearchSuffixes = new[]
    {
        "string",
    },
    NameserverAddresses = new[]
    {
        "string",
    },
    IpStartRange = "string",
    IpEndRange = "string",
    PrivatecloudgatewayIppoolId = "string",
    RestrictToSingleCluster = false,
    SubnetCidr = "string",
    Timeouts = new Spectrocloud.Inputs.PrivatecloudgatewayIppoolTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := spectrocloud.NewPrivatecloudgatewayIppool(ctx, "privatecloudgatewayIppoolResource", &spectrocloud.PrivatecloudgatewayIppoolArgs{
	NetworkType:           pulumi.String("string"),
	PrivateCloudGatewayId: pulumi.String("string"),
	Prefix:                pulumi.Float64(0),
	Gateway:               pulumi.String("string"),
	Name:                  pulumi.String("string"),
	NameserverSearchSuffixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	NameserverAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpStartRange:                pulumi.String("string"),
	IpEndRange:                  pulumi.String("string"),
	PrivatecloudgatewayIppoolId: pulumi.String("string"),
	RestrictToSingleCluster:     pulumi.Bool(false),
	SubnetCidr:                  pulumi.String("string"),
	Timeouts: &spectrocloud.PrivatecloudgatewayIppoolTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var privatecloudgatewayIppoolResource = new PrivatecloudgatewayIppool("privatecloudgatewayIppoolResource", PrivatecloudgatewayIppoolArgs.builder()
    .networkType("string")
    .privateCloudGatewayId("string")
    .prefix(0)
    .gateway("string")
    .name("string")
    .nameserverSearchSuffixes("string")
    .nameserverAddresses("string")
    .ipStartRange("string")
    .ipEndRange("string")
    .privatecloudgatewayIppoolId("string")
    .restrictToSingleCluster(false)
    .subnetCidr("string")
    .timeouts(PrivatecloudgatewayIppoolTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    privatecloudgateway_ippool_resource = spectrocloud.PrivatecloudgatewayIppool("privatecloudgatewayIppoolResource",
    network_type="string",
    private_cloud_gateway_id="string",
    prefix=0,
    gateway="string",
    name="string",
    nameserver_search_suffixes=["string"],
    nameserver_addresses=["string"],
    ip_start_range="string",
    ip_end_range="string",
    privatecloudgateway_ippool_id="string",
    restrict_to_single_cluster=False,
    subnet_cidr="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const privatecloudgatewayIppoolResource = new spectrocloud.PrivatecloudgatewayIppool("privatecloudgatewayIppoolResource", {
    networkType: "string",
    privateCloudGatewayId: "string",
    prefix: 0,
    gateway: "string",
    name: "string",
    nameserverSearchSuffixes: ["string"],
    nameserverAddresses: ["string"],
    ipStartRange: "string",
    ipEndRange: "string",
    privatecloudgatewayIppoolId: "string",
    restrictToSingleCluster: false,
    subnetCidr: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: spectrocloud:PrivatecloudgatewayIppool
properties:
    gateway: string
    ipEndRange: string
    ipStartRange: string
    name: string
    nameserverAddresses:
        - string
    nameserverSearchSuffixes:
        - string
    networkType: string
    prefix: 0
    privateCloudGatewayId: string
    privatecloudgatewayIppoolId: string
    restrictToSingleCluster: false
    subnetCidr: string
    timeouts:
        create: string
        delete: string
        update: string

    PrivatecloudgatewayIppool 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 PrivatecloudgatewayIppool resource accepts the following input properties:

    Gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    NetworkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    Prefix double
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    PrivateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    IpEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    IpStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    Name string
    The name of the IP pool.
    NameserverAddresses List<string>
    The list of nameserver IP addresses for the IP pool.
    NameserverSearchSuffixes List<string>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    PrivatecloudgatewayIppoolId string
    The ID of this resource.
    RestrictToSingleCluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    SubnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    Timeouts PrivatecloudgatewayIppoolTimeouts
    Gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    NetworkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    Prefix float64
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    PrivateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    IpEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    IpStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    Name string
    The name of the IP pool.
    NameserverAddresses []string
    The list of nameserver IP addresses for the IP pool.
    NameserverSearchSuffixes []string
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    PrivatecloudgatewayIppoolId string
    The ID of this resource.
    RestrictToSingleCluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    SubnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    Timeouts PrivatecloudgatewayIppoolTimeoutsArgs
    gateway String
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    networkType String
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix Double
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId String
    The ID of the Private Cloud Gateway.
    ipEndRange String
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange String
    The start IP address of the IP pool. Required if network_type is range.
    name String
    The name of the IP pool.
    nameserverAddresses List<String>
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes List<String>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    privatecloudgatewayIppoolId String
    The ID of this resource.
    restrictToSingleCluster Boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr String
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeouts
    gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    networkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix number
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    ipEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    name string
    The name of the IP pool.
    nameserverAddresses string[]
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes string[]
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    privatecloudgatewayIppoolId string
    The ID of this resource.
    restrictToSingleCluster boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeouts
    gateway str
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    network_type str
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix float
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    private_cloud_gateway_id str
    The ID of the Private Cloud Gateway.
    ip_end_range str
    The end IP address of the IP pool. Required if network_type is range.
    ip_start_range str
    The start IP address of the IP pool. Required if network_type is range.
    name str
    The name of the IP pool.
    nameserver_addresses Sequence[str]
    The list of nameserver IP addresses for the IP pool.
    nameserver_search_suffixes Sequence[str]
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    privatecloudgateway_ippool_id str
    The ID of this resource.
    restrict_to_single_cluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnet_cidr str
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeoutsArgs
    gateway String
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    networkType String
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix Number
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId String
    The ID of the Private Cloud Gateway.
    ipEndRange String
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange String
    The start IP address of the IP pool. Required if network_type is range.
    name String
    The name of the IP pool.
    nameserverAddresses List<String>
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes List<String>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    privatecloudgatewayIppoolId String
    The ID of this resource.
    restrictToSingleCluster Boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr String
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PrivatecloudgatewayIppool Resource

    Get an existing PrivatecloudgatewayIppool 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?: PrivatecloudgatewayIppoolState, opts?: CustomResourceOptions): PrivatecloudgatewayIppool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gateway: Optional[str] = None,
        ip_end_range: Optional[str] = None,
        ip_start_range: Optional[str] = None,
        name: Optional[str] = None,
        nameserver_addresses: Optional[Sequence[str]] = None,
        nameserver_search_suffixes: Optional[Sequence[str]] = None,
        network_type: Optional[str] = None,
        prefix: Optional[float] = None,
        private_cloud_gateway_id: Optional[str] = None,
        privatecloudgateway_ippool_id: Optional[str] = None,
        restrict_to_single_cluster: Optional[bool] = None,
        subnet_cidr: Optional[str] = None,
        timeouts: Optional[PrivatecloudgatewayIppoolTimeoutsArgs] = None) -> PrivatecloudgatewayIppool
    func GetPrivatecloudgatewayIppool(ctx *Context, name string, id IDInput, state *PrivatecloudgatewayIppoolState, opts ...ResourceOption) (*PrivatecloudgatewayIppool, error)
    public static PrivatecloudgatewayIppool Get(string name, Input<string> id, PrivatecloudgatewayIppoolState? state, CustomResourceOptions? opts = null)
    public static PrivatecloudgatewayIppool get(String name, Output<String> id, PrivatecloudgatewayIppoolState state, CustomResourceOptions options)
    resources:  _:    type: spectrocloud:PrivatecloudgatewayIppool    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:
    Gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    IpEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    IpStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    Name string
    The name of the IP pool.
    NameserverAddresses List<string>
    The list of nameserver IP addresses for the IP pool.
    NameserverSearchSuffixes List<string>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    NetworkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    Prefix double
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    PrivateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    PrivatecloudgatewayIppoolId string
    The ID of this resource.
    RestrictToSingleCluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    SubnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    Timeouts PrivatecloudgatewayIppoolTimeouts
    Gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    IpEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    IpStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    Name string
    The name of the IP pool.
    NameserverAddresses []string
    The list of nameserver IP addresses for the IP pool.
    NameserverSearchSuffixes []string
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    NetworkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    Prefix float64
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    PrivateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    PrivatecloudgatewayIppoolId string
    The ID of this resource.
    RestrictToSingleCluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    SubnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    Timeouts PrivatecloudgatewayIppoolTimeoutsArgs
    gateway String
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    ipEndRange String
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange String
    The start IP address of the IP pool. Required if network_type is range.
    name String
    The name of the IP pool.
    nameserverAddresses List<String>
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes List<String>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    networkType String
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix Double
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId String
    The ID of the Private Cloud Gateway.
    privatecloudgatewayIppoolId String
    The ID of this resource.
    restrictToSingleCluster Boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr String
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeouts
    gateway string
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    ipEndRange string
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange string
    The start IP address of the IP pool. Required if network_type is range.
    name string
    The name of the IP pool.
    nameserverAddresses string[]
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes string[]
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    networkType string
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix number
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId string
    The ID of the Private Cloud Gateway.
    privatecloudgatewayIppoolId string
    The ID of this resource.
    restrictToSingleCluster boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr string
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeouts
    gateway str
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    ip_end_range str
    The end IP address of the IP pool. Required if network_type is range.
    ip_start_range str
    The start IP address of the IP pool. Required if network_type is range.
    name str
    The name of the IP pool.
    nameserver_addresses Sequence[str]
    The list of nameserver IP addresses for the IP pool.
    nameserver_search_suffixes Sequence[str]
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    network_type str
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix float
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    private_cloud_gateway_id str
    The ID of the Private Cloud Gateway.
    privatecloudgateway_ippool_id str
    The ID of this resource.
    restrict_to_single_cluster bool
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnet_cidr str
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts PrivatecloudgatewayIppoolTimeoutsArgs
    gateway String
    The network gateway IP address for the IP pool. Typically, this is the default network gateway for the subnet.
    ipEndRange String
    The end IP address of the IP pool. Required if network_type is range.
    ipStartRange String
    The start IP address of the IP pool. Required if network_type is range.
    name String
    The name of the IP pool.
    nameserverAddresses List<String>
    The list of nameserver IP addresses for the IP pool.
    nameserverSearchSuffixes List<String>
    The list of nameserver search suffixes for the IP pool. For example, example.org.
    networkType String
    The type of network for the IP pool. Allowed values are: range and subnet.
    prefix Number
    The prefix of the IP pool provided network range or subnet. For example 24 for a /24 subnet or a range that falls inside a 24 subnet.
    privateCloudGatewayId String
    The ID of the Private Cloud Gateway.
    privatecloudgatewayIppoolId String
    The ID of this resource.
    restrictToSingleCluster Boolean
    Restrict the IP pool to a single cluster. If set to true, the IP pool is restricted to a single cluster. We recommend setting this to true for production environments and creating separate IP pools for each cluster.
    subnetCidr String
    The subnet CIDR of the IP pool. Required if network_type is subnet.
    timeouts Property Map

    Supporting Types

    PrivatecloudgatewayIppoolTimeouts, PrivatecloudgatewayIppoolTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    spectrocloud spectrocloud/terraform-provider-spectrocloud
    License
    Notes
    This Pulumi package is based on the spectrocloud Terraform Provider.
    spectrocloud logo
    spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud
    spectrocloud/terraform-provider-spectrocloud