vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vcd.getIpSpace
Explore with Pulumi AI
Provides a data source to read IP Spaces. IP Spaces provide structured approach to allocating public and private IP addresses by preventing the use of overlapping IP addresses across organizations and organization VDCs.
IP Spaces require VCD 10.4.1+ with NSX-T.
Example Usage
Private IP Space Within An Org)
import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";
const space1 = vcd.getIpSpace({
orgId: data.vcd_org.org1.id,
name: "private-ip-space",
});
import pulumi
import pulumi_vcd as vcd
space1 = vcd.get_ip_space(org_id=data["vcd_org"]["org1"]["id"],
name="private-ip-space")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vcd.LookupIpSpace(ctx, &vcd.LookupIpSpaceArgs{
OrgId: pulumi.StringRef(data.Vcd_org.Org1.Id),
Name: "private-ip-space",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;
return await Deployment.RunAsync(() =>
{
var space1 = Vcd.GetIpSpace.Invoke(new()
{
OrgId = data.Vcd_org.Org1.Id,
Name = "private-ip-space",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetIpSpaceArgs;
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 space1 = VcdFunctions.getIpSpace(GetIpSpaceArgs.builder()
.orgId(data.vcd_org().org1().id())
.name("private-ip-space")
.build());
}
}
variables:
space1:
fn::invoke:
function: vcd:getIpSpace
arguments:
orgId: ${data.vcd_org.org1.id}
name: private-ip-space
Public Or Shared IP Space)
import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";
const space1 = vcd.getIpSpace({
name: "public-or-shared-ip-space",
});
import pulumi
import pulumi_vcd as vcd
space1 = vcd.get_ip_space(name="public-or-shared-ip-space")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vcd.LookupIpSpace(ctx, &vcd.LookupIpSpaceArgs{
Name: "public-or-shared-ip-space",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;
return await Deployment.RunAsync(() =>
{
var space1 = Vcd.GetIpSpace.Invoke(new()
{
Name = "public-or-shared-ip-space",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetIpSpaceArgs;
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 space1 = VcdFunctions.getIpSpace(GetIpSpaceArgs.builder()
.name("public-or-shared-ip-space")
.build());
}
}
variables:
space1:
fn::invoke:
function: vcd:getIpSpace
arguments:
name: public-or-shared-ip-space
Using getIpSpace
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 getIpSpace(args: GetIpSpaceArgs, opts?: InvokeOptions): Promise<GetIpSpaceResult>
function getIpSpaceOutput(args: GetIpSpaceOutputArgs, opts?: InvokeOptions): Output<GetIpSpaceResult>
def get_ip_space(id: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIpSpaceResult
def get_ip_space_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
org_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIpSpaceResult]
func LookupIpSpace(ctx *Context, args *LookupIpSpaceArgs, opts ...InvokeOption) (*LookupIpSpaceResult, error)
func LookupIpSpaceOutput(ctx *Context, args *LookupIpSpaceOutputArgs, opts ...InvokeOption) LookupIpSpaceResultOutput
> Note: This function is named LookupIpSpace
in the Go SDK.
public static class GetIpSpace
{
public static Task<GetIpSpaceResult> InvokeAsync(GetIpSpaceArgs args, InvokeOptions? opts = null)
public static Output<GetIpSpaceResult> Invoke(GetIpSpaceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIpSpaceResult> getIpSpace(GetIpSpaceArgs args, InvokeOptions options)
public static Output<GetIpSpaceResult> getIpSpace(GetIpSpaceArgs args, InvokeOptions options)
fn::invoke:
function: vcd:index/getIpSpace:getIpSpace
arguments:
# arguments dictionary
The following arguments are supported:
getIpSpace Result
The following output properties are available:
- Default
Firewall boolRule Creation Enabled - Default
No boolSnat Rule Creation Enabled - Default
Snat boolRule Creation Enabled - Description string
- External
Scope string - Id string
- Internal
Scopes List<string> - Ip
Prefixes List<GetIp Space Ip Prefix> - Ip
Range stringQuota - Ip
Ranges List<GetIp Space Ip Range> - Name string
- Route
Advertisement boolEnabled - Type string
- Org
Id string
- Default
Firewall boolRule Creation Enabled - Default
No boolSnat Rule Creation Enabled - Default
Snat boolRule Creation Enabled - Description string
- External
Scope string - Id string
- Internal
Scopes []string - Ip
Prefixes []GetIp Space Ip Prefix - Ip
Range stringQuota - Ip
Ranges []GetIp Space Ip Range - Name string
- Route
Advertisement boolEnabled - Type string
- Org
Id string
- default
Firewall BooleanRule Creation Enabled - default
No BooleanSnat Rule Creation Enabled - default
Snat BooleanRule Creation Enabled - description String
- external
Scope String - id String
- internal
Scopes List<String> - ip
Prefixes List<GetIp Space Ip Prefix> - ip
Range StringQuota - ip
Ranges List<GetIp Space Ip Range> - name String
- route
Advertisement BooleanEnabled - type String
- org
Id String
- default
Firewall booleanRule Creation Enabled - default
No booleanSnat Rule Creation Enabled - default
Snat booleanRule Creation Enabled - description string
- external
Scope string - id string
- internal
Scopes string[] - ip
Prefixes GetIp Space Ip Prefix[] - ip
Range stringQuota - ip
Ranges GetIp Space Ip Range[] - name string
- route
Advertisement booleanEnabled - type string
- org
Id string
- default_
firewall_ boolrule_ creation_ enabled - default_
no_ boolsnat_ rule_ creation_ enabled - default_
snat_ boolrule_ creation_ enabled - description str
- external_
scope str - id str
- internal_
scopes Sequence[str] - ip_
prefixes Sequence[GetIp Space Ip Prefix] - ip_
range_ strquota - ip_
ranges Sequence[GetIp Space Ip Range] - name str
- route_
advertisement_ boolenabled - type str
- org_
id str
- default
Firewall BooleanRule Creation Enabled - default
No BooleanSnat Rule Creation Enabled - default
Snat BooleanRule Creation Enabled - description String
- external
Scope String - id String
- internal
Scopes List<String> - ip
Prefixes List<Property Map> - ip
Range StringQuota - ip
Ranges List<Property Map> - name String
- route
Advertisement BooleanEnabled - type String
- org
Id String
Supporting Types
GetIpSpaceIpPrefix
GetIpSpaceIpPrefixPrefix
- First
Ip string - Id string
- Prefix
Count string - Prefix
Length string
- First
Ip string - Id string
- Prefix
Count string - Prefix
Length string
- first
Ip String - id String
- prefix
Count String - prefix
Length String
- first
Ip string - id string
- prefix
Count string - prefix
Length string
- first_
ip str - id str
- prefix_
count str - prefix_
length str
- first
Ip String - id String
- prefix
Count String - prefix
Length String
GetIpSpaceIpRange
- End
Address string - Id string
- Start
Address string
- End
Address string - Id string
- Start
Address string
- end
Address String - id String
- start
Address String
- end
Address string - id string
- start
Address string
- end_
address str - id str
- start_
address str
- end
Address String - id String
- start
Address String
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.