1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyEdgeNode
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.getPolicyEdgeNode

Explore with Pulumi AI

This data source provides information about policy edge nodes configured on NSX.

This data source is applicable to NSX Global Manager and NSX Policy Manager.

Example Usage

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

const ec = nsxt.getPolicyEdgeCluster({
    displayName: "ec",
});
const node1 = ec.then(ec => nsxt.getPolicyEdgeNode({
    edgeClusterPath: ec.path,
    memberIndex: 0,
}));
Copy
import pulumi
import pulumi_nsxt as nsxt

ec = nsxt.get_policy_edge_cluster(display_name="ec")
node1 = nsxt.get_policy_edge_node(edge_cluster_path=ec.path,
    member_index=0)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ec, err := nsxt.GetPolicyEdgeCluster(ctx, &nsxt.GetPolicyEdgeClusterArgs{
			DisplayName: pulumi.StringRef("ec"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nsxt.GetPolicyEdgeNode(ctx, &nsxt.GetPolicyEdgeNodeArgs{
			EdgeClusterPath: ec.Path,
			MemberIndex:     pulumi.Float64Ref(0),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var ec = Nsxt.GetPolicyEdgeCluster.Invoke(new()
    {
        DisplayName = "ec",
    });

    var node1 = Nsxt.GetPolicyEdgeNode.Invoke(new()
    {
        EdgeClusterPath = ec.Apply(getPolicyEdgeClusterResult => getPolicyEdgeClusterResult.Path),
        MemberIndex = 0,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetPolicyEdgeClusterArgs;
import com.pulumi.nsxt.inputs.GetPolicyEdgeNodeArgs;
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 ec = NsxtFunctions.getPolicyEdgeCluster(GetPolicyEdgeClusterArgs.builder()
            .displayName("ec")
            .build());

        final var node1 = NsxtFunctions.getPolicyEdgeNode(GetPolicyEdgeNodeArgs.builder()
            .edgeClusterPath(ec.applyValue(getPolicyEdgeClusterResult -> getPolicyEdgeClusterResult.path()))
            .memberIndex(0)
            .build());

    }
}
Copy
variables:
  ec:
    fn::invoke:
      function: nsxt:getPolicyEdgeCluster
      arguments:
        displayName: ec
  node1:
    fn::invoke:
      function: nsxt:getPolicyEdgeNode
      arguments:
        edgeClusterPath: ${ec.path}
        memberIndex: 0
Copy

Using getPolicyEdgeNode

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 getPolicyEdgeNode(args: GetPolicyEdgeNodeArgs, opts?: InvokeOptions): Promise<GetPolicyEdgeNodeResult>
function getPolicyEdgeNodeOutput(args: GetPolicyEdgeNodeOutputArgs, opts?: InvokeOptions): Output<GetPolicyEdgeNodeResult>
Copy
def get_policy_edge_node(description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         edge_cluster_path: Optional[str] = None,
                         id: Optional[str] = None,
                         member_index: Optional[float] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPolicyEdgeNodeResult
def get_policy_edge_node_output(description: Optional[pulumi.Input[str]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         edge_cluster_path: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         member_index: Optional[pulumi.Input[float]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPolicyEdgeNodeResult]
Copy
func GetPolicyEdgeNode(ctx *Context, args *GetPolicyEdgeNodeArgs, opts ...InvokeOption) (*GetPolicyEdgeNodeResult, error)
func GetPolicyEdgeNodeOutput(ctx *Context, args *GetPolicyEdgeNodeOutputArgs, opts ...InvokeOption) GetPolicyEdgeNodeResultOutput
Copy

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

public static class GetPolicyEdgeNode 
{
    public static Task<GetPolicyEdgeNodeResult> InvokeAsync(GetPolicyEdgeNodeArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyEdgeNodeResult> Invoke(GetPolicyEdgeNodeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPolicyEdgeNodeResult> getPolicyEdgeNode(GetPolicyEdgeNodeArgs args, InvokeOptions options)
public static Output<GetPolicyEdgeNodeResult> getPolicyEdgeNode(GetPolicyEdgeNodeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getPolicyEdgeNode:getPolicyEdgeNode
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EdgeClusterPath This property is required. string
The path of edge cluster where to which this node belongs.
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the edge node to retrieve.
Id string
The ID of the edge node to retrieve.
MemberIndex double
Member index of the node in edge cluster.
EdgeClusterPath This property is required. string
The path of edge cluster where to which this node belongs.
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the edge node to retrieve.
Id string
The ID of the edge node to retrieve.
MemberIndex float64
Member index of the node in edge cluster.
edgeClusterPath This property is required. String
The path of edge cluster where to which this node belongs.
description String
The description of the resource.
displayName String
The Display Name prefix of the edge node to retrieve.
id String
The ID of the edge node to retrieve.
memberIndex Double
Member index of the node in edge cluster.
edgeClusterPath This property is required. string
The path of edge cluster where to which this node belongs.
description string
The description of the resource.
displayName string
The Display Name prefix of the edge node to retrieve.
id string
The ID of the edge node to retrieve.
memberIndex number
Member index of the node in edge cluster.
edge_cluster_path This property is required. str
The path of edge cluster where to which this node belongs.
description str
The description of the resource.
display_name str
The Display Name prefix of the edge node to retrieve.
id str
The ID of the edge node to retrieve.
member_index float
Member index of the node in edge cluster.
edgeClusterPath This property is required. String
The path of edge cluster where to which this node belongs.
description String
The description of the resource.
displayName String
The Display Name prefix of the edge node to retrieve.
id String
The ID of the edge node to retrieve.
memberIndex Number
Member index of the node in edge cluster.

getPolicyEdgeNode Result

The following output properties are available:

Description string
The description of the resource.
DisplayName string
EdgeClusterPath string
Id string
Path string
The NSX path of the policy resource.
MemberIndex double
Description string
The description of the resource.
DisplayName string
EdgeClusterPath string
Id string
Path string
The NSX path of the policy resource.
MemberIndex float64
description String
The description of the resource.
displayName String
edgeClusterPath String
id String
path String
The NSX path of the policy resource.
memberIndex Double
description string
The description of the resource.
displayName string
edgeClusterPath string
id string
path string
The NSX path of the policy resource.
memberIndex number
description str
The description of the resource.
display_name str
edge_cluster_path str
id str
path str
The NSX path of the policy resource.
member_index float
description String
The description of the resource.
displayName String
edgeClusterPath String
id String
path String
The NSX path of the policy resource.
memberIndex Number

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.