@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
224 lines (223 loc) • 6.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get a list of Openstack Subnet IDs matching the
* specified criteria.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const subnets = openstack.networking.getSubnetIdsV2({
* nameRegex: "public",
* tags: ["public"],
* });
* ```
*/
export declare function getSubnetIdsV2(args?: GetSubnetIdsV2Args, opts?: pulumi.InvokeOptions): Promise<GetSubnetIdsV2Result>;
/**
* A collection of arguments for invoking getSubnetIdsV2.
*/
export interface GetSubnetIdsV2Args {
/**
* The CIDR of the subnet.
*/
cidr?: string;
/**
* Human-readable description of the subnet.
*/
description?: string;
/**
* If the subnet has DHCP enabled.
*/
dhcpEnabled?: boolean;
/**
* If the subnet publishes DNS records.
*/
dnsPublishFixedIp?: boolean;
/**
* The IP of the subnet's gateway.
*/
gatewayIp?: string;
/**
* The IP version of the subnet (either 4 or 6).
*/
ipVersion?: number;
/**
* The IPv6 address mode. Valid values are
* `dhcpv6-stateful`, `dhcpv6-stateless`, or `slaac`.
*/
ipv6AddressMode?: string;
/**
* The IPv6 Router Advertisement mode. Valid values
* are `dhcpv6-stateful`, `dhcpv6-stateless`, or `slaac`.
*/
ipv6RaMode?: string;
/**
* The name of the subnet.
*/
name?: string;
nameRegex?: string;
/**
* The ID of the network the subnet belongs to.
*/
networkId?: string;
/**
* The region in which to obtain the V2 Neutron client.
* A Neutron client is needed to retrieve subnet ids. If omitted, the
* `region` argument of the provider is used.
*/
region?: string;
/**
* The ID of the segment the subnet belongs to.
* Available when neutron segment extension is enabled.
*/
segmentId?: string;
/**
* Order the results in either `asc` or `desc`.
* Defaults to none.
*/
sortDirection?: string;
/**
* Sort subnets based on a certain key. Defaults to none.
*/
sortKey?: string;
/**
* The ID of the subnetpool associated with the subnet.
*/
subnetpoolId?: string;
/**
* The list of subnet tags to filter.
*/
tags?: string[];
/**
* The owner of the subnet.
*/
tenantId?: string;
}
/**
* A collection of values returned by getSubnetIdsV2.
*/
export interface GetSubnetIdsV2Result {
readonly cidr?: string;
readonly description?: string;
readonly dhcpEnabled?: boolean;
readonly dnsPublishFixedIp?: boolean;
readonly gatewayIp?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ids: string[];
readonly ipVersion?: number;
readonly ipv6AddressMode?: string;
readonly ipv6RaMode: string;
readonly name?: string;
readonly nameRegex?: string;
readonly networkId?: string;
readonly region: string;
readonly segmentId?: string;
readonly sortDirection?: string;
readonly sortKey?: string;
readonly subnetpoolId?: string;
readonly tags?: string[];
readonly tenantId?: string;
}
/**
* Use this data source to get a list of Openstack Subnet IDs matching the
* specified criteria.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const subnets = openstack.networking.getSubnetIdsV2({
* nameRegex: "public",
* tags: ["public"],
* });
* ```
*/
export declare function getSubnetIdsV2Output(args?: GetSubnetIdsV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSubnetIdsV2Result>;
/**
* A collection of arguments for invoking getSubnetIdsV2.
*/
export interface GetSubnetIdsV2OutputArgs {
/**
* The CIDR of the subnet.
*/
cidr?: pulumi.Input<string>;
/**
* Human-readable description of the subnet.
*/
description?: pulumi.Input<string>;
/**
* If the subnet has DHCP enabled.
*/
dhcpEnabled?: pulumi.Input<boolean>;
/**
* If the subnet publishes DNS records.
*/
dnsPublishFixedIp?: pulumi.Input<boolean>;
/**
* The IP of the subnet's gateway.
*/
gatewayIp?: pulumi.Input<string>;
/**
* The IP version of the subnet (either 4 or 6).
*/
ipVersion?: pulumi.Input<number>;
/**
* The IPv6 address mode. Valid values are
* `dhcpv6-stateful`, `dhcpv6-stateless`, or `slaac`.
*/
ipv6AddressMode?: pulumi.Input<string>;
/**
* The IPv6 Router Advertisement mode. Valid values
* are `dhcpv6-stateful`, `dhcpv6-stateless`, or `slaac`.
*/
ipv6RaMode?: pulumi.Input<string>;
/**
* The name of the subnet.
*/
name?: pulumi.Input<string>;
nameRegex?: pulumi.Input<string>;
/**
* The ID of the network the subnet belongs to.
*/
networkId?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Neutron client.
* A Neutron client is needed to retrieve subnet ids. If omitted, the
* `region` argument of the provider is used.
*/
region?: pulumi.Input<string>;
/**
* The ID of the segment the subnet belongs to.
* Available when neutron segment extension is enabled.
*/
segmentId?: pulumi.Input<string>;
/**
* Order the results in either `asc` or `desc`.
* Defaults to none.
*/
sortDirection?: pulumi.Input<string>;
/**
* Sort subnets based on a certain key. Defaults to none.
*/
sortKey?: pulumi.Input<string>;
/**
* The ID of the subnetpool associated with the subnet.
*/
subnetpoolId?: pulumi.Input<string>;
/**
* The list of subnet tags to filter.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The owner of the subnet.
*/
tenantId?: pulumi.Input<string>;
}