Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. networking
  5. SubnetPool
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.networking.SubnetPool

Explore with Pulumi AI

openstack logo
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

    Manages a V2 Neutron subnetpool resource within OpenStack.

    Example Usage

    Create a Subnet Pool

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

const subnetpool1 = new openstack.networking.SubnetPool("subnetpool_1", {
    name: "subnetpool_1",
    ipVersion: 6,
    prefixes: [
        "fdf7:b13d:dead:beef::/64",
        "fd65:86cc:a334:39b7::/64",
    ],
});

    import pulumi
import pulumi_openstack as openstack

subnetpool1 = openstack.networking.SubnetPool("subnetpool_1",
    name="subnetpool_1",
    ip_version=6,
    prefixes=[
        "fdf7:b13d:dead:beef::/64",
        "fd65:86cc:a334:39b7::/64",
    ])

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewSubnetPool(ctx, "subnetpool_1", &networking.SubnetPoolArgs{
			Name:      pulumi.String("subnetpool_1"),
			IpVersion: pulumi.Int(6),
			Prefixes: pulumi.StringArray{
				pulumi.String("fdf7:b13d:dead:beef::/64"),
				pulumi.String("fd65:86cc:a334:39b7::/64"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var subnetpool1 = new OpenStack.Networking.SubnetPool("subnetpool_1", new()
    {
        Name = "subnetpool_1",
        IpVersion = 6,
        Prefixes = new[]
        {
            "fdf7:b13d:dead:beef::/64",
            "fd65:86cc:a334:39b7::/64",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.SubnetPool;
import com.pulumi.openstack.networking.SubnetPoolArgs;
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) {
        var subnetpool1 = new SubnetPool("subnetpool1", SubnetPoolArgs.builder()
            .name("subnetpool_1")
            .ipVersion(6)
            .prefixes(            
                "fdf7:b13d:dead:beef::/64",
                "fd65:86cc:a334:39b7::/64")
            .build());

    }
}

    resources:
  subnetpool1:
    type: openstack:networking:SubnetPool
    name: subnetpool_1
    properties:
      name: subnetpool_1
      ipVersion: 6
      prefixes:
        - fdf7:b13d:dead:beef::/64
        - fd65:86cc:a334:39b7::/64

    Create a Subnet from a Subnet Pool

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

const network1 = new openstack.networking.Network("network_1", {
    name: "network_1",
    adminStateUp: true,
});
const subnetpool1 = new openstack.networking.SubnetPool("subnetpool_1", {
    name: "subnetpool_1",
    prefixes: ["10.11.12.0/24"],
});
const subnet1 = new openstack.networking.Subnet("subnet_1", {
    name: "subnet_1",
    cidr: "10.11.12.0/25",
    networkId: network1.id,
    subnetpoolId: subnetpool1.id,
});

    import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network_1",
    name="network_1",
    admin_state_up=True)
subnetpool1 = openstack.networking.SubnetPool("subnetpool_1",
    name="subnetpool_1",
    prefixes=["10.11.12.0/24"])
subnet1 = openstack.networking.Subnet("subnet_1",
    name="subnet_1",
    cidr="10.11.12.0/25",
    network_id=network1.id,
    subnetpool_id=subnetpool1.id)

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network1, err := networking.NewNetwork(ctx, "network_1", &networking.NetworkArgs{
			Name:         pulumi.String("network_1"),
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnetpool1, err := networking.NewSubnetPool(ctx, "subnetpool_1", &networking.SubnetPoolArgs{
			Name: pulumi.String("subnetpool_1"),
			Prefixes: pulumi.StringArray{
				pulumi.String("10.11.12.0/24"),
			},
		})
		if err != nil {
			return err
		}
		_, err = networking.NewSubnet(ctx, "subnet_1", &networking.SubnetArgs{
			Name:         pulumi.String("subnet_1"),
			Cidr:         pulumi.String("10.11.12.0/25"),
			NetworkId:    network1.ID(),
			SubnetpoolId: subnetpool1.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var network1 = new OpenStack.Networking.Network("network_1", new()
    {
        Name = "network_1",
        AdminStateUp = true,
    });

    var subnetpool1 = new OpenStack.Networking.SubnetPool("subnetpool_1", new()
    {
        Name = "subnetpool_1",
        Prefixes = new[]
        {
            "10.11.12.0/24",
        },
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet_1", new()
    {
        Name = "subnet_1",
        Cidr = "10.11.12.0/25",
        NetworkId = network1.Id,
        SubnetpoolId = subnetpool1.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.Network;
import com.pulumi.openstack.networking.NetworkArgs;
import com.pulumi.openstack.networking.SubnetPool;
import com.pulumi.openstack.networking.SubnetPoolArgs;
import com.pulumi.openstack.networking.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
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) {
        var network1 = new Network("network1", NetworkArgs.builder()
            .name("network_1")
            .adminStateUp("true")
            .build());

        var subnetpool1 = new SubnetPool("subnetpool1", SubnetPoolArgs.builder()
            .name("subnetpool_1")
            .prefixes("10.11.12.0/24")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()
            .name("subnet_1")
            .cidr("10.11.12.0/25")
            .networkId(network1.id())
            .subnetpoolId(subnetpool1.id())
            .build());

    }
}

    resources:
  network1:
    type: openstack:networking:Network
    name: network_1
    properties:
      name: network_1
      adminStateUp: 'true'
  subnetpool1:
    type: openstack:networking:SubnetPool
    name: subnetpool_1
    properties:
      name: subnetpool_1
      prefixes:
        - 10.11.12.0/24
  subnet1:
    type: openstack:networking:Subnet
    name: subnet_1
    properties:
      name: subnet_1
      cidr: 10.11.12.0/25
      networkId: ${network1.id}
      subnetpoolId: ${subnetpool1.id}

    Create SubnetPool Resource

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

    Constructor syntax

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

@overload
def SubnetPool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               prefixes: Optional[Sequence[str]] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               address_scope_id: Optional[str] = None,
               ip_version: Optional[int] = None,
               is_default: Optional[bool] = None,
               max_prefixlen: Optional[int] = None,
               min_prefixlen: Optional[int] = None,
               default_quota: Optional[int] = None,
               default_prefixlen: Optional[int] = None,
               project_id: Optional[str] = None,
               region: Optional[str] = None,
               shared: Optional[bool] = None,
               tags: Optional[Sequence[str]] = None,
               value_specs: Optional[Mapping[str, str]] = None)
    func NewSubnetPool(ctx *Context, name string, args SubnetPoolArgs, opts ...ResourceOption) (*SubnetPool, error)
    public SubnetPool(string name, SubnetPoolArgs args, CustomResourceOptions? opts = null)
    public SubnetPool(String name, SubnetPoolArgs args)
public SubnetPool(String name, SubnetPoolArgs args, CustomResourceOptions options)

    type: openstack:networking:SubnetPool
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 SubnetPoolArgs
    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 SubnetPoolArgs
    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 SubnetPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubnetPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubnetPoolArgs
    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 subnetPoolResource = new OpenStack.Networking.SubnetPool("subnetPoolResource", new()
{
    Prefixes = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    AddressScopeId = "string",
    IpVersion = 0,
    IsDefault = false,
    MaxPrefixlen = 0,
    MinPrefixlen = 0,
    DefaultQuota = 0,
    DefaultPrefixlen = 0,
    ProjectId = "string",
    Region = "string",
    Shared = false,
    Tags = new[]
    {
        "string",
    },
    ValueSpecs = 
    {
        { "string", "string" },
    },
});

    example, err := networking.NewSubnetPool(ctx, "subnetPoolResource", &networking.SubnetPoolArgs{
	Prefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	AddressScopeId:   pulumi.String("string"),
	IpVersion:        pulumi.Int(0),
	IsDefault:        pulumi.Bool(false),
	MaxPrefixlen:     pulumi.Int(0),
	MinPrefixlen:     pulumi.Int(0),
	DefaultQuota:     pulumi.Int(0),
	DefaultPrefixlen: pulumi.Int(0),
	ProjectId:        pulumi.String("string"),
	Region:           pulumi.String("string"),
	Shared:           pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValueSpecs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var subnetPoolResource = new SubnetPool("subnetPoolResource", SubnetPoolArgs.builder()
    .prefixes("string")
    .description("string")
    .name("string")
    .addressScopeId("string")
    .ipVersion(0)
    .isDefault(false)
    .maxPrefixlen(0)
    .minPrefixlen(0)
    .defaultQuota(0)
    .defaultPrefixlen(0)
    .projectId("string")
    .region("string")
    .shared(false)
    .tags("string")
    .valueSpecs(Map.of("string", "string"))
    .build());

    subnet_pool_resource = openstack.networking.SubnetPool("subnetPoolResource",
    prefixes=["string"],
    description="string",
    name="string",
    address_scope_id="string",
    ip_version=0,
    is_default=False,
    max_prefixlen=0,
    min_prefixlen=0,
    default_quota=0,
    default_prefixlen=0,
    project_id="string",
    region="string",
    shared=False,
    tags=["string"],
    value_specs={
        "string": "string",
    })

    const subnetPoolResource = new openstack.networking.SubnetPool("subnetPoolResource", {
    prefixes: ["string"],
    description: "string",
    name: "string",
    addressScopeId: "string",
    ipVersion: 0,
    isDefault: false,
    maxPrefixlen: 0,
    minPrefixlen: 0,
    defaultQuota: 0,
    defaultPrefixlen: 0,
    projectId: "string",
    region: "string",
    shared: false,
    tags: ["string"],
    valueSpecs: {
        string: "string",
    },
});

    type: openstack:networking:SubnetPool
properties:
    addressScopeId: string
    defaultPrefixlen: 0
    defaultQuota: 0
    description: string
    ipVersion: 0
    isDefault: false
    maxPrefixlen: 0
    minPrefixlen: 0
    name: string
    prefixes:
        - string
    projectId: string
    region: string
    shared: false
    tags:
        - string
    valueSpecs:
        string: string

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

    Prefixes List<string>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    AddressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    DefaultPrefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    DefaultQuota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    Description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    IpVersion int
    The IP protocol version.
    IsDefault bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    MaxPrefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    MinPrefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    Name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    ProjectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    Shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    Tags List<string>
    A set of string tags for the subnetpool.
    ValueSpecs Dictionary<string, string>
    Map of additional options.
    Prefixes []string
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    AddressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    DefaultPrefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    DefaultQuota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    Description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    IpVersion int
    The IP protocol version.
    IsDefault bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    MaxPrefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    MinPrefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    Name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    ProjectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    Shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    Tags []string
    A set of string tags for the subnetpool.
    ValueSpecs map[string]string
    Map of additional options.
    prefixes List<String>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    addressScopeId String
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    defaultPrefixlen Integer
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota Integer
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description String
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion Integer
    The IP protocol version.
    isDefault Boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen Integer
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen Integer
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name String
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    projectId String
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    shared Boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags List<String>
    A set of string tags for the subnetpool.
    valueSpecs Map<String,String>
    Map of additional options.
    prefixes string[]
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    addressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    defaultPrefixlen number
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota number
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion number
    The IP protocol version.
    isDefault boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen number
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen number
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    projectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    shared boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags string[]
    A set of string tags for the subnetpool.
    valueSpecs {[key: string]: string}
    Map of additional options.
    prefixes Sequence[str]
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    address_scope_id str
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    default_prefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    default_quota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description str
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ip_version int
    The IP protocol version.
    is_default bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    max_prefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    min_prefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name str
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    project_id str
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags Sequence[str]
    A set of string tags for the subnetpool.
    value_specs Mapping[str, str]
    Map of additional options.
    prefixes List<String>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    addressScopeId String
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    defaultPrefixlen Number
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota Number
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description String
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion Number
    The IP protocol version.
    isDefault Boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen Number
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen Number
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name String
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    projectId String
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    shared Boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags List<String>
    A set of string tags for the subnetpool.
    valueSpecs Map<String>
    Map of additional options.

    Outputs

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

    AllTags List<string>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    CreatedAt string
    The time at which subnetpool was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RevisionNumber int
    The revision number of the subnetpool.
    UpdatedAt string
    The time at which subnetpool was created.
    AllTags []string
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    CreatedAt string
    The time at which subnetpool was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RevisionNumber int
    The revision number of the subnetpool.
    UpdatedAt string
    The time at which subnetpool was created.
    allTags List<String>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt String
    The time at which subnetpool was created.
    id String
    The provider-assigned unique ID for this managed resource.
    revisionNumber Integer
    The revision number of the subnetpool.
    updatedAt String
    The time at which subnetpool was created.
    allTags string[]
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt string
    The time at which subnetpool was created.
    id string
    The provider-assigned unique ID for this managed resource.
    revisionNumber number
    The revision number of the subnetpool.
    updatedAt string
    The time at which subnetpool was created.
    all_tags Sequence[str]
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    created_at str
    The time at which subnetpool was created.
    id str
    The provider-assigned unique ID for this managed resource.
    revision_number int
    The revision number of the subnetpool.
    updated_at str
    The time at which subnetpool was created.
    allTags List<String>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt String
    The time at which subnetpool was created.
    id String
    The provider-assigned unique ID for this managed resource.
    revisionNumber Number
    The revision number of the subnetpool.
    updatedAt String
    The time at which subnetpool was created.

    Look up Existing SubnetPool Resource

    Get an existing SubnetPool 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?: SubnetPoolState, opts?: CustomResourceOptions): SubnetPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_scope_id: Optional[str] = None,
        all_tags: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        default_prefixlen: Optional[int] = None,
        default_quota: Optional[int] = None,
        description: Optional[str] = None,
        ip_version: Optional[int] = None,
        is_default: Optional[bool] = None,
        max_prefixlen: Optional[int] = None,
        min_prefixlen: Optional[int] = None,
        name: Optional[str] = None,
        prefixes: Optional[Sequence[str]] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        revision_number: Optional[int] = None,
        shared: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        value_specs: Optional[Mapping[str, str]] = None) -> SubnetPool
    func GetSubnetPool(ctx *Context, name string, id IDInput, state *SubnetPoolState, opts ...ResourceOption) (*SubnetPool, error)
    public static SubnetPool Get(string name, Input<string> id, SubnetPoolState? state, CustomResourceOptions? opts = null)
    public static SubnetPool get(String name, Output<String> id, SubnetPoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AddressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    AllTags List<string>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    CreatedAt string
    The time at which subnetpool was created.
    DefaultPrefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    DefaultQuota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    Description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    IpVersion int
    The IP protocol version.
    IsDefault bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    MaxPrefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    MinPrefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    Name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    Prefixes List<string>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    ProjectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    RevisionNumber int
    The revision number of the subnetpool.
    Shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    Tags List<string>
    A set of string tags for the subnetpool.
    UpdatedAt string
    The time at which subnetpool was created.
    ValueSpecs Dictionary<string, string>
    Map of additional options.
    AddressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    AllTags []string
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    CreatedAt string
    The time at which subnetpool was created.
    DefaultPrefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    DefaultQuota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    Description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    IpVersion int
    The IP protocol version.
    IsDefault bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    MaxPrefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    MinPrefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    Name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    Prefixes []string
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    ProjectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    RevisionNumber int
    The revision number of the subnetpool.
    Shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    Tags []string
    A set of string tags for the subnetpool.
    UpdatedAt string
    The time at which subnetpool was created.
    ValueSpecs map[string]string
    Map of additional options.
    addressScopeId String
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    allTags List<String>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt String
    The time at which subnetpool was created.
    defaultPrefixlen Integer
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota Integer
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description String
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion Integer
    The IP protocol version.
    isDefault Boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen Integer
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen Integer
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name String
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    prefixes List<String>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    projectId String
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    revisionNumber Integer
    The revision number of the subnetpool.
    shared Boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags List<String>
    A set of string tags for the subnetpool.
    updatedAt String
    The time at which subnetpool was created.
    valueSpecs Map<String,String>
    Map of additional options.
    addressScopeId string
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    allTags string[]
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt string
    The time at which subnetpool was created.
    defaultPrefixlen number
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota number
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description string
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion number
    The IP protocol version.
    isDefault boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen number
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen number
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name string
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    prefixes string[]
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    projectId string
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    revisionNumber number
    The revision number of the subnetpool.
    shared boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags string[]
    A set of string tags for the subnetpool.
    updatedAt string
    The time at which subnetpool was created.
    valueSpecs {[key: string]: string}
    Map of additional options.
    address_scope_id str
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    all_tags Sequence[str]
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    created_at str
    The time at which subnetpool was created.
    default_prefixlen int
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    default_quota int
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description str
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ip_version int
    The IP protocol version.
    is_default bool
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    max_prefixlen int
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    min_prefixlen int
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name str
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    prefixes Sequence[str]
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    project_id str
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    revision_number int
    The revision number of the subnetpool.
    shared bool
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags Sequence[str]
    A set of string tags for the subnetpool.
    updated_at str
    The time at which subnetpool was created.
    value_specs Mapping[str, str]
    Map of additional options.
    addressScopeId String
    The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
    allTags List<String>
    The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
    createdAt String
    The time at which subnetpool was created.
    defaultPrefixlen Number
    The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.
    defaultQuota Number
    The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.
    description String
    The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
    ipVersion Number
    The IP protocol version.
    isDefault Boolean
    Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
    maxPrefixlen Number
    The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.
    minPrefixlen Number
    The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.
    name String
    The name of the subnetpool. Changing this updates the name of the existing subnetpool.
    prefixes List<String>
    A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.
    projectId String
    The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.
    revisionNumber Number
    The revision number of the subnetpool.
    shared Boolean
    Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
    tags List<String>
    A set of string tags for the subnetpool.
    updatedAt String
    The time at which subnetpool was created.
    valueSpecs Map<String>
    Map of additional options.

    Import

    Subnetpools can be imported using the id, e.g.

    $ pulumi import openstack:networking/subnetPool:SubnetPool subnetpool_1 832cb7f3-59fe-40cf-8f64-8350ffc03272

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-openstack