Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
published on Tuesday, May 26, 2026 by Piers Karsenbarg
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
published on Tuesday, May 26, 2026 by Piers Karsenbarg
List Network Functions.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";
const nfs = nutanix.getNetworkFunctionsV2({
page: 0,
limit: 50,
filter: "name eq 'my-network-function'",
orderBy: "name",
});
import pulumi
import pulumi_nutanix as nutanix
nfs = nutanix.get_network_functions_v2(page=0,
limit=50,
filter="name eq 'my-network-function'",
order_by="name")
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.GetNetworkFunctionsV2(ctx, &nutanix.GetNetworkFunctionsV2Args{
Page: pulumi.IntRef(0),
Limit: pulumi.IntRef(50),
Filter: pulumi.StringRef("name eq 'my-network-function'"),
OrderBy: pulumi.StringRef("name"),
}, 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 nfs = Nutanix.GetNetworkFunctionsV2.Invoke(new()
{
Page = 0,
Limit = 50,
Filter = "name eq 'my-network-function'",
OrderBy = "name",
});
});
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.GetNetworkFunctionsV2Args;
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 nfs = NutanixFunctions.getNetworkFunctionsV2(GetNetworkFunctionsV2Args.builder()
.page(0)
.limit(50)
.filter("name eq 'my-network-function'")
.orderBy("name")
.build());
}
}
variables:
nfs:
fn::invoke:
function: nutanix:getNetworkFunctionsV2
arguments:
page: 0
limit: 50
filter: name eq 'my-network-function'
orderBy: name
pulumi {
required_providers {
nutanix = {
source = "pulumi/nutanix"
}
}
}
data "nutanix_getnetworkfunctionsv2" "nfs" {
page = 0
limit = 50
filter = "name eq 'my-network-function'"
order_by = "name"
}
Using getNetworkFunctionsV2
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 getNetworkFunctionsV2(args: GetNetworkFunctionsV2Args, opts?: InvokeOptions): Promise<GetNetworkFunctionsV2Result>
function getNetworkFunctionsV2Output(args: GetNetworkFunctionsV2OutputArgs, opts?: InvokeOptions): Output<GetNetworkFunctionsV2Result>def get_network_functions_v2(filter: Optional[str] = None,
limit: Optional[int] = None,
order_by: Optional[str] = None,
page: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> GetNetworkFunctionsV2Result
def get_network_functions_v2_output(filter: pulumi.Input[Optional[str]] = None,
limit: pulumi.Input[Optional[int]] = None,
order_by: pulumi.Input[Optional[str]] = None,
page: pulumi.Input[Optional[int]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNetworkFunctionsV2Result]func GetNetworkFunctionsV2(ctx *Context, args *GetNetworkFunctionsV2Args, opts ...InvokeOption) (*GetNetworkFunctionsV2Result, error)
func GetNetworkFunctionsV2Output(ctx *Context, args *GetNetworkFunctionsV2OutputArgs, opts ...InvokeOption) GetNetworkFunctionsV2ResultOutput> Note: This function is named GetNetworkFunctionsV2 in the Go SDK.
public static class GetNetworkFunctionsV2
{
public static Task<GetNetworkFunctionsV2Result> InvokeAsync(GetNetworkFunctionsV2Args args, InvokeOptions? opts = null)
public static Output<GetNetworkFunctionsV2Result> Invoke(GetNetworkFunctionsV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetNetworkFunctionsV2Result> getNetworkFunctionsV2(GetNetworkFunctionsV2Args args, InvokeOptions options)
public static Output<GetNetworkFunctionsV2Result> getNetworkFunctionsV2(GetNetworkFunctionsV2Args args, InvokeOptions options)
fn::invoke:
function: nutanix:index/getNetworkFunctionsV2:getNetworkFunctionsV2
arguments:
# arguments dictionarydata "nutanix_getnetworkfunctionsv2" "name" {
# arguments
}The following arguments are supported:
getNetworkFunctionsV2 Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Functions List<PiersKarsenbarg. Nutanix. Outputs. Get Network Functions V2Network Function> - List of network functions.
- Filter string
- Limit int
- Order
By string - Page int
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Functions []GetNetwork Functions V2Network Function - List of network functions.
- Filter string
- Limit int
- Order
By string - Page int
- id string
- The provider-assigned unique ID for this managed resource.
- network_
functions list(object) - List of network functions.
- filter string
- limit number
- order_
by string - page number
- id String
- The provider-assigned unique ID for this managed resource.
- network
Functions List<GetNetwork Functions V2Network Function> - List of network functions.
- filter String
- limit Integer
- order
By String - page Integer
- id string
- The provider-assigned unique ID for this managed resource.
- network
Functions GetNetwork Functions V2Network Function[] - List of network functions.
- filter string
- limit number
- order
By string - page number
- id str
- The provider-assigned unique ID for this managed resource.
- network_
functions Sequence[GetNetwork Functions V2Network Function] - List of network functions.
- filter str
- limit int
- order_
by str - page int
- id String
- The provider-assigned unique ID for this managed resource.
- network
Functions List<Property Map> - List of network functions.
- filter String
- limit Number
- order
By String - page Number
Supporting Types
GetNetworkFunctionsV2NetworkFunction
- Data
Plane List<PiersHealth Check Configs Karsenbarg. Nutanix. Inputs. Get Network Functions V2Network Function Data Plane Health Check Config> - 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 stringMode - High availability configuration used between virtual NIC pairs. Values:
- Links
List<Piers
Karsenbarg. Nutanix. Inputs. Get Network Functions V2Network Function Link> - 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<Piers
Karsenbarg. Nutanix. Inputs. Get Network Functions V2Network Function Metadata> - Metadata associated with this resource.
- Name string
- Name of the network function.
- Nic
Pairs List<PiersKarsenbarg. Nutanix. Inputs. Get Network Functions V2Network Function Nic Pair> - 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 stringMode - Traffic forwarding mode. Values:
- Data
Plane []GetHealth Check Configs Network Functions V2Network Function Data Plane Health Check Config - 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 stringMode - High availability configuration used between virtual NIC pairs. Values:
- Links
[]Get
Network Functions V2Network Function Link - 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
[]Get
Network Functions V2Network Function Metadata - Metadata associated with this resource.
- Name string
- Name of the network function.
- Nic
Pairs []GetNetwork Functions V2Network Function Nic Pair - 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 stringMode - Traffic forwarding mode. Values:
- data_
plane_ list(object)health_ check_ configs - 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_ stringmode - High availability configuration used between virtual NIC pairs. Values:
- 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_ stringmode - Traffic forwarding mode. Values:
- data
Plane List<GetHealth Check Configs Network Functions V2Network Function Data Plane Health Check Config> - 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 StringMode - High availability configuration used between virtual NIC pairs. Values:
- links
List<Get
Network Functions V2Network Function Link> - 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<Get
Network Functions V2Network Function Metadata> - Metadata associated with this resource.
- name String
- Name of the network function.
- nic
Pairs List<GetNetwork Functions V2Network Function Nic Pair> - 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 StringMode - Traffic forwarding mode. Values:
- data
Plane GetHealth Check Configs Network Functions V2Network Function Data Plane Health Check Config[] - 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 stringMode - High availability configuration used between virtual NIC pairs. Values:
- links
Get
Network Functions V2Network Function Link[] - 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
Get
Network Functions V2Network Function Metadata[] - Metadata associated with this resource.
- name string
- Name of the network function.
- nic
Pairs GetNetwork Functions V2Network Function Nic Pair[] - 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 stringMode - Traffic forwarding mode. Values:
- data_
plane_ Sequence[Gethealth_ check_ configs Network Functions V2Network Function Data Plane Health Check Config] - 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_ strmode - High availability configuration used between virtual NIC pairs. Values:
- links
Sequence[Get
Network Functions V2Network Function Link] - 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[Get
Network Functions V2Network Function Metadata] - Metadata associated with this resource.
- name str
- Name of the network function.
- nic_
pairs Sequence[GetNetwork Functions V2Network Function Nic Pair] - 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_ strmode - Traffic forwarding mode. Values:
- data
Plane List<Property Map>Health Check Configs - 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 StringMode - High availability configuration used between virtual NIC pairs. Values:
- 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.
- nic
Pairs List<Property Map> - 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 StringMode - Traffic forwarding mode. Values:
GetNetworkFunctionsV2NetworkFunctionDataPlaneHealthCheckConfig
- 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.
- 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.
- 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.
- failure
Threshold Integer Default: 3. The number of failure checks after which the target is considered unhealthy.- interval
Secs Integer Default: 5. Interval in seconds between health checks.- success
Threshold Integer Default: 3. The number of successful checks after which the target is considered healthy.- timeout
Secs Integer 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.
- 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.
- 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.
GetNetworkFunctionsV2NetworkFunctionLink
GetNetworkFunctionsV2NetworkFunctionMetadata
- Category
Ids List<string> - A list of globally unique identifiers that represent all the categories the resource is associated with.
- Owner
Reference stringId - A globally unique identifier that represents the owner of this resource.
- Owner
User stringName - The userName of the owner of this resource.
- Project
Name string - The name of the project this resource belongs to.
- Project
Reference stringId - A globally unique identifier that represents the project this resource belongs to.
- Category
Ids []string - A list of globally unique identifiers that represent all the categories the resource is associated with.
- Owner
Reference stringId - A globally unique identifier that represents the owner of this resource.
- Owner
User stringName - The userName of the owner of this resource.
- Project
Name string - The name of the project this resource belongs to.
- Project
Reference stringId - 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_ stringid - A globally unique identifier that represents the owner of this resource.
- owner_
user_ stringname - The userName of the owner of this resource.
- project_
name string - The name of the project this resource belongs to.
- project_
reference_ stringid - 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 StringId - A globally unique identifier that represents the owner of this resource.
- owner
User StringName - The userName of the owner of this resource.
- project
Name String - The name of the project this resource belongs to.
- project
Reference StringId - A globally unique identifier that represents the project this resource belongs to.
- category
Ids string[] - A list of globally unique identifiers that represent all the categories the resource is associated with.
- owner
Reference stringId - A globally unique identifier that represents the owner of this resource.
- owner
User stringName - The userName of the owner of this resource.
- project
Name string - The name of the project this resource belongs to.
- project
Reference stringId - 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_ strid - A globally unique identifier that represents the owner of this resource.
- owner_
user_ strname - The userName of the owner of this resource.
- project_
name str - The name of the project this resource belongs to.
- project_
reference_ strid - 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 StringId - A globally unique identifier that represents the owner of this resource.
- owner
User StringName - The userName of the owner of this resource.
- project
Name String - The name of the project this resource belongs to.
- project
Reference StringId - A globally unique identifier that represents the project this resource belongs to.
GetNetworkFunctionsV2NetworkFunctionNicPair
- Data
Plane stringHealth Status - Data plane health status of the NIC pair. Values:
- Egress
Nic stringReference - UUID of NIC which will be used as egress NIC.
- High
Availability stringState - High availability state of the NIC pair. Values:
- Ingress
Nic stringReference - 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.
- Data
Plane stringHealth Status - Data plane health status of the NIC pair. Values:
- Egress
Nic stringReference - UUID of NIC which will be used as egress NIC.
- High
Availability stringState - High availability state of the NIC pair. Values:
- Ingress
Nic stringReference - 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.
- data_
plane_ stringhealth_ status - Data plane health status of the NIC pair. Values:
- egress_
nic_ stringreference - UUID of NIC which will be used as egress NIC.
- high_
availability_ stringstate - High availability state of the NIC pair. Values:
- ingress_
nic_ stringreference - 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.
- data
Plane StringHealth Status - Data plane health status of the NIC pair. Values:
- egress
Nic StringReference - UUID of NIC which will be used as egress NIC.
- high
Availability StringState - High availability state of the NIC pair. Values:
- ingress
Nic StringReference - UUID of NIC which will be used as ingress NIC..
- is
Enabled 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.- vm
Reference String - VM UUID which both ingress/egress NICs are part of.
- data
Plane stringHealth Status - Data plane health status of the NIC pair. Values:
- egress
Nic stringReference - UUID of NIC which will be used as egress NIC.
- high
Availability stringState - High availability state of the NIC pair. Values:
- ingress
Nic stringReference - UUID of NIC which will be used as ingress NIC..
- is
Enabled 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.- vm
Reference string - VM UUID which both ingress/egress NICs are part of.
- data_
plane_ strhealth_ status - Data plane health status of the NIC pair. Values:
- egress_
nic_ strreference - UUID of NIC which will be used as egress NIC.
- high_
availability_ strstate - High availability state of the NIC pair. Values:
- ingress_
nic_ strreference - 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.
- data
Plane StringHealth Status - Data plane health status of the NIC pair. Values:
- egress
Nic StringReference - UUID of NIC which will be used as egress NIC.
- high
Availability StringState - High availability state of the NIC pair. Values:
- ingress
Nic StringReference - UUID of NIC which will be used as ingress NIC..
- is
Enabled 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.- vm
Reference 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
nutanixTerraform Provider.
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
published on Tuesday, May 26, 2026 by Piers Karsenbarg