@pulumi/openstack/networking/getNetwork.d.ts

A Pulumi package for creating and managing OpenStack cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get the ID of an available OpenStack network.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as openstack from "@pulumi/openstack";
 *
 * const network = openstack.networking.getNetwork({
 *     name: "tf_test_network",
 * });
 * ```
 */
export declare function getNetwork(args?: GetNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkResult>;
/**
 * A collection of arguments for invoking getNetwork.
 */
export interface GetNetworkArgs {
    /**
     * Human-readable description of the network.
     */
    description?: string;
    /**
     * The external routing facility of the network.
     */
    external?: boolean;
    /**
     * The CIDR of a subnet within the network.
     */
    matchingSubnetCidr?: string;
    /**
     * The network MTU to filter. Available, when Neutron `net-mtu`
     * extension is enabled.
     */
    mtu?: number;
    /**
     * The name of the network.
     */
    name?: string;
    /**
     * The ID of the network.
     */
    networkId?: string;
    /**
     * The region in which to obtain the V2 Neutron client.
     * A Neutron client is needed to retrieve networks ids. If omitted, the
     * `region` argument of the provider is used.
     */
    region?: string;
    /**
     * The status of the network.
     */
    status?: string;
    /**
     * The list of network tags to filter.
     */
    tags?: string[];
    /**
     * The owner of the network.
     */
    tenantId?: string;
    /**
     * The VLAN transparent attribute for the
     * network.
     */
    transparentVlan?: boolean;
}
/**
 * A collection of values returned by getNetwork.
 */
export interface GetNetworkResult {
    /**
     * The administrative state of the network.
     */
    readonly adminStateUp: string;
    /**
     * The set of string tags applied on the network.
     */
    readonly allTags: string[];
    /**
     * The availability zone candidates for the network.
     */
    readonly availabilityZoneHints: string[];
    /**
     * See Argument Reference above.
     */
    readonly description?: string;
    /**
     * The network DNS domain. Available, when Neutron DNS extension
     * is enabled
     */
    readonly dnsDomain: string;
    /**
     * See Argument Reference above.
     */
    readonly external?: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly matchingSubnetCidr?: string;
    /**
     * See Argument Reference above.
     */
    readonly mtu?: number;
    /**
     * See Argument Reference above.
     */
    readonly name?: string;
    readonly networkId?: string;
    /**
     * See Argument Reference above.
     */
    readonly region: string;
    /**
     * An array of one or more provider segment objects.
     */
    readonly segments: outputs.networking.GetNetworkSegment[];
    /**
     * Specifies whether the network resource can be accessed by any
     * tenant or not.
     */
    readonly shared: string;
    readonly status?: string;
    /**
     * A list of subnet IDs belonging to the network.
     */
    readonly subnets: string[];
    readonly tags?: string[];
    readonly tenantId?: string;
    /**
     * See Argument Reference above.
     */
    readonly transparentVlan?: boolean;
}
/**
 * Use this data source to get the ID of an available OpenStack network.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as openstack from "@pulumi/openstack";
 *
 * const network = openstack.networking.getNetwork({
 *     name: "tf_test_network",
 * });
 * ```
 */
export declare function getNetworkOutput(args?: GetNetworkOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkResult>;
/**
 * A collection of arguments for invoking getNetwork.
 */
export interface GetNetworkOutputArgs {
    /**
     * Human-readable description of the network.
     */
    description?: pulumi.Input<string>;
    /**
     * The external routing facility of the network.
     */
    external?: pulumi.Input<boolean>;
    /**
     * The CIDR of a subnet within the network.
     */
    matchingSubnetCidr?: pulumi.Input<string>;
    /**
     * The network MTU to filter. Available, when Neutron `net-mtu`
     * extension is enabled.
     */
    mtu?: pulumi.Input<number>;
    /**
     * The name of the network.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the network.
     */
    networkId?: pulumi.Input<string>;
    /**
     * The region in which to obtain the V2 Neutron client.
     * A Neutron client is needed to retrieve networks ids. If omitted, the
     * `region` argument of the provider is used.
     */
    region?: pulumi.Input<string>;
    /**
     * The status of the network.
     */
    status?: pulumi.Input<string>;
    /**
     * The list of network tags to filter.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The owner of the network.
     */
    tenantId?: pulumi.Input<string>;
    /**
     * The VLAN transparent attribute for the
     * network.
     */
    transparentVlan?: pulumi.Input<boolean>;
}