OpenStack

Pulumi Official
Package maintained by Pulumi
v3.9.0 published on Thursday, Aug 4, 2022 by Pulumi

SubnetPool

Manages a V2 Neutron subnetpool resource within OpenStack.

Example Usage

Create a Subnet Pool

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var subnetpool1 = new OpenStack.Networking.SubnetPool("subnetpool1", new OpenStack.Networking.SubnetPoolArgs
        {
            IpVersion = 6,
            Prefixes = 
            {
                "fdf7:b13d:dead:beef::/64",
                "fd65:86cc:a334:39b7::/64",
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewSubnetPool(ctx, "subnetpool1", &networking.SubnetPoolArgs{
			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
	})
}
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()        
            .ipVersion(6)
            .prefixes(            
                "fdf7:b13d:dead:beef::/64",
                "fd65:86cc:a334:39b7::/64")
            .build());

    }
}
import pulumi
import pulumi_openstack as openstack

subnetpool1 = openstack.networking.SubnetPool("subnetpool1",
    ip_version=6,
    prefixes=[
        "fdf7:b13d:dead:beef::/64",
        "fd65:86cc:a334:39b7::/64",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

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

Create a Subnet from a Subnet Pool

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var network1 = new OpenStack.Networking.Network("network1", new OpenStack.Networking.NetworkArgs
        {
            AdminStateUp = true,
        });
        var subnetpool1 = new OpenStack.Networking.SubnetPool("subnetpool1", new OpenStack.Networking.SubnetPoolArgs
        {
            Prefixes = 
            {
                "10.11.12.0/24",
            },
        });
        var subnet1 = new OpenStack.Networking.Subnet("subnet1", new OpenStack.Networking.SubnetArgs
        {
            Cidr = "10.11.12.0/25",
            NetworkId = network1.Id,
            SubnetpoolId = subnetpool1.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/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, "network1", &networking.NetworkArgs{
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnetpool1, err := networking.NewSubnetPool(ctx, "subnetpool1", &networking.SubnetPoolArgs{
			Prefixes: pulumi.StringArray{
				pulumi.String("10.11.12.0/24"),
			},
		})
		if err != nil {
			return err
		}
		_, err = networking.NewSubnet(ctx, "subnet1", &networking.SubnetArgs{
			Cidr:         pulumi.String("10.11.12.0/25"),
			NetworkId:    network1.ID(),
			SubnetpoolId: subnetpool1.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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()        
            .adminStateUp("true")
            .build());

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

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

    }
}
import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network1", admin_state_up=True)
subnetpool1 = openstack.networking.SubnetPool("subnetpool1", prefixes=["10.11.12.0/24"])
subnet1 = openstack.networking.Subnet("subnet1",
    cidr="10.11.12.0/25",
    network_id=network1.id,
    subnetpool_id=subnetpool1.id)
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

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

Create a SubnetPool Resource

new SubnetPool(name: string, args: SubnetPoolArgs, opts?: CustomResourceOptions);
@overload
def SubnetPool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               address_scope_id: 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,
               shared: Optional[bool] = None,
               tags: Optional[Sequence[str]] = None,
               value_specs: Optional[Mapping[str, Any]] = None)
@overload
def SubnetPool(resource_name: str,
               args: SubnetPoolArgs,
               opts: Optional[ResourceOptions] = 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.

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.

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

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, object>

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]interface{}

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,Object>

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]: any}

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, Any]

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<Any>

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 an 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, Any]] = 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, object>

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]interface{}

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,Object>

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]: any}

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, Any]

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<Any>

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

Package Details

Repository
https://github.com/pulumi/pulumi-openstack
License
Apache-2.0
Notes

This Pulumi package is based on the openstack Terraform Provider.