1. Packages
  2. Packages
  3. Spectrocloud Provider
  4. API Docs
  5. getIppool
Viewing docs for spectrocloud 0.29.1
published on Friday, May 8, 2026 by spectrocloud
Viewing docs for spectrocloud 0.29.1
published on Friday, May 8, 2026 by spectrocloud

    Data source for looking up a private cloud gateway IP pool by name.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as spectrocloud from "@pulumi/spectrocloud";
    
    const example = spectrocloud.getIppool({
        name: "ippool-1",
        privateCloudGatewayId: "pcg-uid",
    });
    
    import pulumi
    import pulumi_spectrocloud as spectrocloud
    
    example = spectrocloud.get_ippool(name="ippool-1",
        private_cloud_gateway_id="pcg-uid")
    
    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 {
    		_, err := spectrocloud.GetIppool(ctx, &spectrocloud.GetIppoolArgs{
    			Name:                  "ippool-1",
    			PrivateCloudGatewayId: "pcg-uid",
    		}, nil)
    		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 example = Spectrocloud.GetIppool.Invoke(new()
        {
            Name = "ippool-1",
            PrivateCloudGatewayId = "pcg-uid",
        });
    
    });
    
    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.GetIppoolArgs;
    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 example = SpectrocloudFunctions.getIppool(GetIppoolArgs.builder()
                .name("ippool-1")
                .privateCloudGatewayId("pcg-uid")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: spectrocloud:getIppool
          arguments:
            name: ippool-1
            privateCloudGatewayId: pcg-uid
    
    Example coming soon!
    

    Using getIppool

    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 getIppool(args: GetIppoolArgs, opts?: InvokeOptions): Promise<GetIppoolResult>
    function getIppoolOutput(args: GetIppoolOutputArgs, opts?: InvokeOptions): Output<GetIppoolResult>
    def get_ippool(id: Optional[str] = None,
                   name: Optional[str] = None,
                   private_cloud_gateway_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIppoolResult
    def get_ippool_output(id: pulumi.Input[Optional[str]] = None,
                   name: pulumi.Input[Optional[str]] = None,
                   private_cloud_gateway_id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetIppoolResult]
    func GetIppool(ctx *Context, args *GetIppoolArgs, opts ...InvokeOption) (*GetIppoolResult, error)
    func GetIppoolOutput(ctx *Context, args *GetIppoolOutputArgs, opts ...InvokeOption) GetIppoolResultOutput

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

    public static class GetIppool 
    {
        public static Task<GetIppoolResult> InvokeAsync(GetIppoolArgs args, InvokeOptions? opts = null)
        public static Output<GetIppoolResult> Invoke(GetIppoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIppoolResult> getIppool(GetIppoolArgs args, InvokeOptions options)
    public static Output<GetIppoolResult> getIppool(GetIppoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: spectrocloud:index/getIppool:getIppool
      arguments:
        # arguments dictionary
    data "spectrocloud_getippool" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    The name of the IP pool.
    PrivateCloudGatewayId string
    The ID of the private cloud gateway.
    Id string
    The ID of this resource.
    Name string
    The name of the IP pool.
    PrivateCloudGatewayId string
    The ID of the private cloud gateway.
    Id string
    The ID of this resource.
    name string
    The name of the IP pool.
    private_cloud_gateway_id string
    The ID of the private cloud gateway.
    id string
    The ID of this resource.
    name String
    The name of the IP pool.
    privateCloudGatewayId String
    The ID of the private cloud gateway.
    id String
    The ID of this resource.
    name string
    The name of the IP pool.
    privateCloudGatewayId string
    The ID of the private cloud gateway.
    id string
    The ID of this resource.
    name str
    The name of the IP pool.
    private_cloud_gateway_id str
    The ID of the private cloud gateway.
    id str
    The ID of this resource.
    name String
    The name of the IP pool.
    privateCloudGatewayId String
    The ID of the private cloud gateway.
    id String
    The ID of this resource.

    getIppool Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Name string
    The name of the IP pool.
    PrivateCloudGatewayId string
    The ID of the private cloud gateway.
    Id string
    The ID of this resource.
    Name string
    The name of the IP pool.
    PrivateCloudGatewayId string
    The ID of the private cloud gateway.
    id string
    The ID of this resource.
    name string
    The name of the IP pool.
    private_cloud_gateway_id string
    The ID of the private cloud gateway.
    id String
    The ID of this resource.
    name String
    The name of the IP pool.
    privateCloudGatewayId String
    The ID of the private cloud gateway.
    id string
    The ID of this resource.
    name string
    The name of the IP pool.
    privateCloudGatewayId string
    The ID of the private cloud gateway.
    id str
    The ID of this resource.
    name str
    The name of the IP pool.
    private_cloud_gateway_id str
    The ID of the private cloud gateway.
    id String
    The ID of this resource.
    name String
    The name of the IP pool.
    privateCloudGatewayId String
    The ID of the private cloud gateway.

    Package Details

    Repository
    spectrocloud spectrocloud/terraform-provider-spectrocloud
    License
    Notes
    This Pulumi package is based on the spectrocloud Terraform Provider.
    Viewing docs for spectrocloud 0.29.1
    published on Friday, May 8, 2026 by spectrocloud
      Try Pulumi Cloud free. Your team will thank you.