Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
Supported in provider v3.5+ and VCD 10.2+ with NSX-T and ALB.
Provides a data source to read ALB Pools for particular NSX-T Edge Gateway. Pools maintain the list of servers assigned to them and perform health monitoring, load balancing, persistence. A pool may only be used or referenced by only one virtual service at a time.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";
const existing = vcd.getNsxtEdgegateway({
org: "my-org",
vdc: "nsxt-vdc",
name: "nsxt-gw",
});
const test = vcd.getNsxtAlbPool({
org: "my-org",
edgeGatewayId: vcd_nsxt_alb_settings.existing.edge_gateway_id,
name: "existing-alb-pool-1",
});
import pulumi
import pulumi_vcd as vcd
existing = vcd.get_nsxt_edgegateway(org="my-org",
vdc="nsxt-vdc",
name="nsxt-gw")
test = vcd.get_nsxt_alb_pool(org="my-org",
edge_gateway_id=vcd_nsxt_alb_settings["existing"]["edge_gateway_id"],
name="existing-alb-pool-1")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vcd.LookupNsxtEdgegateway(ctx, &vcd.LookupNsxtEdgegatewayArgs{
Org: pulumi.StringRef("my-org"),
Vdc: pulumi.StringRef("nsxt-vdc"),
Name: "nsxt-gw",
}, nil)
if err != nil {
return err
}
_, err = vcd.LookupNsxtAlbPool(ctx, &vcd.LookupNsxtAlbPoolArgs{
Org: pulumi.StringRef("my-org"),
EdgeGatewayId: vcd_nsxt_alb_settings.Existing.Edge_gateway_id,
Name: "existing-alb-pool-1",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;
return await Deployment.RunAsync(() =>
{
var existing = Vcd.GetNsxtEdgegateway.Invoke(new()
{
Org = "my-org",
Vdc = "nsxt-vdc",
Name = "nsxt-gw",
});
var test = Vcd.GetNsxtAlbPool.Invoke(new()
{
Org = "my-org",
EdgeGatewayId = vcd_nsxt_alb_settings.Existing.Edge_gateway_id,
Name = "existing-alb-pool-1",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetNsxtEdgegatewayArgs;
import com.pulumi.vcd.inputs.GetNsxtAlbPoolArgs;
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 existing = VcdFunctions.getNsxtEdgegateway(GetNsxtEdgegatewayArgs.builder()
.org("my-org")
.vdc("nsxt-vdc")
.name("nsxt-gw")
.build());
final var test = VcdFunctions.getNsxtAlbPool(GetNsxtAlbPoolArgs.builder()
.org("my-org")
.edgeGatewayId(vcd_nsxt_alb_settings.existing().edge_gateway_id())
.name("existing-alb-pool-1")
.build());
}
}
variables:
existing:
fn::invoke:
function: vcd:getNsxtEdgegateway
arguments:
org: my-org
vdc: nsxt-vdc
name: nsxt-gw
test:
fn::invoke:
function: vcd:getNsxtAlbPool
arguments:
org: my-org
edgeGatewayId: ${vcd_nsxt_alb_settings.existing.edge_gateway_id}
name: existing-alb-pool-1
Using getNsxtAlbPool
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 getNsxtAlbPool(args: GetNsxtAlbPoolArgs, opts?: InvokeOptions): Promise<GetNsxtAlbPoolResult>
function getNsxtAlbPoolOutput(args: GetNsxtAlbPoolOutputArgs, opts?: InvokeOptions): Output<GetNsxtAlbPoolResult>def get_nsxt_alb_pool(associated_virtual_service_ids: Optional[Sequence[str]] = None,
edge_gateway_id: Optional[str] = None,
id: Optional[str] = None,
name: Optional[str] = None,
org: Optional[str] = None,
passive_monitoring_enabled: Optional[bool] = None,
vdc: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNsxtAlbPoolResult
def get_nsxt_alb_pool_output(associated_virtual_service_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
edge_gateway_id: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
org: Optional[pulumi.Input[str]] = None,
passive_monitoring_enabled: Optional[pulumi.Input[bool]] = None,
vdc: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNsxtAlbPoolResult]func LookupNsxtAlbPool(ctx *Context, args *LookupNsxtAlbPoolArgs, opts ...InvokeOption) (*LookupNsxtAlbPoolResult, error)
func LookupNsxtAlbPoolOutput(ctx *Context, args *LookupNsxtAlbPoolOutputArgs, opts ...InvokeOption) LookupNsxtAlbPoolResultOutput> Note: This function is named LookupNsxtAlbPool in the Go SDK.
public static class GetNsxtAlbPool
{
public static Task<GetNsxtAlbPoolResult> InvokeAsync(GetNsxtAlbPoolArgs args, InvokeOptions? opts = null)
public static Output<GetNsxtAlbPoolResult> Invoke(GetNsxtAlbPoolInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetNsxtAlbPoolResult> getNsxtAlbPool(GetNsxtAlbPoolArgs args, InvokeOptions options)
public static Output<GetNsxtAlbPoolResult> getNsxtAlbPool(GetNsxtAlbPoolArgs args, InvokeOptions options)
fn::invoke:
function: vcd:index/getNsxtAlbPool:getNsxtAlbPool
arguments:
# arguments dictionaryThe following arguments are supported:
- Edge
Gateway stringId - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- Name string
- Name of existing ALB Pool.
- Associated
Virtual List<string>Service Ids - Id string
- Org string
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- Passive
Monitoring boolEnabled - Vdc string
- Edge
Gateway stringId - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- Name string
- Name of existing ALB Pool.
- Associated
Virtual []stringService Ids - Id string
- Org string
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- Passive
Monitoring boolEnabled - Vdc string
- edge
Gateway StringId - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- name String
- Name of existing ALB Pool.
- associated
Virtual List<String>Service Ids - id String
- org String
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- passive
Monitoring BooleanEnabled - vdc String
- edge
Gateway stringId - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- name string
- Name of existing ALB Pool.
- associated
Virtual string[]Service Ids - id string
- org string
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- passive
Monitoring booleanEnabled - vdc string
- edge_
gateway_ strid - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- name str
- Name of existing ALB Pool.
- associated_
virtual_ Sequence[str]service_ ids - id str
- org str
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- passive_
monitoring_ boolenabled - vdc str
- edge
Gateway StringId - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
- name String
- Name of existing ALB Pool.
- associated
Virtual List<String>Service Ids - id String
- org String
- The name of organization to which the edge gateway belongs. Optional if defined at provider level.
- passive
Monitoring BooleanEnabled - vdc String
getNsxtAlbPool Result
The following output properties are available:
- Algorithm string
- Associated
Virtual List<string>Services - Ca
Certificate List<string>Ids - Cn
Check boolEnabled - Default
Port double - Description string
- Domain
Names List<string> - Edge
Gateway stringId - Enabled bool
- Enabled
Member doubleCount - Graceful
Timeout doublePeriod - Health
Message string - Health
Monitors List<GetNsxt Alb Pool Health Monitor> - Id string
- Member
Count double - Member
Group stringId - Members
List<Get
Nsxt Alb Pool Member> - Name string
- Persistence
Profiles List<GetNsxt Alb Pool Persistence Profile> - Ssl
Enabled bool - Up
Member doubleCount - Vdc string
- Associated
Virtual List<string>Service Ids - Org string
- Passive
Monitoring boolEnabled
- Algorithm string
- Associated
Virtual []stringServices - Ca
Certificate []stringIds - Cn
Check boolEnabled - Default
Port float64 - Description string
- Domain
Names []string - Edge
Gateway stringId - Enabled bool
- Enabled
Member float64Count - Graceful
Timeout float64Period - Health
Message string - Health
Monitors []GetNsxt Alb Pool Health Monitor - Id string
- Member
Count float64 - Member
Group stringId - Members
[]Get
Nsxt Alb Pool Member - Name string
- Persistence
Profiles []GetNsxt Alb Pool Persistence Profile - Ssl
Enabled bool - Up
Member float64Count - Vdc string
- Associated
Virtual []stringService Ids - Org string
- Passive
Monitoring boolEnabled
- algorithm String
- associated
Virtual List<String>Services - ca
Certificate List<String>Ids - cn
Check BooleanEnabled - default
Port Double - description String
- domain
Names List<String> - edge
Gateway StringId - enabled Boolean
- enabled
Member DoubleCount - graceful
Timeout DoublePeriod - health
Message String - health
Monitors List<GetNsxt Alb Pool Health Monitor> - id String
- member
Count Double - member
Group StringId - members
List<Get
Nsxt Alb Pool Member> - name String
- persistence
Profiles List<GetNsxt Alb Pool Persistence Profile> - ssl
Enabled Boolean - up
Member DoubleCount - vdc String
- associated
Virtual List<String>Service Ids - org String
- passive
Monitoring BooleanEnabled
- algorithm string
- associated
Virtual string[]Services - ca
Certificate string[]Ids - cn
Check booleanEnabled - default
Port number - description string
- domain
Names string[] - edge
Gateway stringId - enabled boolean
- enabled
Member numberCount - graceful
Timeout numberPeriod - health
Message string - health
Monitors GetNsxt Alb Pool Health Monitor[] - id string
- member
Count number - member
Group stringId - members
Get
Nsxt Alb Pool Member[] - name string
- persistence
Profiles GetNsxt Alb Pool Persistence Profile[] - ssl
Enabled boolean - up
Member numberCount - vdc string
- associated
Virtual string[]Service Ids - org string
- passive
Monitoring booleanEnabled
- algorithm str
- associated_
virtual_ Sequence[str]services - ca_
certificate_ Sequence[str]ids - cn_
check_ boolenabled - default_
port float - description str
- domain_
names Sequence[str] - edge_
gateway_ strid - enabled bool
- enabled_
member_ floatcount - graceful_
timeout_ floatperiod - health_
message str - health_
monitors Sequence[GetNsxt Alb Pool Health Monitor] - id str
- member_
count float - member_
group_ strid - members
Sequence[Get
Nsxt Alb Pool Member] - name str
- persistence_
profiles Sequence[GetNsxt Alb Pool Persistence Profile] - ssl_
enabled bool - up_
member_ floatcount - vdc str
- associated_
virtual_ Sequence[str]service_ ids - org str
- passive_
monitoring_ boolenabled
- algorithm String
- associated
Virtual List<String>Services - ca
Certificate List<String>Ids - cn
Check BooleanEnabled - default
Port Number - description String
- domain
Names List<String> - edge
Gateway StringId - enabled Boolean
- enabled
Member NumberCount - graceful
Timeout NumberPeriod - health
Message String - health
Monitors List<Property Map> - id String
- member
Count Number - member
Group StringId - members List<Property Map>
- name String
- persistence
Profiles List<Property Map> - ssl
Enabled Boolean - up
Member NumberCount - vdc String
- associated
Virtual List<String>Service Ids - org String
- passive
Monitoring BooleanEnabled
Supporting Types
GetNsxtAlbPoolHealthMonitor
- Name string
- Name of existing ALB Pool.
- System
Defined bool - Type string
- Name string
- Name of existing ALB Pool.
- System
Defined bool - Type string
- name String
- Name of existing ALB Pool.
- system
Defined Boolean - type String
- name string
- Name of existing ALB Pool.
- system
Defined boolean - type string
- name str
- Name of existing ALB Pool.
- system_
defined bool - type str
- name String
- Name of existing ALB Pool.
- system
Defined Boolean - type String
GetNsxtAlbPoolMember
- Detailed
Health stringMessage - Enabled bool
- Health
Status string - Ip
Address string - Marked
Down List<string>Bies - Port double
- Ratio double
- Detailed
Health stringMessage - Enabled bool
- Health
Status string - Ip
Address string - Marked
Down []stringBies - Port float64
- Ratio float64
- detailed
Health StringMessage - enabled Boolean
- health
Status String - ip
Address String - marked
Down List<String>Bies - port Double
- ratio Double
- detailed
Health stringMessage - enabled boolean
- health
Status string - ip
Address string - marked
Down string[]Bies - port number
- ratio number
- detailed_
health_ strmessage - enabled bool
- health_
status str - ip_
address str - marked_
down_ Sequence[str]bies - port float
- ratio float
- detailed
Health StringMessage - enabled Boolean
- health
Status String - ip
Address String - marked
Down List<String>Bies - port Number
- ratio Number
GetNsxtAlbPoolPersistenceProfile
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcdTerraform Provider.
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
