GetSubnetPool

Use this data source to get the ID of an available OpenStack subnetpool.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var subnetpool1 = Output.Create(OpenStack.Networking.GetSubnetPool.InvokeAsync(new OpenStack.Networking.GetSubnetPoolArgs
        {
            Name = "subnetpool_1",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

subnetpool1 = openstack.networking.get_subnet_pool(name="subnetpool_1")

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

const subnetpool1 = pulumi.output(openstack.networking.getSubnetPool({
    name: "subnetpool_1",
}, { async: true }));

Using GetSubnetPool

function getSubnetPool(args: GetSubnetPoolArgs, opts?: InvokeOptions): Promise<GetSubnetPoolResult>

function  get_subnet_pool(address_scope_id=None, default_prefixlen=None, default_quota=None, description=None, ip_version=None, is_default=None, max_prefixlen=None, min_prefixlen=None, name=None, project_id=None, region=None, shared=None, tags=None, opts=None)

func LookupSubnetPool(ctx *Context, args *LookupSubnetPoolArgs, opts ...InvokeOption) (*LookupSubnetPoolResult, error)

Note: This function is named LookupSubnetPool in the Go SDK.

public static class GetSubnetPool {
    public static Task<GetSubnetPoolResult> InvokeAsync(GetSubnetPoolArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AddressScopeId string: The Neutron address scope that subnetpools is assigned to.
DefaultPrefixlen int: The size of the subnetpool default prefix length.
DefaultQuota int: The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.
Description string: The human-readable description for the subnetpool.
IpVersion int: The IP protocol version.
IsDefault bool: Whether the subnetpool is default subnetpool or not.
MaxPrefixlen int: The size of the subnetpool max prefix length.
MinPrefixlen int: The size of the subnetpool min prefix length.
Name string: The name of the subnetpool.
ProjectId string: The owner of the subnetpool.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the region argument of the provider is used.
Shared bool: Whether this subnetpool is shared across all projects.
Tags List<string>: The list of subnetpool tags to filter.

AddressScopeId string: The Neutron address scope that subnetpools is assigned to.
DefaultPrefixlen int: The size of the subnetpool default prefix length.
DefaultQuota int: The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.
Description string: The human-readable description for the subnetpool.
IpVersion int: The IP protocol version.
IsDefault bool: Whether the subnetpool is default subnetpool or not.
MaxPrefixlen int: The size of the subnetpool max prefix length.
MinPrefixlen int: The size of the subnetpool min prefix length.
Name string: The name of the subnetpool.
ProjectId string: The owner of the subnetpool.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the region argument of the provider is used.
Shared bool: Whether this subnetpool is shared across all projects.
Tags []string: The list of subnetpool tags to filter.

addressScopeId string: The Neutron address scope that subnetpools is assigned to.
defaultPrefixlen number: The size of the subnetpool default prefix length.
defaultQuota number: The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.
description string: The human-readable description for the subnetpool.
ipVersion number: The IP protocol version.
isDefault boolean: Whether the subnetpool is default subnetpool or not.
maxPrefixlen number: The size of the subnetpool max prefix length.
minPrefixlen number: The size of the subnetpool min prefix length.
name string: The name of the subnetpool.
projectId string: The owner of the subnetpool.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the region argument of the provider is used.
shared boolean: Whether this subnetpool is shared across all projects.
tags string[]: The list of subnetpool tags to filter.

address_scope_id str: The Neutron address scope that subnetpools is assigned to.
default_prefixlen float: The size of the subnetpool default prefix length.
default_quota float: The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.
description str: The human-readable description for the subnetpool.
ip_version float: The IP protocol version.
is_default bool: Whether the subnetpool is default subnetpool or not.
max_prefixlen float: The size of the subnetpool max prefix length.
min_prefixlen float: The size of the subnetpool min prefix length.
name str: The name of the subnetpool.
project_id str: The owner of the subnetpool.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the region argument of the provider is used.
shared bool: Whether this subnetpool is shared across all projects.
tags List[str]: The list of subnetpool tags to filter.

GetSubnetPool Result

The following output properties are available:

AddressScopeId string: See Argument Reference above. * ip_version -The IP protocol version.
AllTags List<string>: The set of string tags applied on the subnetpool.
CreatedAt string: The time at which subnetpool was created.
DefaultPrefixlen int: See Argument Reference above.
DefaultQuota int: See Argument Reference above.
Description string: See Argument Reference above.
Id string: The provider-assigned unique ID for this managed resource.
IpVersion int
IsDefault bool: See Argument Reference above.
MaxPrefixlen int: See Argument Reference above.
MinPrefixlen int: See Argument Reference above.
Name string: See Argument Reference above.
Prefixes List<string>: See Argument Reference above.
ProjectId string: See Argument Reference above.
Region string: See Argument Reference above.
RevisionNumber int: The revision number of the subnetpool.
Shared bool: See Argument Reference above.
UpdatedAt string: The time at which subnetpool was created.
Tags List<string>

AddressScopeId string: See Argument Reference above. * ip_version -The IP protocol version.
AllTags []string: The set of string tags applied on the subnetpool.
CreatedAt string: The time at which subnetpool was created.
DefaultPrefixlen int: See Argument Reference above.
DefaultQuota int: See Argument Reference above.
Description string: See Argument Reference above.
Id string: The provider-assigned unique ID for this managed resource.
IpVersion int
IsDefault bool: See Argument Reference above.
MaxPrefixlen int: See Argument Reference above.
MinPrefixlen int: See Argument Reference above.
Name string: See Argument Reference above.
Prefixes []string: See Argument Reference above.
ProjectId string: See Argument Reference above.
Region string: See Argument Reference above.
RevisionNumber int: The revision number of the subnetpool.
Shared bool: See Argument Reference above.
UpdatedAt string: The time at which subnetpool was created.
Tags []string

addressScopeId string: See Argument Reference above. * ip_version -The IP protocol version.
allTags string[]: The set of string tags applied on the subnetpool.
createdAt string: The time at which subnetpool was created.
defaultPrefixlen number: See Argument Reference above.
defaultQuota number: See Argument Reference above.
description string: See Argument Reference above.
id string: The provider-assigned unique ID for this managed resource.
ipVersion number
isDefault boolean: See Argument Reference above.
maxPrefixlen number: See Argument Reference above.
minPrefixlen number: See Argument Reference above.
name string: See Argument Reference above.
prefixes string[]: See Argument Reference above.
projectId string: See Argument Reference above.
region string: See Argument Reference above.
revisionNumber number: The revision number of the subnetpool.
shared boolean: See Argument Reference above.
updatedAt string: The time at which subnetpool was created.
tags string[]

address_scope_id str: See Argument Reference above. * ip_version -The IP protocol version.
all_tags List[str]: The set of string tags applied on the subnetpool.
created_at str: The time at which subnetpool was created.
default_prefixlen float: See Argument Reference above.
default_quota float: See Argument Reference above.
description str: See Argument Reference above.
id str: The provider-assigned unique ID for this managed resource.
ip_version float
is_default bool: See Argument Reference above.
max_prefixlen float: See Argument Reference above.
min_prefixlen float: See Argument Reference above.
name str: See Argument Reference above.
prefixes List[str]: See Argument Reference above.
project_id str: See Argument Reference above.
region str: See Argument Reference above.
revision_number float: The revision number of the subnetpool.
shared bool: See Argument Reference above.
updated_at str: The time at which subnetpool was created.
tags List[str]

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetSubnetPool

Example Usage

Using GetSubnetPool

GetSubnetPool Result

Package Details

On This Page