Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nutanix
  4. API Docs
  5. getNetworkFunctionV2
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getNetworkFunctionV2

nutanix logo
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Get a single Network Function corresponding to the ext_id.

    Example Usage

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

const nf = nutanix.getNetworkFunctionV2({
    extId: "52a4db2a-78a9-4c21-8e51-6c26a6ff92a9",
});

    import pulumi
import pulumi_nutanix as nutanix

nf = nutanix.get_network_function_v2(ext_id="52a4db2a-78a9-4c21-8e51-6c26a6ff92a9")

    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.GetNetworkFunctionV2(ctx, &nutanix.LookupNetworkFunctionV2Args{
			ExtId: "52a4db2a-78a9-4c21-8e51-6c26a6ff92a9",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;

return await Deployment.RunAsync(() => 
{
    var nf = Nutanix.GetNetworkFunctionV2.Invoke(new()
    {
        ExtId = "52a4db2a-78a9-4c21-8e51-6c26a6ff92a9",
    });

});

    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.GetNetworkFunctionV2Args;
import java.util.ArrayList;
import java.util.Arrays;
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 nf = NutanixFunctions.getNetworkFunctionV2(GetNetworkFunctionV2Args.builder()
            .extId("52a4db2a-78a9-4c21-8e51-6c26a6ff92a9")
            .build());

    }
}

    variables:
  nf:
    fn::invoke:
      function: nutanix:getNetworkFunctionV2
      arguments:
        extId: 52a4db2a-78a9-4c21-8e51-6c26a6ff92a9

    pulumi {
  required_providers {
    nutanix = {
      source = "pulumi/nutanix"
    }
  }
}

data "nutanix_getnetworkfunctionv2" "nf" {
  ext_id = "52a4db2a-78a9-4c21-8e51-6c26a6ff92a9"
}

    Using getNetworkFunctionV2

    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 getNetworkFunctionV2(args: GetNetworkFunctionV2Args, opts?: InvokeOptions): Promise<GetNetworkFunctionV2Result>
