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

nutanix.NetworkFunctionV2

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

    Create and manage a Network Function.

    Example

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

const nf = new nutanix.NetworkFunctionV2("nf", {
    name: "tf-network-function",
    description: "Network function managed by Terraform",
    highAvailabilityMode: "ACTIVE_PASSIVE",
    failureHandling: "NO_ACTION",
    trafficForwardingMode: "INLINE",
    dataPlaneHealthCheckConfig: {
        failureThreshold: 2,
        intervalSecs: 5,
        successThreshold: 2,
        timeoutSecs: 5,
    },
    nicPairs: [
        {
            ingressNicReference: "00000000-0000-0000-0000-000000000000",
            egressNicReference: "11111111-1111-1111-1111-111111111111",
            vmReference: "22222222-2222-2222-2222-222222222222",
            isEnabled: true,
        },
        {
            ingressNicReference: "33333333-3333-3333-3333-333333333333",
            egressNicReference: "44444444-4444-4444-4444-444444444444",
            vmReference: "55555555-5555-5555-5555-555555555555",
            isEnabled: true,
        },
    ],
});

    import pulumi
import pulumi_nutanix as nutanix

nf = nutanix.NetworkFunctionV2("nf",
    name="tf-network-function",
    description="Network function managed by Terraform",
    high_availability_mode="ACTIVE_PASSIVE",
    failure_handling="NO_ACTION",
    traffic_forwarding_mode="INLINE",
    data_plane_health_check_config={
        "failure_threshold": 2,
        "interval_secs": 5,
        "success_threshold": 2,
        "timeout_secs": 5,
    },
    nic_pairs=[
        {
            "ingress_nic_reference": "00000000-0000-0000-0000-000000000000",
            "egress_nic_reference": "11111111-1111-1111-1111-111111111111",
            "vm_reference": "22222222-2222-2222-2222-222222222222",
            "is_enabled": True,
        },
        {
            "ingress_nic_reference": "33333333-3333-3333-3333-333333333333",
            "egress_nic_reference": "44444444-4444-4444-4444-444444444444",
            "vm_reference": "55555555-5555-5555-5555-555555555555",
            "is_enabled": True,
        },
    ])

    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.NewNetworkFunctionV2(ctx, "nf", &nutanix.NetworkFunctionV2Args{
			Name:                  pulumi.String("tf-network-function"),
			Description:           pulumi.String("Network function managed by Terraform"),
			HighAvailabilityMode:  pulumi.String("ACTIVE_PASSIVE"),
			FailureHandling:       pulumi.String("NO_ACTION"),
			TrafficForwardingMode: pulumi.String("INLINE"),
			DataPlaneHealthCheckConfig: &nutanix.NetworkFunctionV2DataPlaneHealthCheckConfigArgs{
				FailureThreshold: pulumi.Int(2),
				IntervalSecs:     pulumi.Int(5),
				SuccessThreshold: pulumi.Int(2),
				TimeoutSecs:      pulumi.Int(5),
			},
			NicPairs: nutanix.NetworkFunctionV2NicPairArray{
				&nutanix.NetworkFunctionV2NicPairArgs{
					IngressNicReference: pulumi.String("00000000-0000-0000-0000-000000000000"),
					EgressNicReference:  pulumi.String("11111111-1111-1111-1111-111111111111"),
					VmReference:         pulumi.String("22222222-2222-2222-2222-222222222222"),
					IsEnabled:           pulumi.Bool(true),
				},
				&nutanix.NetworkFunctionV2NicPairArgs{
					IngressNicReference: pulumi.String("33333333-3333-3333-3333-333333333333"),
					EgressNicReference:  pulumi.String("44444444-4444-4444-4444-444444444444"),
					VmReference:         pulumi.String("55555555-5555-5555-5555-555555555555"),
					IsEnabled:           pulumi.Bool(true),
				},
			},
		})
		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 = new Nutanix.NetworkFunctionV2("nf", new()
    {
        Name = "tf-network-function",
        Description = "Network function managed by Terraform",
        HighAvailabilityMode = "ACTIVE_PASSIVE",
        FailureHandling = "NO_ACTION",
        TrafficForwardingMode = "INLINE",
        DataPlaneHealthCheckConfig = new Nutanix.Inputs.NetworkFunctionV2DataPlaneHealthCheckConfigArgs
        {
            FailureThreshold = 2,
            IntervalSecs = 5,
            SuccessThreshold = 2,
            TimeoutSecs = 5,
        },
        NicPairs = new[]
        {
            new Nutanix.Inputs.NetworkFunctionV2NicPairArgs
            {
                IngressNicReference = "00000000-0000-0000-0000-000000000000",
                EgressNicReference = "11111111-1111-1111-1111-111111111111",
                VmReference = "22222222-2222-2222-2222-222222222222",
                IsEnabled = true,
            },
            new Nutanix.Inputs.NetworkFunctionV2NicPairArgs
            {
                IngressNicReference = "33333333-3333-3333-3333-333333333333",
                EgressNicReference = "44444444-4444-4444-4444-444444444444",
                VmReference = "55555555-5555-5555-5555-555555555555",
                IsEnabled = true,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NetworkFunctionV2;
import com.pulumi.nutanix.NetworkFunctionV2Args;
import com.pulumi.nutanix.inputs.NetworkFunctionV2DataPlaneHealthCheckConfigArgs;
import com.pulumi.nutanix.inputs.NetworkFunctionV2NicPairArgs;
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) {
        var nf = new NetworkFunctionV2("nf", NetworkFunctionV2Args.builder()
            .name("tf-network-function")
            .description("Network function managed by Terraform")
            .highAvailabilityMode("ACTIVE_PASSIVE")
            .failureHandling("NO_ACTION")
            .trafficForwardingMode("INLINE")
            .dataPlaneHealthCheckConfig(NetworkFunctionV2DataPlaneHealthCheckConfigArgs.builder()
                .failureThreshold(2)
                .intervalSecs(5)
                .successThreshold(2)
                .timeoutSecs(5)
                .build())
            .nicPairs(            
                NetworkFunctionV2NicPairArgs.builder()
                    .ingressNicReference("00000000-0000-0000-0000-000000000000")
                    .egressNicReference("11111111-1111-1111-1111-111111111111")
                    .vmReference("22222222-2222-2222-2222-222222222222")
                    .isEnabled(true)
                    .build(),
                NetworkFunctionV2NicPairArgs.builder()
                    .ingressNicReference("33333333-3333-3333-3333-333333333333")
                    .egressNicReference("44444444-4444-4444-4444-444444444444")
                    .vmReference("55555555-5555-5555-5555-555555555555")
                    .isEnabled(true)
                    .build())
            .build());

    }
}

    resources:
  nf:
    type: nutanix:NetworkFunctionV2
    properties:
      name: tf-network-function
      description: Network function managed by Terraform
      highAvailabilityMode: ACTIVE_PASSIVE
      failureHandling: NO_ACTION
      trafficForwardingMode: INLINE
      dataPlaneHealthCheckConfig:
        failureThreshold: 2
        intervalSecs: 5
        successThreshold: 2
        timeoutSecs: 5
      nicPairs:
        - ingressNicReference: 00000000-0000-0000-0000-000000000000
          egressNicReference: 11111111-1111-1111-1111-111111111111
          vmReference: 22222222-2222-2222-2222-222222222222
          isEnabled: true
        - ingressNicReference: 33333333-3333-3333-3333-333333333333
          egressNicReference: 44444444-4444-4444-4444-444444444444
          vmReference: 55555555-5555-5555-5555-555555555555
          isEnabled: true

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

resource "nutanix_networkfunctionv2" "nf" {
  name                    = "tf-network-function"
  description             = "Network function managed by Terraform"
  high_availability_mode  = "ACTIVE_PASSIVE"
  failure_handling        = "NO_ACTION"
  traffic_forwarding_mode = "INLINE"
  data_plane_health_check_config = {
    failure_threshold = 2
    interval_secs     = 5
    success_threshold = 2
    timeout_secs      = 5
  }
  nic_pairs {
    ingress_nic_reference = "00000000-0000-0000-0000-000000000000"
    egress_nic_reference  = "11111111-1111-1111-1111-111111111111"
    vm_reference          = "22222222-2222-2222-2222-222222222222"
    is_enabled            = true
  }
  nic_pairs {
    ingress_nic_reference = "33333333-3333-3333-3333-333333333333"
    egress_nic_reference  = "44444444-4444-4444-4444-444444444444"
    vm_reference          = "55555555-5555-5555-5555-555555555555"
    is_enabled            = true
  }
}

    Create NetworkFunctionV2 Resource

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

    Constructor syntax

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

@overload
def NetworkFunctionV2(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      high_availability_mode: Optional[str] = None,
                      nic_pairs: Optional[Sequence[NetworkFunctionV2NicPairArgs]] = None,
                      data_plane_health_check_config: Optional[NetworkFunctionV2DataPlaneHealthCheckConfigArgs] = None,
                      description: Optional[str] = None,
                      ext_id: Optional[str] = None,
                      failure_handling: Optional[str] = None,
                      metadatas: Optional[Sequence[NetworkFunctionV2MetadataArgs]] = None,
                      name: Optional[str] = None,
                      traffic_forwarding_mode: Optional[str] = None)
    func NewNetworkFunctionV2(ctx *Context, name string, args NetworkFunctionV2Args, opts ...ResourceOption) (*NetworkFunctionV2, error)
    public NetworkFunctionV2(string name, NetworkFunctionV2Args args, CustomResourceOptions? opts = null)
    public NetworkFunctionV2(String name, NetworkFunctionV2Args args)
public NetworkFunctionV2(String name, NetworkFunctionV2Args args, CustomResourceOptions options)

    type: nutanix:NetworkFunctionV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "nutanix_networkfunctionv2" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args NetworkFunctionV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NetworkFunctionV2Args
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NetworkFunctionV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkFunctionV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkFunctionV2Args
    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 networkFunctionV2Resource = new Nutanix.NetworkFunctionV2("networkFunctionV2Resource", new()
{
    HighAvailabilityMode = "string",
    NicPairs = new[]
    {
        new Nutanix.Inputs.NetworkFunctionV2NicPairArgs
        {
            IngressNicReference = "string",
            IsEnabled = false,
            DataPlaneHealthStatus = "string",
            EgressNicReference = "string",
            HighAvailabilityState = "string",
            VmReference = "string",
        },
    },
    DataPlaneHealthCheckConfig = new Nutanix.Inputs.NetworkFunctionV2DataPlaneHealthCheckConfigArgs
    {
        FailureThreshold = 0,
        IntervalSecs = 0,
        SuccessThreshold = 0,
        TimeoutSecs = 0,
    },
    Description = "string",
    ExtId = "string",
    FailureHandling = "string",
    Metadatas = new[]
    {
        new Nutanix.Inputs.NetworkFunctionV2MetadataArgs
        {
            CategoryIds = new[]
            {
                "string",
            },
            OwnerReferenceId = "string",
            OwnerUserName = "string",
            ProjectName = "string",
            ProjectReferenceId = "string",
        },
    },
    Name = "string",
    TrafficForwardingMode = "string",
});

    example, err := nutanix.NewNetworkFunctionV2(ctx, "networkFunctionV2Resource", &nutanix.NetworkFunctionV2Args{
	HighAvailabilityMode: pulumi.String("string"),
	NicPairs: nutanix.NetworkFunctionV2NicPairArray{
		&nutanix.NetworkFunctionV2NicPairArgs{
			IngressNicReference:   pulumi.String("string"),
			IsEnabled:             pulumi.Bool(false),
			DataPlaneHealthStatus: pulumi.String("string"),
			EgressNicReference:    pulumi.String("string"),
			HighAvailabilityState: pulumi.String("string"),
			VmReference:           pulumi.String("string"),
		},
	},
	DataPlaneHealthCheckConfig: &nutanix.NetworkFunctionV2DataPlaneHealthCheckConfigArgs{
		FailureThreshold: pulumi.Int(0),
		IntervalSecs:     pulumi.Int(0),
		SuccessThreshold: pulumi.Int(0),
		TimeoutSecs:      pulumi.Int(0),
	},
	Description:     pulumi.String("string"),
	ExtId:           pulumi.String("string"),
	FailureHandling: pulumi.String("string"),
	Metadatas: nutanix.NetworkFunctionV2MetadataArray{
		&nutanix.NetworkFunctionV2MetadataArgs{
			CategoryIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			OwnerReferenceId:   pulumi.String("string"),
			OwnerUserName:      pulumi.String("string"),
			ProjectName:        pulumi.String("string"),
			ProjectReferenceId: pulumi.String("string"),
		},
	},
	Name:                  pulumi.String("string"),
	TrafficForwardingMode: pulumi.String("string"),
})

    resource "nutanix_networkfunctionv2" "networkFunctionV2Resource" {
  high_availability_mode = "string"
  nic_pairs {
    ingress_nic_reference    = "string"
    is_enabled               = false
    data_plane_health_status = "string"
    egress_nic_reference     = "string"
    high_availability_state  = "string"
    vm_reference             = "string"
  }
  data_plane_health_check_config = {
    failure_threshold = 0
    interval_secs     = 0
    success_threshold = 0
    timeout_secs      = 0
  }
  description      = "string"
  ext_id           = "string"
  failure_handling = "string"
  metadatas {
    category_ids         = ["string"]
    owner_reference_id   = "string"
    owner_user_name      = "string"
    project_name         = "string"
    project_reference_id = "string"
  }
  name                    = "string"
  traffic_forwarding_mode = "string"
}

    var networkFunctionV2Resource = new NetworkFunctionV2("networkFunctionV2Resource", NetworkFunctionV2Args.builder()
    .highAvailabilityMode("string")
    .nicPairs(NetworkFunctionV2NicPairArgs.builder()
        .ingressNicReference("string")
        .isEnabled(false)
        .dataPlaneHealthStatus("string")
        .egressNicReference("string")
        .highAvailabilityState("string")
        .vmReference("string")
        .build())
    .dataPlaneHealthCheckConfig(NetworkFunctionV2DataPlaneHealthCheckConfigArgs.builder()
        .failureThreshold(0)
        .intervalSecs(0)
        .successThreshold(0)
        .timeoutSecs(0)
        .build())
    .description("string")
    .extId("string")
    .failureHandling("string")
    .metadatas(NetworkFunctionV2MetadataArgs.builder()
        .categoryIds("string")
        .ownerReferenceId("string")
        .ownerUserName("string")
        .projectName("string")
        .projectReferenceId("string")
        .build())
    .name("string")
    .trafficForwardingMode("string")
    .build());

    network_function_v2_resource = nutanix.NetworkFunctionV2("networkFunctionV2Resource",
    high_availability_mode="string",
    nic_pairs=[{
        "ingress_nic_reference": "string",
        "is_enabled": False,
        "data_plane_health_status": "string",
        "egress_nic_reference": "string",
        "high_availability_state": "string",
        "vm_reference": "string",
    }],
    data_plane_health_check_config={
        "failure_threshold": 0,
        "interval_secs": 0,
        "success_threshold": 0,
        "timeout_secs": 0,
    },
    description="string",
    ext_id="string",
    failure_handling="string",
    metadatas=[{
        "category_ids": ["string"],
        "owner_reference_id": "string",
        "owner_user_name": "string",
        "project_name": "string",
        "project_reference_id": "string",
    }],
    name="string",
    traffic_forwarding_mode="string")

    const networkFunctionV2Resource = new nutanix.NetworkFunctionV2("networkFunctionV2Resource", {
    highAvailabilityMode: "string",
    nicPairs: [{
        ingressNicReference: "string",
        isEnabled: false,
        dataPlaneHealthStatus: "string",
        egressNicReference: "string",
        highAvailabilityState: "string",
        vmReference: "string",
    }],
    dataPlaneHealthCheckConfig: {
        failureThreshold: 0,
        intervalSecs: 0,
        successThreshold: 0,
        timeoutSecs: 0,
    },
    description: "string",
    extId: "string",
    failureHandling: "string",
    metadatas: [{
        categoryIds: ["string"],
        ownerReferenceId: "string",
        ownerUserName: "string",
        projectName: "string",
        projectReferenceId: "string",
    }],
    name: "string",
    trafficForwardingMode: "string",
});

    type: nutanix:NetworkFunctionV2
properties:
    dataPlaneHealthCheckConfig:
        failureThreshold: 0
        intervalSecs: 0
        successThreshold: 0
        timeoutSecs: 0
    description: string
    extId: string
    failureHandling: string
    highAvailabilityMode: string
    metadatas:
        - categoryIds:
            - string
          ownerReferenceId: string
          ownerUserName: string
          projectName: string
          projectReferenceId: string
    name: string
    nicPairs:
        - dataPlaneHealthStatus: string
          egressNicReference: string
          highAvailabilityState: string
          ingressNicReference: string
          isEnabled: false
          vmReference: string
    trafficForwardingMode: string

    NetworkFunctionV2 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 NetworkFunctionV2 resource accepts the following input properties:

    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    NicPairs List<PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2NicPair>
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    DataPlaneHealthCheckConfig PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    Metadatas List<PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2Metadata>
    Metadata associated with this resource.
    Name string
    Name of the network function.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    NicPairs []NetworkFunctionV2NicPairArgs
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    DataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfigArgs
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    Metadatas []NetworkFunctionV2MetadataArgs
    Metadata associated with this resource.
    Name string
    Name of the network function.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    high_availability_mode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    nic_pairs list(object)
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    data_plane_health_check_config object
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    metadatas list(object)
    Metadata associated with this resource.
    name string
    Name of the network function.
    traffic_forwarding_mode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    nicPairs List<NetworkFunctionV2NicPair>
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    dataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    metadatas List<NetworkFunctionV2Metadata>
    Metadata associated with this resource.
    name String
    Name of the network function.
    trafficForwardingMode String
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    highAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    nicPairs NetworkFunctionV2NicPair[]
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    dataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    metadatas NetworkFunctionV2Metadata[]
    Metadata associated with this resource.
    name string
    Name of the network function.
    trafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    high_availability_mode str
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    nic_pairs Sequence[NetworkFunctionV2NicPairArgs]
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    data_plane_health_check_config NetworkFunctionV2DataPlaneHealthCheckConfigArgs
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    metadatas Sequence[NetworkFunctionV2MetadataArgs]
    Metadata associated with this resource.
    name str
    Name of the network function.
    traffic_forwarding_mode str
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    nicPairs List<Property Map>
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    dataPlaneHealthCheckConfig Property Map
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    metadatas List<Property Map>
    Metadata associated with this resource.
    name String
    Name of the network function.
    trafficForwardingMode String
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<PiersKarsenbarg.Nutanix.Outputs.NetworkFunctionV2Link>
    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.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []NetworkFunctionV2Link
    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.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    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.
    tenant_id string
    A globally unique identifier that represents the tenant that owns this entity.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<NetworkFunctionV2Link>
    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.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    id string
    The provider-assigned unique ID for this managed resource.
    links NetworkFunctionV2Link[]
    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.
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[NetworkFunctionV2Link]
    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.
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity.
    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.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.

    Look up Existing NetworkFunctionV2 Resource

    Get an existing NetworkFunctionV2 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?: NetworkFunctionV2State, opts?: CustomResourceOptions): NetworkFunctionV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_plane_health_check_config: Optional[NetworkFunctionV2DataPlaneHealthCheckConfigArgs] = None,
        description: Optional[str] = None,
        ext_id: Optional[str] = None,
        failure_handling: Optional[str] = None,
        high_availability_mode: Optional[str] = None,
        links: Optional[Sequence[NetworkFunctionV2LinkArgs]] = None,
        metadatas: Optional[Sequence[NetworkFunctionV2MetadataArgs]] = None,
        name: Optional[str] = None,
        nic_pairs: Optional[Sequence[NetworkFunctionV2NicPairArgs]] = None,
        tenant_id: Optional[str] = None,
        traffic_forwarding_mode: Optional[str] = None) -> NetworkFunctionV2
    func GetNetworkFunctionV2(ctx *Context, name string, id IDInput, state *NetworkFunctionV2State, opts ...ResourceOption) (*NetworkFunctionV2, error)
    public static NetworkFunctionV2 Get(string name, Input<string> id, NetworkFunctionV2State? state, CustomResourceOptions? opts = null)
    public static NetworkFunctionV2 get(String name, Output<String> id, NetworkFunctionV2State state, CustomResourceOptions options)
    resources:  _:    type: nutanix:NetworkFunctionV2    get:      id: ${id}
    import {
  to = nutanix_networkfunctionv2.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    DataPlaneHealthCheckConfig PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    Links List<PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2Link>
    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.Inputs.NetworkFunctionV2Metadata>
    Metadata associated with this resource.
    Name string
    Name of the network function.
    NicPairs List<PiersKarsenbarg.Nutanix.Inputs.NetworkFunctionV2NicPair>
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    DataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfigArgs
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    HighAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    Links []NetworkFunctionV2LinkArgs
    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 []NetworkFunctionV2MetadataArgs
    Metadata associated with this resource.
    Name string
    Name of the network function.
    NicPairs []NetworkFunctionV2NicPairArgs
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    TrafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    data_plane_health_check_config object
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    high_availability_mode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    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 all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    tenant_id string
    A globally unique identifier that represents the tenant that owns this entity.
    traffic_forwarding_mode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    dataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    links List<NetworkFunctionV2Link>
    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<NetworkFunctionV2Metadata>
    Metadata associated with this resource.
    name String
    Name of the network function.
    nicPairs List<NetworkFunctionV2NicPair>
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode String
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    dataPlaneHealthCheckConfig NetworkFunctionV2DataPlaneHealthCheckConfig
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    highAvailabilityMode string
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    links NetworkFunctionV2Link[]
    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 NetworkFunctionV2Metadata[]
    Metadata associated with this resource.
    name string
    Name of the network function.
    nicPairs NetworkFunctionV2NicPair[]
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode string
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    data_plane_health_check_config NetworkFunctionV2DataPlaneHealthCheckConfigArgs
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    high_availability_mode str
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    links Sequence[NetworkFunctionV2LinkArgs]
    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[NetworkFunctionV2MetadataArgs]
    Metadata associated with this resource.
    name str
    Name of the network function.
    nic_pairs Sequence[NetworkFunctionV2NicPairArgs]
    List of all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity.
    traffic_forwarding_mode str
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.
    dataPlaneHealthCheckConfig Property Map
    Data Plane Health check configuration applied for the network function.
    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:

    ValueDescription
    NO_ACTIONWhen network function is unhealthy, no action is taken and traffic is black-holed. This value is deprecated. If it continues to be used, it will automatically be converted to FAIL_CLOSE.
    FAIL_CLOSEWhen all the network function VM(s) are down, all traffic from sources is blocked to prevent it from bypassing the security.
    FAIL_OPENWhen all the network function VM(s) are down, traffic from sources can be forwarded directly to the destinations, effectively bypassing the network function VM.
    highAvailabilityMode String
    High availability configuration used between virtual NIC pairs. Traffic is only redirected to the ACTIVE NIC pair. Values:

    ValueDescription
    ACTIVE_PASSIVENIC pair is in ACTIVE_PASSIVE mode. In ACTIVE_PASSIVE mode, one of the NIC pairs will be selected as the ACTIVE network function and all other NIC pairs will be on STANDBY
    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 all NIC pairs part of this network function. Minimum 1 and maximum 2 NIC pairs are allowed.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    trafficForwardingMode String
    Traffic forwarding mode. Values:

    ValueDescription
    INLINEInline traffic redirection is applied through the network function VM to enable comprehensive inspection and policy enforcement.
    VTAPTraffic is passively mirrored to the network function VM for out-of-band monitoring, without affecting the original traffic flow. The failureHandling or dataPlaneHealthCheckConfig or egressNicReference inside any of NicPair is not supported along with this mode. API will fail as part of validation if passed with VTAP trafficForwardingMode.

    Supporting Types

    NetworkFunctionV2DataPlaneHealthCheckConfig, NetworkFunctionV2DataPlaneHealthCheckConfigArgs

    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.

    NetworkFunctionV2Metadata, NetworkFunctionV2MetadataArgs

    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.

    NetworkFunctionV2NicPair, NetworkFunctionV2NicPairArgs

    IngressNicReference string
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    IsEnabled bool
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    DataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    EgressNicReference string
    UUID of NIC which will be used as egress NIC.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    HighAvailabilityState string
    High availability state of the NIC pair. Values:
    VmReference string
    VM UUID which both ingress/egress NICs are part of.
    IngressNicReference string
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    IsEnabled bool
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    DataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    EgressNicReference string
    UUID of NIC which will be used as egress NIC.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    HighAvailabilityState string
    High availability state of the NIC pair. Values:
    VmReference string
    VM UUID which both ingress/egress NICs are part of.
    ingress_nic_reference string
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    is_enabled bool
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    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.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    high_availability_state string
    High availability state of the NIC pair. Values:
    vm_reference string
    VM UUID which both ingress/egress NICs are part of.
    ingressNicReference String
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    isEnabled Boolean
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    dataPlaneHealthStatus String
    Data plane health status of the NIC pair. Values:
    egressNicReference String
    UUID of NIC which will be used as egress NIC.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    highAvailabilityState String
    High availability state of the NIC pair. Values:
    vmReference String
    VM UUID which both ingress/egress NICs are part of.
    ingressNicReference string
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    isEnabled boolean
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    dataPlaneHealthStatus string
    Data plane health status of the NIC pair. Values:
    egressNicReference string
    UUID of NIC which will be used as egress NIC.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    highAvailabilityState string
    High availability state of the NIC pair. Values:
    vmReference string
    VM UUID which both ingress/egress NICs are part of.
    ingress_nic_reference str
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    is_enabled bool
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    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.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    high_availability_state str
    High availability state of the NIC pair. Values:
    vm_reference str
    VM UUID which both ingress/egress NICs are part of.
    ingressNicReference String
    UUID of NIC which will be used as ingress NIC.

    • The required UUID of the virtual NIC on the NFVM where traffic enters.
    • You must create a VM with a special "Network Function NIC" type and provide the UUID of that NIC here.
    • This tells the Nutanix platform which vNIC on your firewall VM to send the redirected traffic to.
    isEnabled Boolean
    Administrative state of the NIC pair.

    • A boolean flag to control the administrative state of the NIC pair.
    • Set to false to administratively disable this NIC pair, for instance, during a maintenance window.
    • If set to false, this NIC pair will not be considered for traffic redirection, even if it's healthy.
    • This provides a way to gracefully take a specific NFVM out of service without deleting the configuration.
    dataPlaneHealthStatus String
    Data plane health status of the NIC pair. Values:
    egressNicReference String
    UUID of NIC which will be used as egress NIC.

    • The optional UUID of the virtual NIC from which traffic exits the NFVM.
    • Specify the UUID of another Network Function NIC on the same VM.
    • In an inline model, traffic enters the ingressNic, is processed by the NFVM, and then sent out through the egressNic to its final destination.
    • This is not used in VTAP mode.
    highAvailabilityState String
    High availability state of the NIC pair. Values:
    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