GetNetwork
The vsphere..getNetwork data source can be used to discover the ID of a network
in vSphere. This can be any network that can be used as the backing for a
network interface for vsphere..VirtualMachine or any other vSphere resource
that requires a network. This includes standard (host-based) port groups, DVS
port groups, or opaque networks such as those managed by NSX.
Example Usage
using Pulumi;
using VSphere = Pulumi.VSphere;
class MyStack : Stack
{
public MyStack()
{
var datacenter = Output.Create(VSphere.GetDatacenter.InvokeAsync(new VSphere.GetDatacenterArgs
{
Name = "dc1",
}));
var net = datacenter.Apply(datacenter => Output.Create(VSphere.GetNetwork.InvokeAsync(new VSphere.GetNetworkArgs
{
DatacenterId = datacenter.Id,
Name = "test-net",
})));
}
}
Coming soon!
import pulumi
import pulumi_vsphere as vsphere
datacenter = vsphere.get_datacenter(name="dc1")
net = vsphere.get_network(datacenter_id=datacenter.id,
name="test-net")import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";
const datacenter = pulumi.output(vsphere.getDatacenter({
name: "dc1",
}, { async: true }));
const net = datacenter.apply(datacenter => vsphere.getNetwork({
datacenterId: datacenter.id,
name: "test-net",
}, { async: true }));Using GetNetwork
function getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>function get_network(datacenter_id=None, distributed_virtual_switch_uuid=None, name=None, opts=None)func GetNetwork(ctx *Context, args *GetNetworkArgs, opts ...InvokeOption) (*GetNetworkResult, error)public static class GetNetwork {
public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
- Name string
The name of the network. This can be a name or path.
- Datacenter
Id string The managed object reference ID of the datacenter the network is located in. This can be omitted if the search path used in
nameis an absolute path. For default datacenters, use the id attribute from an emptyvsphere..Datacenterdata source.- Distributed
Virtual stringSwitch Uuid For distributed port group type network objects, the ID of the distributed virtual switch the given port group belongs to. It is useful to differentiate port groups with same name using the Distributed virtual switch ID.
- Name string
The name of the network. This can be a name or path.
- Datacenter
Id string The managed object reference ID of the datacenter the network is located in. This can be omitted if the search path used in
nameis an absolute path. For default datacenters, use the id attribute from an emptyvsphere..Datacenterdata source.- Distributed
Virtual stringSwitch Uuid For distributed port group type network objects, the ID of the distributed virtual switch the given port group belongs to. It is useful to differentiate port groups with same name using the Distributed virtual switch ID.
- name string
The name of the network. This can be a name or path.
- datacenter
Id string The managed object reference ID of the datacenter the network is located in. This can be omitted if the search path used in
nameis an absolute path. For default datacenters, use the id attribute from an emptyvsphere..Datacenterdata source.- distributed
Virtual stringSwitch Uuid For distributed port group type network objects, the ID of the distributed virtual switch the given port group belongs to. It is useful to differentiate port groups with same name using the Distributed virtual switch ID.
- name str
The name of the network. This can be a name or path.
- datacenter_
id str The managed object reference ID of the datacenter the network is located in. This can be omitted if the search path used in
nameis an absolute path. For default datacenters, use the id attribute from an emptyvsphere..Datacenterdata source.- distributed_
virtual_ strswitch_ uuid For distributed port group type network objects, the ID of the distributed virtual switch the given port group belongs to. It is useful to differentiate port groups with same name using the Distributed virtual switch ID.
GetNetwork Result
The following output properties are available:
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
- Type string
- Datacenter
Id string - Distributed
Virtual stringSwitch Uuid
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
- Type string
- Datacenter
Id string - Distributed
Virtual stringSwitch Uuid
- id string
The provider-assigned unique ID for this managed resource.
- name string
- type string
- datacenter
Id string - distributed
Virtual stringSwitch Uuid
- id str
The provider-assigned unique ID for this managed resource.
- name str
- type str
- datacenter_
id str - distributed_
virtual_ strswitch_ uuid
Package Details
- Repository
- https://github.com/pulumi/pulumi-vsphere
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vsphereTerraform Provider.