function getNetworkFunctionV2Output(args: GetNetworkFunctionV2OutputArgs, opts?: InvokeOptions): Output<GetNetworkFunctionV2Result>
    def get_network_function_v2(ext_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetNetworkFunctionV2Result
def get_network_function_v2_output(ext_id: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetNetworkFunctionV2Result]
    func LookupNetworkFunctionV2(ctx *Context, args *LookupNetworkFunctionV2Args, opts ...InvokeOption) (*LookupNetworkFunctionV2Result, error)
func LookupNetworkFunctionV2Output(ctx *Context, args *LookupNetworkFunctionV2OutputArgs, opts ...InvokeOption) LookupNetworkFunctionV2ResultOutput

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

    public static class GetNetworkFunctionV2 
{
    public static Task<GetNetworkFunctionV2Result> InvokeAsync(GetNetworkFunctionV2Args args, InvokeOptions? opts = null)
    public static Output<GetNetworkFunctionV2Result> Invoke(GetNetworkFunctionV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkFunctionV2Result> getNetworkFunctionV2(GetNetworkFunctionV2Args args, InvokeOptions options)
public static Output<GetNetworkFunctionV2Result> getNetworkFunctionV2(GetNetworkFunctionV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getNetworkFunctionV2:getNetworkFunctionV2
  arguments:
    # arguments dictionary
    data "nutanix_getnetworkfunctionv2" "name" {
    # arguments
}

    The following arguments are supported:

    ExtId string
    Network Function UUID
    ExtId string
    Network Function UUID
    ext_id string
    Network Function UUID
    extId String
    Network Function UUID
    extId string
    Network Function UUID
    ext_id str
    Network Function UUID
    extId String
    Network Function UUID

    getNetworkFunctionV2 Result

    The following output properties are available:

    DataPlaneHealthCheckConfigs List<PiersKarsenbarg.Nutanix.Outputs.GetNetworkFunctionV2DataPlaneHealthCheckConfig>
    Data plane health check configuration.
    Description string
    Description of the network function.
    ExtId string
    globally unique identifier of an instance that is suitable for external consumption.
    FailureHandling string
    Failure handling behavior when network function is unhealthy. Values:
    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Values:
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetNetworkFunctionV2Link>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Metadatas List<PiersKarsenbarg.Nutanix.Outputs.GetNetworkFunctionV2Metadata>
    Metadata associated with this resource.
    Name string
    Name of the network function.
    NicPairs List<PiersKarsenbarg.Nutanix.Outputs.GetNetworkFunctionV2NicPair>
    List of NIC pairs part of this network function.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:
    DataPlaneHealthCheckConfigs []GetNetworkFunctionV2DataPlaneHealthCheckConfig
    Data plane health check configuration.
    Description string
    Description of the network function.
    ExtId string
    globally unique identifier of an instance that is suitable for external consumption.
    FailureHandling string
    Failure handling behavior when network function is unhealthy. Values:
    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Values:
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []GetNetworkFunctionV2Link
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Metadatas []GetNetworkFunctionV2Metadata
    Metadata associated with this resource.
    Name string
    Name of the network function.
    NicPairs []GetNetworkFunctionV2NicPair
    List of NIC pairs part of this network function.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:
    data_plane_health_check_configs list(object)
    Data plane health check configuration.
    description string
    Description of the network function.
    ext_id string
    globally unique identifier of an instance that is suitable for external consumption.
    failure_handling string
    Failure handling behavior when network function is unhealthy. Values:
    high_availability_mode string
    High availability configuration used between virtual NIC pairs. Values:
    id string
    The provider-assigned unique ID for this managed resource.
    links list(object)
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    metadatas list(object)
    Metadata associated with this resource.
    name string
    Name of the network function.
    nic_pairs list(object)
    List of NIC pairs part of this network function.
    tenant_id string
    A globally unique identifier that represents the tenant that owns this entity.
    traffic_forwarding_mode string
    Traffic forwarding mode. Values:
    dataPlaneHealthCheckConfigs List<GetNetworkFunctionV2DataPlaneHealthCheckConfig>
    Data plane health check configuration.
    description String
    Description of the network function.
    extId String
    globally unique identifier of an instance that is suitable for external consumption.
    failureHandling String
    Failure handling behavior when network function is unhealthy. Values:
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Values:
    id String
    The provider-assigned unique ID for this managed resource.
    links List<GetNetworkFunctionV2Link>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    metadatas List<GetNetworkFunctionV2Metadata>
    Metadata associated with this resource.
    name String
    Name of the network function.
    nicPairs List<GetNetworkFunctionV2NicPair>
    List of NIC pairs part of this network function.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode String
    Traffic forwarding mode. Values:
    dataPlaneHealthCheckConfigs GetNetworkFunctionV2DataPlaneHealthCheckConfig[]
    Data plane health check configuration.
    description string
    Description of the network function.
    extId string
    globally unique identifier of an instance that is suitable for external consumption.
    failureHandling string
    Failure handling behavior when network function is unhealthy. Values:
    highAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Values:
    id string
    The provider-assigned unique ID for this managed resource.
    links GetNetworkFunctionV2Link[]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    metadatas GetNetworkFunctionV2Metadata[]
    Metadata associated with this resource.
    name string
    Name of the network function.
    nicPairs GetNetworkFunctionV2NicPair[]
    List of NIC pairs part of this network function.
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode string
    Traffic forwarding mode. Values:
    data_plane_health_check_configs Sequence[GetNetworkFunctionV2DataPlaneHealthCheckConfig]
    Data plane health check configuration.
    description str
    Description of the network function.
    ext_id str
    globally unique identifier of an instance that is suitable for external consumption.
    failure_handling str
    Failure handling behavior when network function is unhealthy. Values:
    high_availability_mode str
    High availability configuration used between virtual NIC pairs. Values:
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[GetNetworkFunctionV2Link]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    metadatas Sequence[GetNetworkFunctionV2Metadata]
    Metadata associated with this resource.
    name str
    Name of the network function.
    nic_pairs Sequence[GetNetworkFunctionV2NicPair]
    List of NIC pairs part of this network function.
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity.
    traffic_forwarding_mode str
    Traffic forwarding mode. Values:
    dataPlaneHealthCheckConfigs List<Property Map>
    Data plane health check configuration.
    description String
    Description of the network function.
    extId String
    globally unique identifier of an instance that is suitable for external consumption.
    failureHandling String
    Failure handling behavior when network function is unhealthy. Values:
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Values:
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    metadatas List<Property Map>
    Metadata associated with this resource.
    name String
    Name of the network function.
    nicPairs List<Property Map>
    List of NIC pairs part of this network function.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode String
    Traffic forwarding mode. Values:

    Supporting Types

    GetNetworkFunctionV2DataPlaneHealthCheckConfig

    FailureThreshold int
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    IntervalSecs int
    Default: 5. Interval in seconds between health checks.
    SuccessThreshold int
    Default: 3. The number of successful checks after which the target is considered healthy.
    TimeoutSecs int
    Default: 1. The time, in seconds, after which a health check times out.
    FailureThreshold int
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    IntervalSecs int
    Default: 5. Interval in seconds between health checks.
    SuccessThreshold int
    Default: 3. The number of successful checks after which the target is considered healthy.
    TimeoutSecs int
    Default: 1. The time, in seconds, after which a health check times out.
    failure_threshold number
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    interval_secs number
    Default: 5. Interval in seconds between health checks.
    success_threshold number
    Default: 3. The number of successful checks after which the target is considered healthy.
    timeout_secs number
    Default: 1. The time, in seconds, after which a health check times out.
    failureThreshold Integer
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    intervalSecs Integer
    Default: 5. Interval in seconds between health checks.
    successThreshold Integer
    Default: 3. The number of successful checks after which the target is considered healthy.
    timeoutSecs Integer
    Default: 1. The time, in seconds, after which a health check times out.
    failureThreshold number
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    intervalSecs number
    Default: 5. Interval in seconds between health checks.
    successThreshold number
    Default: 3. The number of successful checks after which the target is considered healthy.
    timeoutSecs number
    Default: 1. The time, in seconds, after which a health check times out.
    failure_threshold int
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    interval_secs int
    Default: 5. Interval in seconds between health checks.
    success_threshold int
    Default: 3. The number of successful checks after which the target is considered healthy.
    timeout_secs int
    Default: 1. The time, in seconds, after which a health check times out.
    failureThreshold Number
    Default: 3. The number of failure checks after which the target is considered unhealthy.
    intervalSecs Number
    Default: 5. Interval in seconds between health checks.
    successThreshold Number
    Default: 3. The number of successful checks after which the target is considered healthy.
    timeoutSecs Number
    Default: 1. The time, in seconds, after which a health check times out.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href string
    • The URL at which the entity described by the link can be accessed.
    rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href string
    • The URL at which the entity described by the link can be accessed.
    rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href str
    • The URL at which the entity described by the link can be accessed.
    rel str
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.

    GetNetworkFunctionV2Metadata

    CategoryIds List<string>
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    OwnerReferenceId string
    A globally unique identifier that represents the owner of this resource.
    OwnerUserName string
    The userName of the owner of this resource.
    ProjectName string
    The name of the project this resource belongs to.
    ProjectReferenceId string
    A globally unique identifier that represents the project this resource belongs to.
    CategoryIds []string
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    OwnerReferenceId string
    A globally unique identifier that represents the owner of this resource.
    OwnerUserName string
    The userName of the owner of this resource.
    ProjectName string
    The name of the project this resource belongs to.
    ProjectReferenceId string
    A globally unique identifier that represents the project this resource belongs to.
    category_ids list(string)
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    owner_reference_id string
    A globally unique identifier that represents the owner of this resource.
    owner_user_name string
    The userName of the owner of this resource.
    project_name string
    The name of the project this resource belongs to.
    project_reference_id string
    A globally unique identifier that represents the project this resource belongs to.
    categoryIds List<String>
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    ownerReferenceId String
    A globally unique identifier that represents the owner of this resource.
    ownerUserName String
    The userName of the owner of this resource.
    projectName String
    The name of the project this resource belongs to.
    projectReferenceId String
    A globally unique identifier that represents the project this resource belongs to.
    categoryIds string[]
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    ownerReferenceId string
    A globally unique identifier that represents the owner of this resource.
    ownerUserName string
    The userName of the owner of this resource.
    projectName string
    The name of the project this resource belongs to.
    projectReferenceId string
    A globally unique identifier that represents the project this resource belongs to.
    category_ids Sequence[str]
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    owner_reference_id str
    A globally unique identifier that represents the owner of this resource.
    owner_user_name str
    The userName of the owner of this resource.
    project_name str
    The name of the project this resource belongs to.
    project_reference_id str
    A globally unique identifier that represents the project this resource belongs to.
    categoryIds List<String>
    A list of globally unique identifiers that represent all the categories the resource is associated with.
    ownerReferenceId String
    A globally unique identifier that represents the owner of this resource.
    ownerUserName String
    The userName of the owner of this resource.
    projectName String
    The name of the project this resource belongs to.
    projectReferenceId String
    A globally unique identifier that represents the project this resource belongs to.

    GetNetworkFunctionV2NicPair

    DataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    EgressNicReference string
    UUID of NIC which will be used as egress NIC.
    HighAvailabilityState string
    High availability state of the NIC pair. Values:
    IngressNicReference string
    UUID of NIC which will be used as ingress NIC..
    IsEnabled bool
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    VmReference string
    VM UUID which both ingress/egress NICs are part of.
    DataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    EgressNicReference string
    UUID of NIC which will be used as egress NIC.
    HighAvailabilityState string
    High availability state of the NIC pair. Values:
    IngressNicReference string
    UUID of NIC which will be used as ingress NIC..
    IsEnabled bool
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    VmReference string
    VM UUID which both ingress/egress NICs are part of.
    data_plane_health_status string
    Data plane health status of the NIC pair. Values:
    egress_nic_reference string
    UUID of NIC which will be used as egress NIC.
    high_availability_state string
    High availability state of the NIC pair. Values:
    ingress_nic_reference string
    UUID of NIC which will be used as ingress NIC..
    is_enabled bool
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    vm_reference string
    VM UUID which both ingress/egress NICs are part of.
    dataPlaneHealthStatus String
    Data plane health status of the NIC pair. Values:
    egressNicReference String
    UUID of NIC which will be used as egress NIC.
    highAvailabilityState String
    High availability state of the NIC pair. Values:
    ingressNicReference String
    UUID of NIC which will be used as ingress NIC..
    isEnabled Boolean
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    vmReference String
    VM UUID which both ingress/egress NICs are part of.
    dataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    egressNicReference string
    UUID of NIC which will be used as egress NIC.
    highAvailabilityState string
    High availability state of the NIC pair. Values:
    ingressNicReference string
    UUID of NIC which will be used as ingress NIC..
    isEnabled boolean
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    vmReference string
    VM UUID which both ingress/egress NICs are part of.
    data_plane_health_status str
    Data plane health status of the NIC pair. Values:
    egress_nic_reference str
    UUID of NIC which will be used as egress NIC.
    high_availability_state str
    High availability state of the NIC pair. Values:
    ingress_nic_reference str
    UUID of NIC which will be used as ingress NIC..
    is_enabled bool
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    vm_reference str
    VM UUID which both ingress/egress NICs are part of.
    dataPlaneHealthStatus String
    Data plane health status of the NIC pair. Values:
    egressNicReference String
    UUID of NIC which will be used as egress NIC.
    highAvailabilityState String
    High availability state of the NIC pair. Values:
    ingressNicReference String
    UUID of NIC which will be used as ingress NIC..
    isEnabled Boolean
    Default: true. Administrative state of the NIC pair. If it's set to False, the NIC pair will not be selected as ACTIVE network function.
    vmReference String
    VM UUID which both ingress/egress NICs are part of.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.16.0
    published on Tuesday, May 26, 2026 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial