Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getNdbNetwork
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getNdbNetwork

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

Describes a network in Nutanix Database Service

Example Usage

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

const nw = nutanix.getNdbNetwork({
    id: "{{ id of network }}",
});
Copy
import pulumi
import pulumi_nutanix as nutanix

nw = nutanix.get_ndb_network(id="{{ id of network }}")
Copy
package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.LookupNdbNetwork(ctx, &nutanix.LookupNdbNetworkArgs{
			Id: pulumi.StringRef("{{ id of network }}"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var nw = Nutanix.GetNdbNetwork.Invoke(new()
    {
        Id = "{{ id of network }}",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetNdbNetworkArgs;
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 nw = NutanixFunctions.getNdbNetwork(GetNdbNetworkArgs.builder()
            .id("{{ id of network }}")
            .build());

    }
}
Copy
variables:
  nw:
    fn::invoke:
      function: nutanix:getNdbNetwork
      arguments:
        id: '{{ id of network }}'
Copy

Using getNdbNetwork

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 getNdbNetwork(args: GetNdbNetworkArgs, opts?: InvokeOptions): Promise<GetNdbNetworkResult>
function getNdbNetworkOutput(args: GetNdbNetworkOutputArgs, opts?: InvokeOptions): Output<GetNdbNetworkResult>
Copy
def get_ndb_network(id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNdbNetworkResult
def get_ndb_network_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNdbNetworkResult]
Copy
func LookupNdbNetwork(ctx *Context, args *LookupNdbNetworkArgs, opts ...InvokeOption) (*LookupNdbNetworkResult, error)
func LookupNdbNetworkOutput(ctx *Context, args *LookupNdbNetworkOutputArgs, opts ...InvokeOption) LookupNdbNetworkResultOutput
Copy

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

public static class GetNdbNetwork 
{
    public static Task<GetNdbNetworkResult> InvokeAsync(GetNdbNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNdbNetworkResult> Invoke(GetNdbNetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNdbNetworkResult> getNdbNetwork(GetNdbNetworkArgs args, InvokeOptions options)
public static Output<GetNdbNetworkResult> getNdbNetwork(GetNdbNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getNdbNetwork:getNdbNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
id of network
Name string
name of network
Id string
id of network
Name string
name of network
id String
id of network
name String
name of network
id string
id of network
name string
name of network
id str
id of network
name str
name of network
id String
id of network
name String
name of network

getNdbNetwork Result

The following output properties are available:

ClusterId string
cluster id where network is present
Id string
network id
IpAddresses List<PiersKarsenbarg.Nutanix.Outputs.GetNdbNetworkIpAddress>
IP addresses of network
IpPools List<PiersKarsenbarg.Nutanix.Outputs.GetNdbNetworkIpPool>
IP Pools of network
Managed bool
network managed by NDB or not
Name string
network name
Properties List<PiersKarsenbarg.Nutanix.Outputs.GetNdbNetworkProperty>
properties of network
PropertiesMaps List<PiersKarsenbarg.Nutanix.Outputs.GetNdbNetworkPropertiesMap>
properties map of network
StretchedVlanId string
stretched vlan id
Type string
type of network
ClusterId string
cluster id where network is present
Id string
network id
IpAddresses []GetNdbNetworkIpAddress
IP addresses of network
IpPools []GetNdbNetworkIpPool
IP Pools of network
Managed bool
network managed by NDB or not
Name string
network name
Properties []GetNdbNetworkProperty
properties of network
PropertiesMaps []GetNdbNetworkPropertiesMap
properties map of network
StretchedVlanId string
stretched vlan id
Type string
type of network
clusterId String
cluster id where network is present
id String
network id
ipAddresses List<GetNdbNetworkIpAddress>
IP addresses of network
ipPools List<GetNdbNetworkIpPool>
IP Pools of network
managed Boolean
network managed by NDB or not
name String
network name
properties List<GetNdbNetworkProperty>
properties of network
propertiesMaps List<GetNdbNetworkPropertiesMap>
properties map of network
stretchedVlanId String
stretched vlan id
type String
type of network
clusterId string
cluster id where network is present
id string
network id
ipAddresses GetNdbNetworkIpAddress[]
IP addresses of network
ipPools GetNdbNetworkIpPool[]
IP Pools of network
managed boolean
network managed by NDB or not
name string
network name
properties GetNdbNetworkProperty[]
properties of network
propertiesMaps GetNdbNetworkPropertiesMap[]
properties map of network
stretchedVlanId string
stretched vlan id
type string
type of network
cluster_id str
cluster id where network is present
id str
network id
ip_addresses Sequence[GetNdbNetworkIpAddress]
IP addresses of network
ip_pools Sequence[GetNdbNetworkIpPool]
IP Pools of network
managed bool
network managed by NDB or not
name str
network name
properties Sequence[GetNdbNetworkProperty]
properties of network
properties_maps Sequence[GetNdbNetworkPropertiesMap]
properties map of network
stretched_vlan_id str
stretched vlan id
type str
type of network
clusterId String
cluster id where network is present
id String
network id
ipAddresses List<Property Map>
IP addresses of network
ipPools List<Property Map>
IP Pools of network
managed Boolean
network managed by NDB or not
name String
network name
properties List<Property Map>
properties of network
propertiesMaps List<Property Map>
properties map of network
stretchedVlanId String
stretched vlan id
type String
type of network

Supporting Types

GetNdbNetworkIpAddress

DbserverId This property is required. string
dbserver id
DbserverName This property is required. string
dbserver name
Ip This property is required. string
ip of pool
Status This property is required. string
ip status
DbserverId This property is required. string
dbserver id
DbserverName This property is required. string
dbserver name
Ip This property is required. string
ip of pool
Status This property is required. string
ip status
dbserverId This property is required. String
dbserver id
dbserverName This property is required. String
dbserver name
ip This property is required. String
ip of pool
status This property is required. String
ip status
dbserverId This property is required. string
dbserver id
dbserverName This property is required. string
dbserver name
ip This property is required. string
ip of pool
status This property is required. string
ip status
dbserver_id This property is required. str
dbserver id
dbserver_name This property is required. str
dbserver name
ip This property is required. str
ip of pool
status This property is required. str
ip status
dbserverId This property is required. String
dbserver id
dbserverName This property is required. String
dbserver name
ip This property is required. String
ip of pool
status This property is required. String
ip status

GetNdbNetworkIpPool

Addresses This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetNdbNetworkIpPoolAddress>
address of ips ranges
EndIp This property is required. string
end ip
StartIp This property is required. string
start ip
Addresses This property is required. []GetNdbNetworkIpPoolAddress
address of ips ranges
EndIp This property is required. string
end ip
StartIp This property is required. string
start ip
addresses This property is required. List<GetNdbNetworkIpPoolAddress>
address of ips ranges
endIp This property is required. String
end ip
startIp This property is required. String
start ip
addresses This property is required. GetNdbNetworkIpPoolAddress[]
address of ips ranges
endIp This property is required. string
end ip
startIp This property is required. string
start ip
addresses This property is required. Sequence[GetNdbNetworkIpPoolAddress]
address of ips ranges
end_ip This property is required. str
end ip
start_ip This property is required. str
start ip
addresses This property is required. List<Property Map>
address of ips ranges
endIp This property is required. String
end ip
startIp This property is required. String
start ip

GetNdbNetworkIpPoolAddress

Ip This property is required. string
ip of pool
Status This property is required. string
ip status
Ip This property is required. string
ip of pool
Status This property is required. string
ip status
ip This property is required. String
ip of pool
status This property is required. String
ip status
ip This property is required. string
ip of pool
status This property is required. string
ip status
ip This property is required. str
ip of pool
status This property is required. str
ip status
ip This property is required. String
ip of pool
status This property is required. String
ip status

GetNdbNetworkPropertiesMap

VlanGateway This property is required. string
gateway of vlan
VlanPrimaryDns This property is required. string
primary dns of vlan
VlanSecondaryDns This property is required. string
secondary dns of vlan
VlanSubnetMask This property is required. string
subnet mask of vlan
VlanGateway This property is required. string
gateway of vlan
VlanPrimaryDns This property is required. string
primary dns of vlan
VlanSecondaryDns This property is required. string
secondary dns of vlan
VlanSubnetMask This property is required. string
subnet mask of vlan
vlanGateway This property is required. String
gateway of vlan
vlanPrimaryDns This property is required. String
primary dns of vlan
vlanSecondaryDns This property is required. String
secondary dns of vlan
vlanSubnetMask This property is required. String
subnet mask of vlan
vlanGateway This property is required. string
gateway of vlan
vlanPrimaryDns This property is required. string
primary dns of vlan
vlanSecondaryDns This property is required. string
secondary dns of vlan
vlanSubnetMask This property is required. string
subnet mask of vlan
vlan_gateway This property is required. str
gateway of vlan
vlan_primary_dns This property is required. str
primary dns of vlan
vlan_secondary_dns This property is required. str
secondary dns of vlan
vlan_subnet_mask This property is required. str
subnet mask of vlan
vlanGateway This property is required. String
gateway of vlan
vlanPrimaryDns This property is required. String
primary dns of vlan
vlanSecondaryDns This property is required. String
secondary dns of vlan
vlanSubnetMask This property is required. String
subnet mask of vlan

GetNdbNetworkProperty

Name This property is required. string
name of network
Secure This property is required. bool
Value This property is required. string
Name This property is required. string
name of network
Secure This property is required. bool
Value This property is required. string
name This property is required. String
name of network
secure This property is required. Boolean
value This property is required. String
name This property is required. string
name of network
secure This property is required. boolean
value This property is required. string
name This property is required. str
name of network
secure This property is required. bool
value This property is required. str
name This property is required. String
name of network
secure This property is required. Boolean
value This property is required. String

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix