Nutanix v0.7.4, Mar 21 25

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.getRouteV2

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

Example

TypeScript
Python
Go
C#
Java
YAML

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

const route_by_id = nutanix.getRouteV2({
    extId: "<route_uuid>",
    routeTableExtId: "<route_table_uuid>",
});

import pulumi
import pulumi_nutanix as nutanix

route_by_id = nutanix.get_route_v2(ext_id="<route_uuid>",
    route_table_ext_id="<route_table_uuid>")

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.GetRouteV2(ctx, &nutanix.GetRouteV2Args{
			ExtId:           "<route_uuid>",
			RouteTableExtId: "<route_table_uuid>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var route_by_id = Nutanix.GetRouteV2.Invoke(new()
    {
        ExtId = "<route_uuid>",
        RouteTableExtId = "<route_table_uuid>",
    });

});

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.GetRouteV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var route-by-id = NutanixFunctions.getRouteV2(GetRouteV2Args.builder()
            .extId("<route_uuid>")
            .routeTableExtId("<route_table_uuid>")
            .build());

    }
}

variables:
  route-by-id:
    fn::invoke:
      function: nutanix:getRouteV2
      arguments:
        extId: <route_uuid>
        routeTableExtId: <route_table_uuid>

Using getRouteV2

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.

TypeScript
Python
Go
C#
Java
YAML

function getRouteV2(args: GetRouteV2Args, opts?: InvokeOptions): Promise<GetRouteV2Result>
function getRouteV2Output(args: GetRouteV2OutputArgs, opts?: InvokeOptions): Output<GetRouteV2Result>

def get_route_v2(ext_id: Optional[str] = None,
                 route_table_ext_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRouteV2Result
def get_route_v2_output(ext_id: Optional[pulumi.Input[str]] = None,
                 route_table_ext_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRouteV2Result]

func GetRouteV2(ctx *Context, args *GetRouteV2Args, opts ...InvokeOption) (*GetRouteV2Result, error)
func GetRouteV2Output(ctx *Context, args *GetRouteV2OutputArgs, opts ...InvokeOption) GetRouteV2ResultOutput

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

public static class GetRouteV2 
{
    public static Task<GetRouteV2Result> InvokeAsync(GetRouteV2Args args, InvokeOptions? opts = null)
    public static Output<GetRouteV2Result> Invoke(GetRouteV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRouteV2Result> getRouteV2(GetRouteV2Args args, InvokeOptions options)
public static Output<GetRouteV2Result> getRouteV2(GetRouteV2Args args, InvokeOptions options)

fn::invoke:
  function: nutanix:index/getRouteV2:getRouteV2
  arguments:
    # arguments dictionary

The following arguments are supported:

ExtId string: Route UUID.
RouteTableExtId string: Route table UUID

ExtId string: Route UUID.
RouteTableExtId string: Route table UUID

extId String: Route UUID.
routeTableExtId String: Route table UUID

extId string: Route UUID.
routeTableExtId string: Route table UUID

ext_id str: Route UUID.
route_table_ext_id str: Route table UUID

extId String: Route UUID.
routeTableExtId String: Route table UUID

getRouteV2 Result

The following output properties are available:

Description string: BGP session description.
Destinations List<PiersKarsenbarg.Nutanix.Outputs.GetRouteV2Destination>: Destination IP Subnet Configuration.
ExtId string: Route UUID
ExternalRoutingDomainReference string: External routing domain associated with this route table.
Id string: The provider-assigned unique ID for this managed resource.
IsActive bool: Indicates whether the route is active in the forwarding plane.
Links List<PiersKarsenbarg.Nutanix.Outputs.GetRouteV2Link>: A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
Metadatas List<PiersKarsenbarg.Nutanix.Outputs.GetRouteV2Metadata>: Metadata associated with this resource.
Name string: Route name.
NextHops List<PiersKarsenbarg.Nutanix.Outputs.GetRouteV2NextHop>: Route nexthop.
Priority int: Route priority. A higher value implies greater preference is assigned to the route.
RouteTableExtId string
RouteTableReference string: Route table reference.
RouteType string: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
TenantId string: A globally unique identifier that represents the tenant that owns this entity
VpcReference string: VPC reference.

Description string: BGP session description.
Destinations []GetRouteV2Destination: Destination IP Subnet Configuration.
ExtId string: Route UUID
ExternalRoutingDomainReference string: External routing domain associated with this route table.
Id string: The provider-assigned unique ID for this managed resource.
IsActive bool: Indicates whether the route is active in the forwarding plane.
Links []GetRouteV2Link: 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 []GetRouteV2Metadata: Metadata associated with this resource.
Name string: Route name.
NextHops []GetRouteV2NextHop: Route nexthop.
Priority int: Route priority. A higher value implies greater preference is assigned to the route.
RouteTableExtId string
RouteTableReference string: Route table reference.
RouteType string: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
TenantId string: A globally unique identifier that represents the tenant that owns this entity
VpcReference string: VPC reference.

description String: BGP session description.
destinations List<GetRouteV2Destination>: Destination IP Subnet Configuration.
extId String: Route UUID
externalRoutingDomainReference String: External routing domain associated with this route table.
id String: The provider-assigned unique ID for this managed resource.
isActive Boolean: Indicates whether the route is active in the forwarding plane.
links List<GetRouteV2Link>: 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<GetRouteV2Metadata>: Metadata associated with this resource.
name String: Route name.
nextHops List<GetRouteV2NextHop>: Route nexthop.
priority Integer: Route priority. A higher value implies greater preference is assigned to the route.
routeTableExtId String
routeTableReference String: Route table reference.
routeType String: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
tenantId String: A globally unique identifier that represents the tenant that owns this entity
vpcReference String: VPC reference.

description string: BGP session description.
destinations GetRouteV2Destination[]: Destination IP Subnet Configuration.
extId string: Route UUID
externalRoutingDomainReference string: External routing domain associated with this route table.
id string: The provider-assigned unique ID for this managed resource.
isActive boolean: Indicates whether the route is active in the forwarding plane.
links GetRouteV2Link[]: 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 GetRouteV2Metadata[]: Metadata associated with this resource.
name string: Route name.
nextHops GetRouteV2NextHop[]: Route nexthop.
priority number: Route priority. A higher value implies greater preference is assigned to the route.
routeTableExtId string
routeTableReference string: Route table reference.
routeType string: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
tenantId string: A globally unique identifier that represents the tenant that owns this entity
vpcReference string: VPC reference.

description str: BGP session description.
destinations Sequence[GetRouteV2Destination]: Destination IP Subnet Configuration.
ext_id str: Route UUID
external_routing_domain_reference str: External routing domain associated with this route table.
id str: The provider-assigned unique ID for this managed resource.
is_active bool: Indicates whether the route is active in the forwarding plane.
links Sequence[GetRouteV2Link]: 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[GetRouteV2Metadata]: Metadata associated with this resource.
name str: Route name.
next_hops Sequence[GetRouteV2NextHop]: Route nexthop.
priority int: Route priority. A higher value implies greater preference is assigned to the route.
route_table_ext_id str
route_table_reference str: Route table reference.
route_type str: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
tenant_id str: A globally unique identifier that represents the tenant that owns this entity
vpc_reference str: VPC reference.

description String: BGP session description.
destinations List<Property Map>: Destination IP Subnet Configuration.
extId String: Route UUID
externalRoutingDomainReference String: External routing domain associated with this route table.
id String: The provider-assigned unique ID for this managed resource.
isActive Boolean: Indicates whether the route is active in the forwarding plane.
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: Route name.
nextHops List<Property Map>: Route nexthop.
priority Number: Route priority. A higher value implies greater preference is assigned to the route.
routeTableExtId String
routeTableReference String: Route table reference.
routeType String: Route type. Acceptable values are "STATIC", "LOCAL", "DYNAMIC"
tenantId String: A globally unique identifier that represents the tenant that owns this entity
vpcReference String: VPC reference.

Supporting Types

GetRouteV2Destination

Ipv4 PiersKarsenbarg.Nutanix.Inputs.GetRouteV2DestinationIpv4: IPv4 Address
Ipv6 PiersKarsenbarg.Nutanix.Inputs.GetRouteV2DestinationIpv6: IPv6 Address

Ipv4 GetRouteV2DestinationIpv4: IPv4 Address
Ipv6 GetRouteV2DestinationIpv6: IPv6 Address

ipv4 GetRouteV2DestinationIpv4: IPv4 Address
ipv6 GetRouteV2DestinationIpv6: IPv6 Address

ipv4 GetRouteV2DestinationIpv4: IPv4 Address
ipv6 GetRouteV2DestinationIpv6: IPv6 Address

ipv4 GetRouteV2DestinationIpv4: IPv4 Address
ipv6 GetRouteV2DestinationIpv6: IPv6 Address

ipv4 Property Map: IPv4 Address
ipv6 Property Map: IPv6 Address

GetRouteV2DestinationIpv4

Ip PiersKarsenbarg.Nutanix.Inputs.GetRouteV2DestinationIpv4Ip: An unique address that identifies a device on the internet or a local network in IPv4 format.
PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.

Ip GetRouteV2DestinationIpv4Ip: An unique address that identifies a device on the internet or a local network in IPv4 format.
PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.

ip GetRouteV2DestinationIpv4Ip: An unique address that identifies a device on the internet or a local network in IPv4 format.
prefixLength Integer: The prefix length of the network to which this host IPv4 address belongs.

ip GetRouteV2DestinationIpv4Ip: An unique address that identifies a device on the internet or a local network in IPv4 format.
prefixLength number: The prefix length of the network to which this host IPv4 address belongs.

ip GetRouteV2DestinationIpv4Ip: An unique address that identifies a device on the internet or a local network in IPv4 format.
prefix_length int: The prefix length of the network to which this host IPv4 address belongs.

ip Property Map: An unique address that identifies a device on the internet or a local network in IPv4 format.
prefixLength Number: The prefix length of the network to which this host IPv4 address belongs.

GetRouteV2DestinationIpv4Ip

PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.
Value string: The IPv4 address of the host.

PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.
Value string: The IPv4 address of the host.

prefixLength Integer: The prefix length of the network to which this host IPv4 address belongs.
value String: The IPv4 address of the host.

prefixLength number: The prefix length of the network to which this host IPv4 address belongs.
value string: The IPv4 address of the host.

prefix_length int: The prefix length of the network to which this host IPv4 address belongs.
value str: The IPv4 address of the host.

prefixLength Number: The prefix length of the network to which this host IPv4 address belongs.
value String: The IPv4 address of the host.

GetRouteV2DestinationIpv6

Ip PiersKarsenbarg.Nutanix.Inputs.GetRouteV2DestinationIpv6Ip: IP address format
PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.

Ip GetRouteV2DestinationIpv6Ip: IP address format
PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.

ip GetRouteV2DestinationIpv6Ip: IP address format
prefixLength Integer: The prefix length of the network to which this host IPv6 address belongs.

ip GetRouteV2DestinationIpv6Ip: IP address format
prefixLength number: The prefix length of the network to which this host IPv6 address belongs.

ip GetRouteV2DestinationIpv6Ip: IP address format
prefix_length int: The prefix length of the network to which this host IPv6 address belongs.

ip Property Map: IP address format
prefixLength Number: The prefix length of the network to which this host IPv6 address belongs.

GetRouteV2DestinationIpv6Ip

PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.
Value string: The IPv6 address of the host.

PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.
Value string: The IPv6 address of the host.

prefixLength Integer: The prefix length of the network to which this host IPv6 address belongs.
value String: The IPv6 address of the host.

prefixLength number: The prefix length of the network to which this host IPv6 address belongs.
value string: The IPv6 address of the host.

prefix_length int: The prefix length of the network to which this host IPv6 address belongs.
value str: The IPv6 address of the host.

prefixLength Number: The prefix length of the network to which this host IPv6 address belongs.
value String: The IPv6 address of the host.

GetRouteV2Link

Href string
Rel string

Href string
Rel string

href String
rel String

href string
rel string

href str
rel str

href String
rel String

GetRouteV2Metadata

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.

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.

GetRouteV2NextHop

NextHopIpAddresses List<PiersKarsenbarg.Nutanix.Inputs.GetRouteV2NextHopNextHopIpAddress>

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

NextHopName string

NextHopReference string

The reference to a link, such as a VPN connection or a subnet.

NextHopType string

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

NextHopIpAddresses []GetRouteV2NextHopNextHopIpAddress

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

NextHopName string

NextHopReference string

The reference to a link, such as a VPN connection or a subnet.

NextHopType string

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

nextHopIpAddresses List<GetRouteV2NextHopNextHopIpAddress>

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

nextHopName String

nextHopReference String

The reference to a link, such as a VPN connection or a subnet.

nextHopType String

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

nextHopIpAddresses GetRouteV2NextHopNextHopIpAddress[]

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

nextHopName string

nextHopReference string

The reference to a link, such as a VPN connection or a subnet.

nextHopType string

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

next_hop_ip_addresses Sequence[GetRouteV2NextHopNextHopIpAddress]

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

next_hop_name str

next_hop_reference str

The reference to a link, such as a VPN connection or a subnet.

next_hop_type str

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

nextHopIpAddresses List<Property Map>

An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.

nextHopName String

nextHopReference String

The reference to a link, such as a VPN connection or a subnet.

nextHopType String

Nexthop type.

supported values:
LOCAL_SUBNET: - Next hop is an internal subnet.
DIRECT_CONNECT_VIF: - Next hop is a direct connect VIF.
VPN_CONNECTION: - Next hop is a VPN connection.
IP_ADDRESS: - Next hop is an IP address.
EXTERNAL_SUBNET: - Next hop is an external subnet.

GetRouteV2NextHopNextHopIpAddress

Ipv4 PiersKarsenbarg.Nutanix.Inputs.GetRouteV2NextHopNextHopIpAddressIpv4: IPv4 Address
Ipv6 PiersKarsenbarg.Nutanix.Inputs.GetRouteV2NextHopNextHopIpAddressIpv6: IPv6 Address

Ipv4 GetRouteV2NextHopNextHopIpAddressIpv4: IPv4 Address
Ipv6 GetRouteV2NextHopNextHopIpAddressIpv6: IPv6 Address

ipv4 GetRouteV2NextHopNextHopIpAddressIpv4: IPv4 Address
ipv6 GetRouteV2NextHopNextHopIpAddressIpv6: IPv6 Address

ipv4 GetRouteV2NextHopNextHopIpAddressIpv4: IPv4 Address
ipv6 GetRouteV2NextHopNextHopIpAddressIpv6: IPv6 Address

ipv4 GetRouteV2NextHopNextHopIpAddressIpv4: IPv4 Address
ipv6 GetRouteV2NextHopNextHopIpAddressIpv6: IPv6 Address

ipv4 Property Map: IPv4 Address
ipv6 Property Map: IPv6 Address

GetRouteV2NextHopNextHopIpAddressIpv4

PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.
Value string: value of IP address

PrefixLength int: The prefix length of the network to which this host IPv4 address belongs.
Value string: value of IP address

prefixLength Integer: The prefix length of the network to which this host IPv4 address belongs.
value String: value of IP address

prefixLength number: The prefix length of the network to which this host IPv4 address belongs.
value string: value of IP address

prefix_length int: The prefix length of the network to which this host IPv4 address belongs.
value str: value of IP address

prefixLength Number: The prefix length of the network to which this host IPv4 address belongs.
value String: value of IP address

GetRouteV2NextHopNextHopIpAddressIpv6

PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.
Value string: value of IP address

PrefixLength int: The prefix length of the network to which this host IPv6 address belongs.
Value string: value of IP address

prefixLength Integer: The prefix length of the network to which this host IPv6 address belongs.
value String: value of IP address

prefixLength number: The prefix length of the network to which this host IPv6 address belongs.
value string: value of IP address

prefix_length int: The prefix length of the network to which this host IPv6 address belongs.
value str: value of IP address

prefixLength Number: The prefix length of the network to which this host IPv6 address belongs.
value String: value of IP address

Package Details

Repository: nutanix pierskarsenbarg/pulumi-nutanix
License: Apache-2.0
Notes: This Pulumi package is based on the nutanix Terraform Provider.

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

pierskarsenbarg/pulumi-nutanix

nutanix.getRouteV2

On this page

On this page

Example

Using getRouteV2

getRouteV2 Result

Supporting Types

GetRouteV2Destination

GetRouteV2DestinationIpv4

GetRouteV2DestinationIpv4Ip

GetRouteV2DestinationIpv6

GetRouteV2DestinationIpv6Ip

GetRouteV2Link

GetRouteV2Metadata

GetRouteV2NextHop

GetRouteV2NextHopNextHopIpAddress

GetRouteV2NextHopNextHopIpAddressIpv4

GetRouteV2NextHopNextHopIpAddressIpv6

Package Details

On this page

On this page