1. Packages
  2. Openstack Provider
  3. API Docs
  4. sharedfilesystem
  5. getShareNetwork
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

openstack.sharedfilesystem.getShareNetwork

Explore with Pulumi AI

OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

Use this data source to get the ID of an available Shared File System share network.

Example Usage

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

const sharenetwork1 = openstack.sharedfilesystem.getShareNetwork({
    name: "sharenetwork_1",
});
Copy
import pulumi
import pulumi_openstack as openstack

sharenetwork1 = openstack.sharedfilesystem.get_share_network(name="sharenetwork_1")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sharedfilesystem.LookupShareNetwork(ctx, &sharedfilesystem.LookupShareNetworkArgs{
			Name: pulumi.StringRef("sharenetwork_1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var sharenetwork1 = OpenStack.SharedFileSystem.GetShareNetwork.Invoke(new()
    {
        Name = "sharenetwork_1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.sharedfilesystem.SharedfilesystemFunctions;
import com.pulumi.openstack.sharedfilesystem.inputs.GetShareNetworkArgs;
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) {
        final var sharenetwork1 = SharedfilesystemFunctions.getShareNetwork(GetShareNetworkArgs.builder()
            .name("sharenetwork_1")
            .build());

    }
}
Copy
variables:
  sharenetwork1:
    fn::invoke:
      function: openstack:sharedfilesystem:getShareNetwork
      arguments:
        name: sharenetwork_1
Copy

Using getShareNetwork

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getShareNetwork(args: GetShareNetworkArgs, opts?: InvokeOptions): Promise<GetShareNetworkResult>
function getShareNetworkOutput(args: GetShareNetworkOutputArgs, opts?: InvokeOptions): Output<GetShareNetworkResult>
Copy
def get_share_network(description: Optional[str] = None,
                      ip_version: Optional[int] = None,
                      name: Optional[str] = None,
                      network_type: Optional[str] = None,
                      neutron_net_id: Optional[str] = None,
                      neutron_subnet_id: Optional[str] = None,
                      region: Optional[str] = None,
                      security_service_id: Optional[str] = None,
                      segmentation_id: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetShareNetworkResult
def get_share_network_output(description: Optional[pulumi.Input[str]] = None,
                      ip_version: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      network_type: Optional[pulumi.Input[str]] = None,
                      neutron_net_id: Optional[pulumi.Input[str]] = None,
                      neutron_subnet_id: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      security_service_id: Optional[pulumi.Input[str]] = None,
                      segmentation_id: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetShareNetworkResult]
Copy
func LookupShareNetwork(ctx *Context, args *LookupShareNetworkArgs, opts ...InvokeOption) (*LookupShareNetworkResult, error)
func LookupShareNetworkOutput(ctx *Context, args *LookupShareNetworkOutputArgs, opts ...InvokeOption) LookupShareNetworkResultOutput
Copy

> Note: This function is named LookupShareNetwork in the Go SDK.

public static class GetShareNetwork 
{
    public static Task<GetShareNetworkResult> InvokeAsync(GetShareNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetShareNetworkResult> Invoke(GetShareNetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetShareNetworkResult> getShareNetwork(GetShareNetworkArgs args, InvokeOptions options)
public static Output<GetShareNetworkResult> getShareNetwork(GetShareNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: openstack:sharedfilesystem/getShareNetwork:getShareNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Description string
The human-readable description of the share network.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
Name string
The name of the share network.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
NeutronNetId string
The neutron network UUID of the share network.
NeutronSubnetId string
The neutron subnet UUID of the share network.
Region string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
SecurityServiceId string
The security service IDs associated with the share network.
SegmentationId int
The share network segmentation ID.
Description string
The human-readable description of the share network.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
Name string
The name of the share network.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
NeutronNetId string
The neutron network UUID of the share network.
NeutronSubnetId string
The neutron subnet UUID of the share network.
Region string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
SecurityServiceId string
The security service IDs associated with the share network.
SegmentationId int
The share network segmentation ID.
description String
The human-readable description of the share network.
ipVersion Integer
The IP version of the share network. Can either be 4 or 6.
name String
The name of the share network.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId String
The neutron network UUID of the share network.
neutronSubnetId String
The neutron subnet UUID of the share network.
region String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
securityServiceId String
The security service IDs associated with the share network.
segmentationId Integer
The share network segmentation ID.
description string
The human-readable description of the share network.
ipVersion number
The IP version of the share network. Can either be 4 or 6.
name string
The name of the share network.
networkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId string
The neutron network UUID of the share network.
neutronSubnetId string
The neutron subnet UUID of the share network.
region string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
securityServiceId string
The security service IDs associated with the share network.
segmentationId number
The share network segmentation ID.
description str
The human-readable description of the share network.
ip_version int
The IP version of the share network. Can either be 4 or 6.
name str
The name of the share network.
network_type str
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutron_net_id str
The neutron network UUID of the share network.
neutron_subnet_id str
The neutron subnet UUID of the share network.
region str
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
security_service_id str
The security service IDs associated with the share network.
segmentation_id int
The share network segmentation ID.
description String
The human-readable description of the share network.
ipVersion Number
The IP version of the share network. Can either be 4 or 6.
name String
The name of the share network.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId String
The neutron network UUID of the share network.
neutronSubnetId String
The neutron subnet UUID of the share network.
region String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
securityServiceId String
The security service IDs associated with the share network.
segmentationId Number
The share network segmentation ID.

getShareNetwork Result

The following output properties are available:

Cidr string
See Argument Reference above.
Description string
See Argument Reference above.
Id string
The provider-assigned unique ID for this managed resource.
IpVersion int
See Argument Reference above.
Name string
See Argument Reference above.
NetworkType string
See Argument Reference above.
NeutronNetId string
See Argument Reference above.
NeutronSubnetId string
See Argument Reference above.
ProjectId string
The owner of the Share Network.
Region string
See Argument Reference above.
SecurityServiceIds List<string>
The list of security service IDs associated with the share network.
SegmentationId int
See Argument Reference above.
SecurityServiceId string
See Argument Reference above.
Cidr string
See Argument Reference above.
Description string
See Argument Reference above.
Id string
The provider-assigned unique ID for this managed resource.
IpVersion int
See Argument Reference above.
Name string
See Argument Reference above.
NetworkType string
See Argument Reference above.
NeutronNetId string
See Argument Reference above.
NeutronSubnetId string
See Argument Reference above.
ProjectId string
The owner of the Share Network.
Region string
See Argument Reference above.
SecurityServiceIds []string
The list of security service IDs associated with the share network.
SegmentationId int
See Argument Reference above.
SecurityServiceId string
See Argument Reference above.
cidr String
See Argument Reference above.
description String
See Argument Reference above.
id String
The provider-assigned unique ID for this managed resource.
ipVersion Integer
See Argument Reference above.
name String
See Argument Reference above.
networkType String
See Argument Reference above.
neutronNetId String
See Argument Reference above.
neutronSubnetId String
See Argument Reference above.
projectId String
The owner of the Share Network.
region String
See Argument Reference above.
securityServiceIds List<String>
The list of security service IDs associated with the share network.
segmentationId Integer
See Argument Reference above.
securityServiceId String
See Argument Reference above.
cidr string
See Argument Reference above.
description string
See Argument Reference above.
id string
The provider-assigned unique ID for this managed resource.
ipVersion number
See Argument Reference above.
name string
See Argument Reference above.
networkType string
See Argument Reference above.
neutronNetId string
See Argument Reference above.
neutronSubnetId string
See Argument Reference above.
projectId string
The owner of the Share Network.
region string
See Argument Reference above.
securityServiceIds string[]
The list of security service IDs associated with the share network.
segmentationId number
See Argument Reference above.
securityServiceId string
See Argument Reference above.
cidr str
See Argument Reference above.
description str
See Argument Reference above.
id str
The provider-assigned unique ID for this managed resource.
ip_version int
See Argument Reference above.
name str
See Argument Reference above.
network_type str
See Argument Reference above.
neutron_net_id str
See Argument Reference above.
neutron_subnet_id str
See Argument Reference above.
project_id str
The owner of the Share Network.
region str
See Argument Reference above.
security_service_ids Sequence[str]
The list of security service IDs associated with the share network.
segmentation_id int
See Argument Reference above.
security_service_id str
See Argument Reference above.
cidr String
See Argument Reference above.
description String
See Argument Reference above.
id String
The provider-assigned unique ID for this managed resource.
ipVersion Number
See Argument Reference above.
name String
See Argument Reference above.
networkType String
See Argument Reference above.
neutronNetId String
See Argument Reference above.
neutronSubnetId String
See Argument Reference above.
projectId String
The owner of the Share Network.
region String
See Argument Reference above.
securityServiceIds List<String>
The list of security service IDs associated with the share network.
segmentationId Number
See Argument Reference above.
securityServiceId String
See Argument Reference above.

Package Details

Repository
OpenStack pulumi/pulumi-openstack
License
Apache-2.0
Notes
This Pulumi package is based on the openstack Terraform Provider.
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi