1. Packages
  2. Avi Provider
  3. API Docs
  4. getPoolgroup
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getPoolgroup

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

    <!–

    Copyright 2021 VMware, Inc.
    SPDX-License-Identifier: Mozilla Public License 2.0
    

    –>

    layout: “avi”

    page_title: “AVI: avi.Poolgroup” sidebar_current: “docs-avi-datasource-poolgroup” description: |- Get information of Avi PoolGroup.

    avi.Poolgroup

    This data source is used to to get avi.Poolgroup objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const fooPoolgroup = avi.getPoolgroup({
        cloudRef: "/api/cloud/?tenant=admin&name=Default-Cloud",
        name: "foo",
        uuid: "poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });
    
    import pulumi
    import pulumi_avi as avi
    
    foo_poolgroup = avi.get_poolgroup(cloud_ref="/api/cloud/?tenant=admin&name=Default-Cloud",
        name="foo",
        uuid="poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avi.LookupPoolgroup(ctx, &avi.LookupPoolgroupArgs{
    			CloudRef: pulumi.StringRef("/api/cloud/?tenant=admin&name=Default-Cloud"),
    			Name:     pulumi.StringRef("foo"),
    			Uuid:     pulumi.StringRef("poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Avi = Pulumi.Avi;
    
    return await Deployment.RunAsync(() => 
    {
        var fooPoolgroup = Avi.GetPoolgroup.Invoke(new()
        {
            CloudRef = "/api/cloud/?tenant=admin&name=Default-Cloud",
            Name = "foo",
            Uuid = "poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.AviFunctions;
    import com.pulumi.avi.inputs.GetPoolgroupArgs;
    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 fooPoolgroup = AviFunctions.getPoolgroup(GetPoolgroupArgs.builder()
                .cloudRef("/api/cloud/?tenant=admin&name=Default-Cloud")
                .name("foo")
                .uuid("poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
                .build());
    
        }
    }
    
    variables:
      fooPoolgroup:
        fn::invoke:
          function: avi:getPoolgroup
          arguments:
            cloudRef: /api/cloud/?tenant=admin&name=Default-Cloud
            name: foo
            uuid: poolgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b
    

    Using getPoolgroup

    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 getPoolgroup(args: GetPoolgroupArgs, opts?: InvokeOptions): Promise<GetPoolgroupResult>
    function getPoolgroupOutput(args: GetPoolgroupOutputArgs, opts?: InvokeOptions): Output<GetPoolgroupResult>
    def get_poolgroup(cloud_ref: Optional[str] = None,
                      id: Optional[str] = None,
                      name: Optional[str] = None,
                      tenant_ref: Optional[str] = None,
                      uuid: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPoolgroupResult
    def get_poolgroup_output(cloud_ref: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      tenant_ref: Optional[pulumi.Input[str]] = None,
                      uuid: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPoolgroupResult]
    func LookupPoolgroup(ctx *Context, args *LookupPoolgroupArgs, opts ...InvokeOption) (*LookupPoolgroupResult, error)
    func LookupPoolgroupOutput(ctx *Context, args *LookupPoolgroupOutputArgs, opts ...InvokeOption) LookupPoolgroupResultOutput

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

    public static class GetPoolgroup 
    {
        public static Task<GetPoolgroupResult> InvokeAsync(GetPoolgroupArgs args, InvokeOptions? opts = null)
        public static Output<GetPoolgroupResult> Invoke(GetPoolgroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPoolgroupResult> getPoolgroup(GetPoolgroupArgs args, InvokeOptions options)
    public static Output<GetPoolgroupResult> getPoolgroup(GetPoolgroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: avi:index/getPoolgroup:getPoolgroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CloudRef string
    Search PoolGroup by cloud_ref.
    Id string
    Name string
    Search PoolGroup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PoolGroup by uuid.
    CloudRef string
    Search PoolGroup by cloud_ref.
    Id string
    Name string
    Search PoolGroup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PoolGroup by uuid.
    cloudRef String
    Search PoolGroup by cloud_ref.
    id String
    name String
    Search PoolGroup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PoolGroup by uuid.
    cloudRef string
    Search PoolGroup by cloud_ref.
    id string
    name string
    Search PoolGroup by name.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search PoolGroup by uuid.
    cloud_ref str
    Search PoolGroup by cloud_ref.
    id str
    name str
    Search PoolGroup by name.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search PoolGroup by uuid.
    cloudRef String
    Search PoolGroup by cloud_ref.
    id String
    name String
    Search PoolGroup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PoolGroup by uuid.

    getPoolgroup Result

    The following output properties are available:

    CloudConfigCksum string
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GetPoolgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeactivatePrimaryPoolOnDown string
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    DeploymentPolicyRef string
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    Description string
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions List<GetPoolgroupFailAction>
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    Id string
    ImplicitPriorityLabels string
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers List<GetPoolgroupMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Members List<GetPoolgroupMember>
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MinServers string
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    Name string
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PriorityLabelsRef string
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudConfigCksum string
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GetPoolgroupConfigpbAttribute
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeactivatePrimaryPoolOnDown string
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    DeploymentPolicyRef string
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    Description string
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions []GetPoolgroupFailAction
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    Id string
    ImplicitPriorityLabels string
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers []GetPoolgroupMarker
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Members []GetPoolgroupMember
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MinServers string
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    Name string
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PriorityLabelsRef string
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudConfigCksum String
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GetPoolgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deactivatePrimaryPoolOnDown String
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    deploymentPolicyRef String
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    description String
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<GetPoolgroupFailAction>
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    id String
    implicitPriorityLabels String
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<GetPoolgroupMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    members List<GetPoolgroupMember>
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minServers String
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    name String
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    priorityLabelsRef String
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudConfigCksum string
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GetPoolgroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deactivatePrimaryPoolOnDown string
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    deploymentPolicyRef string
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    description string
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions GetPoolgroupFailAction[]
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    id string
    implicitPriorityLabels string
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers GetPoolgroupMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    members GetPoolgroupMember[]
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minServers string
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    name string
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    priorityLabelsRef string
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    serviceMetadata string
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloud_config_cksum str
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloud_ref str
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GetPoolgroupConfigpbAttribute]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deactivate_primary_pool_on_down str
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    deployment_policy_ref str
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    description str
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fail_actions Sequence[GetPoolgroupFailAction]
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    id str
    implicit_priority_labels str
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers Sequence[GetPoolgroupMarker]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    members Sequence[GetPoolgroupMember]
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    min_servers str
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    name str
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    priority_labels_ref str
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    service_metadata str
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudConfigCksum String
    Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deactivatePrimaryPoolOnDown String
    Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    deploymentPolicyRef String
    When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    description String
    Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<Property Map>
    Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
    id String
    implicitPriorityLabels String
    Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    members List<Property Map>
    List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minServers String
    The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    name String
    The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    priorityLabelsRef String
    Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    GetPoolgroupConfigpbAttribute

    Version string
    Version string
    version String
    version string
    version String

    GetPoolgroupFailAction

    GetPoolgroupFailActionLocalRsp

    GetPoolgroupFailActionLocalRspFile

    GetPoolgroupFailActionRedirect

    Host string
    Path string
    Protocol string
    Query string
    StatusCode string
    Host string
    Path string
    Protocol string
    Query string
    StatusCode string
    host String
    path String
    protocol String
    query String
    statusCode String
    host string
    path string
    protocol string
    query string
    statusCode string
    host String
    path String
    protocol String
    query String
    statusCode String

    GetPoolgroupMarker

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    GetPoolgroupMember

    DeploymentState string
    PoolRef string
    PriorityLabel string
    Ratio string
    DeploymentState string
    PoolRef string
    PriorityLabel string
    Ratio string
    deploymentState String
    poolRef String
    priorityLabel String
    ratio String
    deploymentState string
    poolRef string
    priorityLabel string
    ratio string
    deploymentState String
    poolRef String
    priorityLabel String
    ratio String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware