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

openstack.sharedfilesystem.ShareNetwork

Explore with Pulumi AI

Use this resource to configure a share network.

A share network stores network information that share servers can use when shares are created.

Example Usage

Basic share network

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

const network1 = new openstack.networking.Network("network_1", {
    name: "network_1",
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet_1", {
    name: "subnet_1",
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const sharenetwork1 = new openstack.sharedfilesystem.ShareNetwork("sharenetwork_1", {
    name: "test_sharenetwork",
    description: "test share network",
    neutronNetId: network1.id,
    neutronSubnetId: subnet1.id,
});
Copy
import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network_1",
    name="network_1",
    admin_state_up=True)
subnet1 = openstack.networking.Subnet("subnet_1",
    name="subnet_1",
    cidr="192.168.199.0/24",
    ip_version=4,
    network_id=network1.id)
sharenetwork1 = openstack.sharedfilesystem.ShareNetwork("sharenetwork_1",
    name="test_sharenetwork",
    description="test share network",
    neutron_net_id=network1.id,
    neutron_subnet_id=subnet1.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/networking"
	"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 {
		network1, err := networking.NewNetwork(ctx, "network_1", &networking.NetworkArgs{
			Name:         pulumi.String("network_1"),
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnet1, err := networking.NewSubnet(ctx, "subnet_1", &networking.SubnetArgs{
			Name:      pulumi.String("subnet_1"),
			Cidr:      pulumi.String("192.168.199.0/24"),
			IpVersion: pulumi.Int(4),
			NetworkId: network1.ID(),
		})
		if err != nil {
			return err
		}
		_, err = sharedfilesystem.NewShareNetwork(ctx, "sharenetwork_1", &sharedfilesystem.ShareNetworkArgs{
			Name:            pulumi.String("test_sharenetwork"),
			Description:     pulumi.String("test share network"),
			NeutronNetId:    network1.ID(),
			NeutronSubnetId: subnet1.ID(),
		})
		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 network1 = new OpenStack.Networking.Network("network_1", new()
    {
        Name = "network_1",
        AdminStateUp = true,
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet_1", new()
    {
        Name = "subnet_1",
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
        NetworkId = network1.Id,
    });

    var sharenetwork1 = new OpenStack.SharedFileSystem.ShareNetwork("sharenetwork_1", new()
    {
        Name = "test_sharenetwork",
        Description = "test share network",
        NeutronNetId = network1.Id,
        NeutronSubnetId = subnet1.Id,
    });

});
Copy
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.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
import com.pulumi.openstack.sharedfilesystem.ShareNetwork;
import com.pulumi.openstack.sharedfilesystem.ShareNetworkArgs;
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()
            .name("network_1")
            .adminStateUp("true")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()
            .name("subnet_1")
            .cidr("192.168.199.0/24")
            .ipVersion(4)
            .networkId(network1.id())
            .build());

        var sharenetwork1 = new ShareNetwork("sharenetwork1", ShareNetworkArgs.builder()
            .name("test_sharenetwork")
            .description("test share network")
            .neutronNetId(network1.id())
            .neutronSubnetId(subnet1.id())
            .build());

    }
}
Copy
resources:
  network1:
    type: openstack:networking:Network
    name: network_1
    properties:
      name: network_1
      adminStateUp: 'true'
  subnet1:
    type: openstack:networking:Subnet
    name: subnet_1
    properties:
      name: subnet_1
      cidr: 192.168.199.0/24
      ipVersion: 4
      networkId: ${network1.id}
  sharenetwork1:
    type: openstack:sharedfilesystem:ShareNetwork
    name: sharenetwork_1
    properties:
      name: test_sharenetwork
      description: test share network
      neutronNetId: ${network1.id}
      neutronSubnetId: ${subnet1.id}
Copy

Share network with associated security services

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

const network1 = new openstack.networking.Network("network_1", {
    name: "network_1",
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet_1", {
    name: "subnet_1",
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const securityservice1 = new openstack.sharedfilesystem.SecurityService("securityservice_1", {
    name: "security",
    description: "created by terraform",
    type: "active_directory",
    server: "192.168.199.10",
    dnsIp: "192.168.199.10",
    domain: "example.com",
    ou: "CN=Computers,DC=example,DC=com",
    user: "joinDomainUser",
    password: "s8cret",
});
const sharenetwork1 = new openstack.sharedfilesystem.ShareNetwork("sharenetwork_1", {
    name: "test_sharenetwork",
    description: "test share network with security services",
    neutronNetId: network1.id,
    neutronSubnetId: subnet1.id,
    securityServiceIds: [securityservice1.id],
});
Copy
import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network_1",
    name="network_1",
    admin_state_up=True)
subnet1 = openstack.networking.Subnet("subnet_1",
    name="subnet_1",
    cidr="192.168.199.0/24",
    ip_version=4,
    network_id=network1.id)
securityservice1 = openstack.sharedfilesystem.SecurityService("securityservice_1",
    name="security",
    description="created by terraform",
    type="active_directory",
    server="192.168.199.10",
    dns_ip="192.168.199.10",
    domain="example.com",
    ou="CN=Computers,DC=example,DC=com",
    user="joinDomainUser",
    password="s8cret")
sharenetwork1 = openstack.sharedfilesystem.ShareNetwork("sharenetwork_1",
    name="test_sharenetwork",
    description="test share network with security services",
    neutron_net_id=network1.id,
    neutron_subnet_id=subnet1.id,
    security_service_ids=[securityservice1.id])
Copy
package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/networking"
	"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 {
		network1, err := networking.NewNetwork(ctx, "network_1", &networking.NetworkArgs{
			Name:         pulumi.String("network_1"),
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnet1, err := networking.NewSubnet(ctx, "subnet_1", &networking.SubnetArgs{
			Name:      pulumi.String("subnet_1"),
			Cidr:      pulumi.String("192.168.199.0/24"),
			IpVersion: pulumi.Int(4),
			NetworkId: network1.ID(),
		})
		if err != nil {
			return err
		}
		securityservice1, err := sharedfilesystem.NewSecurityService(ctx, "securityservice_1", &sharedfilesystem.SecurityServiceArgs{
			Name:        pulumi.String("security"),
			Description: pulumi.String("created by terraform"),
			Type:        pulumi.String("active_directory"),
			Server:      pulumi.String("192.168.199.10"),
			DnsIp:       pulumi.String("192.168.199.10"),
			Domain:      pulumi.String("example.com"),
			Ou:          pulumi.String("CN=Computers,DC=example,DC=com"),
			User:        pulumi.String("joinDomainUser"),
			Password:    pulumi.String("s8cret"),
		})
		if err != nil {
			return err
		}
		_, err = sharedfilesystem.NewShareNetwork(ctx, "sharenetwork_1", &sharedfilesystem.ShareNetworkArgs{
			Name:            pulumi.String("test_sharenetwork"),
			Description:     pulumi.String("test share network with security services"),
			NeutronNetId:    network1.ID(),
			NeutronSubnetId: subnet1.ID(),
			SecurityServiceIds: pulumi.StringArray{
				securityservice1.ID(),
			},
		})
		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 network1 = new OpenStack.Networking.Network("network_1", new()
    {
        Name = "network_1",
        AdminStateUp = true,
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet_1", new()
    {
        Name = "subnet_1",
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
        NetworkId = network1.Id,
    });

    var securityservice1 = new OpenStack.SharedFileSystem.SecurityService("securityservice_1", new()
    {
        Name = "security",
        Description = "created by terraform",
        Type = "active_directory",
        Server = "192.168.199.10",
        DnsIp = "192.168.199.10",
        Domain = "example.com",
        Ou = "CN=Computers,DC=example,DC=com",
        User = "joinDomainUser",
        Password = "s8cret",
    });

    var sharenetwork1 = new OpenStack.SharedFileSystem.ShareNetwork("sharenetwork_1", new()
    {
        Name = "test_sharenetwork",
        Description = "test share network with security services",
        NeutronNetId = network1.Id,
        NeutronSubnetId = subnet1.Id,
        SecurityServiceIds = new[]
        {
            securityservice1.Id,
        },
    });

});
Copy
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.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
import com.pulumi.openstack.sharedfilesystem.SecurityService;
import com.pulumi.openstack.sharedfilesystem.SecurityServiceArgs;
import com.pulumi.openstack.sharedfilesystem.ShareNetwork;
import com.pulumi.openstack.sharedfilesystem.ShareNetworkArgs;
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()
            .name("network_1")
            .adminStateUp("true")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()
            .name("subnet_1")
            .cidr("192.168.199.0/24")
            .ipVersion(4)
            .networkId(network1.id())
            .build());

        var securityservice1 = new SecurityService("securityservice1", SecurityServiceArgs.builder()
            .name("security")
            .description("created by terraform")
            .type("active_directory")
            .server("192.168.199.10")
            .dnsIp("192.168.199.10")
            .domain("example.com")
            .ou("CN=Computers,DC=example,DC=com")
            .user("joinDomainUser")
            .password("s8cret")
            .build());

        var sharenetwork1 = new ShareNetwork("sharenetwork1", ShareNetworkArgs.builder()
            .name("test_sharenetwork")
            .description("test share network with security services")
            .neutronNetId(network1.id())
            .neutronSubnetId(subnet1.id())
            .securityServiceIds(securityservice1.id())
            .build());

    }
}
Copy
resources:
  network1:
    type: openstack:networking:Network
    name: network_1
    properties:
      name: network_1
      adminStateUp: 'true'
  subnet1:
    type: openstack:networking:Subnet
    name: subnet_1
    properties:
      name: subnet_1
      cidr: 192.168.199.0/24
      ipVersion: 4
      networkId: ${network1.id}
  securityservice1:
    type: openstack:sharedfilesystem:SecurityService
    name: securityservice_1
    properties:
      name: security
      description: created by terraform
      type: active_directory
      server: 192.168.199.10
      dnsIp: 192.168.199.10
      domain: example.com
      ou: CN=Computers,DC=example,DC=com
      user: joinDomainUser
      password: s8cret
  sharenetwork1:
    type: openstack:sharedfilesystem:ShareNetwork
    name: sharenetwork_1
    properties:
      name: test_sharenetwork
      description: test share network with security services
      neutronNetId: ${network1.id}
      neutronSubnetId: ${subnet1.id}
      securityServiceIds:
        - ${securityservice1.id}
Copy

Create ShareNetwork Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ShareNetwork(name: string, args: ShareNetworkArgs, opts?: CustomResourceOptions);
@overload
def ShareNetwork(resource_name: str,
                 args: ShareNetworkArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ShareNetwork(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 neutron_net_id: Optional[str] = None,
                 neutron_subnet_id: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 region: Optional[str] = None,
                 security_service_ids: Optional[Sequence[str]] = None)
func NewShareNetwork(ctx *Context, name string, args ShareNetworkArgs, opts ...ResourceOption) (*ShareNetwork, error)
public ShareNetwork(string name, ShareNetworkArgs args, CustomResourceOptions? opts = null)
public ShareNetwork(String name, ShareNetworkArgs args)
public ShareNetwork(String name, ShareNetworkArgs args, CustomResourceOptions options)
type: openstack:sharedfilesystem:ShareNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ShareNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ShareNetworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ShareNetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ShareNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ShareNetworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var shareNetworkResource = new OpenStack.SharedFileSystem.ShareNetwork("shareNetworkResource", new()
{
    NeutronNetId = "string",
    NeutronSubnetId = "string",
    Description = "string",
    Name = "string",
    Region = "string",
    SecurityServiceIds = new[]
    {
        "string",
    },
});
Copy
example, err := sharedfilesystem.NewShareNetwork(ctx, "shareNetworkResource", &sharedfilesystem.ShareNetworkArgs{
	NeutronNetId:    pulumi.String("string"),
	NeutronSubnetId: pulumi.String("string"),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	Region:          pulumi.String("string"),
	SecurityServiceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var shareNetworkResource = new ShareNetwork("shareNetworkResource", ShareNetworkArgs.builder()
    .neutronNetId("string")
    .neutronSubnetId("string")
    .description("string")
    .name("string")
    .region("string")
    .securityServiceIds("string")
    .build());
Copy
share_network_resource = openstack.sharedfilesystem.ShareNetwork("shareNetworkResource",
    neutron_net_id="string",
    neutron_subnet_id="string",
    description="string",
    name="string",
    region="string",
    security_service_ids=["string"])
Copy
const shareNetworkResource = new openstack.sharedfilesystem.ShareNetwork("shareNetworkResource", {
    neutronNetId: "string",
    neutronSubnetId: "string",
    description: "string",
    name: "string",
    region: "string",
    securityServiceIds: ["string"],
});
Copy
type: openstack:sharedfilesystem:ShareNetwork
properties:
    description: string
    name: string
    neutronNetId: string
    neutronSubnetId: string
    region: string
    securityServiceIds:
        - string
Copy

ShareNetwork Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ShareNetwork resource accepts the following input properties:

NeutronNetId This property is required. string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
NeutronSubnetId This property is required. string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
Description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
Name string
The name for the share network. Changing this updates the name of the existing share network.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
SecurityServiceIds List<string>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
NeutronNetId This property is required. string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
NeutronSubnetId This property is required. string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
Description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
Name string
The name for the share network. Changing this updates the name of the existing share network.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
SecurityServiceIds []string
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
neutronNetId This property is required. String
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId This property is required. String
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
description String
The human-readable description for the share network. Changing this updates the description of the existing share network.
name String
The name for the share network. Changing this updates the name of the existing share network.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds List<String>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
neutronNetId This property is required. string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId This property is required. string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
name string
The name for the share network. Changing this updates the name of the existing share network.
region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds string[]
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
neutron_net_id This property is required. str
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutron_subnet_id This property is required. str
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
description str
The human-readable description for the share network. Changing this updates the description of the existing share network.
name str
The name for the share network. Changing this updates the name of the existing share network.
region Changes to this property will trigger replacement. str
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
security_service_ids Sequence[str]
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
neutronNetId This property is required. String
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId This property is required. String
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
description String
The human-readable description for the share network. Changing this updates the description of the existing share network.
name String
The name for the share network. Changing this updates the name of the existing share network.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds List<String>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.

Outputs

All input properties are implicitly available as output properties. Additionally, the ShareNetwork resource produces the following output properties:

Cidr string
The share network CIDR.
Id string
The provider-assigned unique ID for this managed resource.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
ProjectId string
The owner of the Share Network.
SegmentationId int
The share network segmentation ID.
Cidr string
The share network CIDR.
Id string
The provider-assigned unique ID for this managed resource.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
ProjectId string
The owner of the Share Network.
SegmentationId int
The share network segmentation ID.
cidr String
The share network CIDR.
id String
The provider-assigned unique ID for this managed resource.
ipVersion Integer
The IP version of the share network. Can either be 4 or 6.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
projectId String
The owner of the Share Network.
segmentationId Integer
The share network segmentation ID.
cidr string
The share network CIDR.
id string
The provider-assigned unique ID for this managed resource.
ipVersion number
The IP version of the share network. Can either be 4 or 6.
networkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
projectId string
The owner of the Share Network.
segmentationId number
The share network segmentation ID.
cidr str
The share network CIDR.
id str
The provider-assigned unique ID for this managed resource.
ip_version int
The IP version of the share network. Can either be 4 or 6.
network_type str
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
project_id str
The owner of the Share Network.
segmentation_id int
The share network segmentation ID.
cidr String
The share network CIDR.
id String
The provider-assigned unique ID for this managed resource.
ipVersion Number
The IP version of the share network. Can either be 4 or 6.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
projectId String
The owner of the Share Network.
segmentationId Number
The share network segmentation ID.

Look up Existing ShareNetwork Resource

Get an existing ShareNetwork 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?: ShareNetworkState, opts?: CustomResourceOptions): ShareNetwork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr: Optional[str] = None,
        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,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        security_service_ids: Optional[Sequence[str]] = None,
        segmentation_id: Optional[int] = None) -> ShareNetwork
func GetShareNetwork(ctx *Context, name string, id IDInput, state *ShareNetworkState, opts ...ResourceOption) (*ShareNetwork, error)
public static ShareNetwork Get(string name, Input<string> id, ShareNetworkState? state, CustomResourceOptions? opts = null)
public static ShareNetwork get(String name, Output<String> id, ShareNetworkState state, CustomResourceOptions options)
resources:  _:    type: openstack:sharedfilesystem:ShareNetwork    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Cidr string
The share network CIDR.
Description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
Name string
The name for the share network. Changing this updates the name of the existing share network.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
NeutronNetId string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
NeutronSubnetId string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
ProjectId string
The owner of the Share Network.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
SecurityServiceIds List<string>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
SegmentationId int
The share network segmentation ID.
Cidr string
The share network CIDR.
Description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
IpVersion int
The IP version of the share network. Can either be 4 or 6.
Name string
The name for the share network. Changing this updates the name of the existing share network.
NetworkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
NeutronNetId string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
NeutronSubnetId string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
ProjectId string
The owner of the Share Network.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
SecurityServiceIds []string
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
SegmentationId int
The share network segmentation ID.
cidr String
The share network CIDR.
description String
The human-readable description for the share network. Changing this updates the description of the existing share network.
ipVersion Integer
The IP version of the share network. Can either be 4 or 6.
name String
The name for the share network. Changing this updates the name of the existing share network.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId String
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId String
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
projectId String
The owner of the Share Network.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds List<String>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
segmentationId Integer
The share network segmentation ID.
cidr string
The share network CIDR.
description string
The human-readable description for the share network. Changing this updates the description of the existing share network.
ipVersion number
The IP version of the share network. Can either be 4 or 6.
name string
The name for the share network. Changing this updates the name of the existing share network.
networkType string
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId string
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId string
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
projectId string
The owner of the Share Network.
region Changes to this property will trigger replacement. string
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds string[]
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
segmentationId number
The share network segmentation ID.
cidr str
The share network CIDR.
description str
The human-readable description for the share network. Changing this updates the description of the existing share network.
ip_version int
The IP version of the share network. Can either be 4 or 6.
name str
The name for the share network. Changing this updates the name of the existing share network.
network_type str
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutron_net_id str
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutron_subnet_id str
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
project_id str
The owner of the Share Network.
region Changes to this property will trigger replacement. str
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
security_service_ids Sequence[str]
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
segmentation_id int
The share network segmentation ID.
cidr String
The share network CIDR.
description String
The human-readable description for the share network. Changing this updates the description of the existing share network.
ipVersion Number
The IP version of the share network. Can either be 4 or 6.
name String
The name for the share network. Changing this updates the name of the existing share network.
networkType String
The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutronNetId String
The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
neutronSubnetId String
The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it's not used by shares.
projectId String
The owner of the Share Network.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
securityServiceIds List<String>
The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
segmentationId Number
The share network segmentation ID.

Import

This resource can be imported by specifying the ID of the share network:

$ pulumi import openstack:sharedfilesystem/shareNetwork:ShareNetwork sharenetwork_1 id
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
OpenStack pulumi/pulumi-openstack
License
Apache-2.0
Notes
This Pulumi package is based on the openstack Terraform Provider.