Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Lxd Provider
  3. API Docs
  4. getNetwork
lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
terraform-lxd/terraform-provider-lxd

lxd.getNetwork

Explore with Pulumi AI

lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
terraform-lxd/terraform-provider-lxd

# lxd.Network

Provides information about an existing LXD network.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  inst:
    type: lxd:Instance
    properties:
      network: ${net.name}
variables:
  net:
    fn::invoke:
      function: lxd:getNetwork
      arguments:
        name: lxdbr0
Copy

Using getNetwork

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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
Copy
def get_network(name: Optional[str] = None,
                project: Optional[str] = None,
                remote: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(name: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                remote: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
Copy
func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput
Copy

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

public static class GetNetwork 
{
    public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: lxd:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Required - Name of the network.
Project string
Optional - Name of the project where network is located.
Remote string
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.
Name This property is required. string
Required - Name of the network.
Project string
Optional - Name of the project where network is located.
Remote string
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.
name This property is required. String
Required - Name of the network.
project String
Optional - Name of the project where network is located.
remote String
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.
name This property is required. string
Required - Name of the network.
project string
Optional - Name of the project where network is located.
remote string
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.
name This property is required. str
Required - Name of the network.
project str
Optional - Name of the project where network is located.
remote str
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.
name This property is required. String
Required - Name of the network.
project String
Optional - Name of the project where network is located.
remote String
Optional - The remote in which the resource was created. If not provided, the provider's default remote is used.

getNetwork Result

The following output properties are available:

Config Dictionary<string, string>
Map of key/value pairs of network config settings.
Description string
Network description.
Id string
The provider-assigned unique ID for this managed resource.
Managed bool
Whether or not the network is managed.
Name string
Type string
Network type.
Project string
Remote string
Config map[string]string
Map of key/value pairs of network config settings.
Description string
Network description.
Id string
The provider-assigned unique ID for this managed resource.
Managed bool
Whether or not the network is managed.
Name string
Type string
Network type.
Project string
Remote string
config Map<String,String>
Map of key/value pairs of network config settings.
description String
Network description.
id String
The provider-assigned unique ID for this managed resource.
managed Boolean
Whether or not the network is managed.
name String
type String
Network type.
project String
remote String
config {[key: string]: string}
Map of key/value pairs of network config settings.
description string
Network description.
id string
The provider-assigned unique ID for this managed resource.
managed boolean
Whether or not the network is managed.
name string
type string
Network type.
project string
remote string
config Mapping[str, str]
Map of key/value pairs of network config settings.
description str
Network description.
id str
The provider-assigned unique ID for this managed resource.
managed bool
Whether or not the network is managed.
name str
type str
Network type.
project str
remote str
config Map<String>
Map of key/value pairs of network config settings.
description String
Network description.
id String
The provider-assigned unique ID for this managed resource.
managed Boolean
Whether or not the network is managed.
name String
type String
Network type.
project String
remote String

Package Details

Repository
lxd terraform-lxd/terraform-provider-lxd
License
Notes
This Pulumi package is based on the lxd Terraform Provider.
lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
terraform-lxd/terraform-provider-lxd