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

avi.Gslbservice

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.Gslbservice” sidebar_current: “docs-avi-resource-gslbservice” description: |- Creates and manages Avi GslbService.

    avi.Gslbservice

    The GslbService resource allows the creation and management of Avi GslbService

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const foo = new avi.Gslbservice("foo", {tenantRef: "/api/tenant/?name=admin"});
    
    import pulumi
    import pulumi_avi as avi
    
    foo = avi.Gslbservice("foo", tenant_ref="/api/tenant/?name=admin")
    
    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.NewGslbservice(ctx, "foo", &avi.GslbserviceArgs{
    			TenantRef: pulumi.String("/api/tenant/?name=admin"),
    		})
    		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 foo = new Avi.Gslbservice("foo", new()
        {
            TenantRef = "/api/tenant/?name=admin",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.Gslbservice;
    import com.pulumi.avi.GslbserviceArgs;
    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) {
            var foo = new Gslbservice("foo", GslbserviceArgs.builder()
                .tenantRef("/api/tenant/?name=admin")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: avi:Gslbservice
        properties:
          tenantRef: /api/tenant/?name=admin
    

    Create Gslbservice Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gslbservice(name: string, args: GslbserviceArgs, opts?: CustomResourceOptions);
    @overload
    def Gslbservice(resource_name: str,
                    args: GslbserviceArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Gslbservice(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_names: Optional[Sequence[str]] = None,
                    groups: Optional[Sequence[GslbserviceGroupArgs]] = None,
                    is_federated: Optional[str] = None,
                    record_type: Optional[str] = None,
                    description: Optional[str] = None,
                    controller_health_status_enabled: Optional[str] = None,
                    down_responses: Optional[Sequence[GslbserviceDownResponseArgs]] = None,
                    enabled: Optional[str] = None,
                    configpb_attributes: Optional[Sequence[GslbserviceConfigpbAttributeArgs]] = None,
                    gslbservice_id: Optional[str] = None,
                    health_monitor_refs: Optional[Sequence[str]] = None,
                    health_monitor_scope: Optional[str] = None,
                    hm_off: Optional[str] = None,
                    include_additional_records: Optional[str] = None,
                    application_persistence_profile_ref: Optional[str] = None,
                    markers: Optional[Sequence[GslbserviceMarkerArgs]] = None,
                    created_by: Optional[str] = None,
                    num_dns_ip: Optional[str] = None,
                    min_members: Optional[str] = None,
                    pki_profile_ref: Optional[str] = None,
                    pool_algorithm: Optional[str] = None,
                    name: Optional[str] = None,
                    resolve_cname: Optional[str] = None,
                    site_persistence_enabled: Optional[str] = None,
                    tenant_ref: Optional[str] = None,
                    topology_policy_enabled: Optional[str] = None,
                    ttl: Optional[str] = None,
                    use_edns_client_subnet: Optional[str] = None,
                    uuid: Optional[str] = None,
                    vrf_uuid_for_gs: Optional[str] = None,
                    wildcard_match: Optional[str] = None)
    func NewGslbservice(ctx *Context, name string, args GslbserviceArgs, opts ...ResourceOption) (*Gslbservice, error)
    public Gslbservice(string name, GslbserviceArgs args, CustomResourceOptions? opts = null)
    public Gslbservice(String name, GslbserviceArgs args)
    public Gslbservice(String name, GslbserviceArgs args, CustomResourceOptions options)
    
    type: avi:Gslbservice
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GslbserviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GslbserviceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GslbserviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GslbserviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GslbserviceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gslbserviceResource = new Avi.Gslbservice("gslbserviceResource", new()
    {
        DomainNames = new[]
        {
            "string",
        },
        Groups = new[]
        {
            new Avi.Inputs.GslbserviceGroupArgs
            {
                Members = new[]
                {
                    new Avi.Inputs.GslbserviceGroupMemberArgs
                    {
                        CloudUuid = "string",
                        ClusterUuid = "string",
                        Description = "string",
                        Enabled = "string",
                        Fqdn = "string",
                        Hostname = "string",
                        Ips = new[]
                        {
                            new Avi.Inputs.GslbserviceGroupMemberIpArgs
                            {
                                Addr = "string",
                                Type = "string",
                            },
                        },
                        Locations = new[]
                        {
                            new Avi.Inputs.GslbserviceGroupMemberLocationArgs
                            {
                                Source = "string",
                                Locations = new[]
                                {
                                    new Avi.Inputs.GslbserviceGroupMemberLocationLocationArgs
                                    {
                                        Latitude = "string",
                                        Longitude = "string",
                                        Name = "string",
                                        Tag = "string",
                                    },
                                },
                            },
                        },
                        PreferenceOrder = "string",
                        PublicIps = new[]
                        {
                            new Avi.Inputs.GslbserviceGroupMemberPublicIpArgs
                            {
                                Ips = new[]
                                {
                                    new Avi.Inputs.GslbserviceGroupMemberPublicIpIpArgs
                                    {
                                        Addr = "string",
                                        Type = "string",
                                    },
                                },
                            },
                        },
                        Ratio = "string",
                        ResolveFqdnToV6 = "string",
                        SrvRdatas = new[]
                        {
                            new Avi.Inputs.GslbserviceGroupMemberSrvRdataArgs
                            {
                                Port = "string",
                                Priority = "string",
                                Weight = "string",
                            },
                        },
                        VsUuid = "string",
                    },
                },
                Name = "string",
                Algorithm = "string",
                ConsistentHashMask = "string",
                ConsistentHashMask6 = "string",
                Description = "string",
                Enabled = "string",
                FallbackAlgorithm = "string",
                ManualResume = "string",
                MinHealthMonitorsUp = "string",
                Priority = "string",
            },
        },
        IsFederated = "string",
        RecordType = "string",
        Description = "string",
        ControllerHealthStatusEnabled = "string",
        DownResponses = new[]
        {
            new Avi.Inputs.GslbserviceDownResponseArgs
            {
                FallbackCname = "string",
                FallbackIp6s = new[]
                {
                    new Avi.Inputs.GslbserviceDownResponseFallbackIp6Args
                    {
                        Addr = "string",
                        Type = "string",
                    },
                },
                FallbackIps = new[]
                {
                    new Avi.Inputs.GslbserviceDownResponseFallbackIpArgs
                    {
                        Addr = "string",
                        Type = "string",
                    },
                },
                Type = "string",
            },
        },
        Enabled = "string",
        ConfigpbAttributes = new[]
        {
            new Avi.Inputs.GslbserviceConfigpbAttributeArgs
            {
                Version = "string",
            },
        },
        GslbserviceId = "string",
        HealthMonitorRefs = new[]
        {
            "string",
        },
        HealthMonitorScope = "string",
        HmOff = "string",
        IncludeAdditionalRecords = "string",
        ApplicationPersistenceProfileRef = "string",
        Markers = new[]
        {
            new Avi.Inputs.GslbserviceMarkerArgs
            {
                Key = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        CreatedBy = "string",
        NumDnsIp = "string",
        MinMembers = "string",
        PkiProfileRef = "string",
        PoolAlgorithm = "string",
        Name = "string",
        ResolveCname = "string",
        SitePersistenceEnabled = "string",
        TenantRef = "string",
        TopologyPolicyEnabled = "string",
        Ttl = "string",
        UseEdnsClientSubnet = "string",
        Uuid = "string",
        VrfUuidForGs = "string",
        WildcardMatch = "string",
    });
    
    example, err := avi.NewGslbservice(ctx, "gslbserviceResource", &avi.GslbserviceArgs{
    	DomainNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Groups: avi.GslbserviceGroupArray{
    		&avi.GslbserviceGroupArgs{
    			Members: avi.GslbserviceGroupMemberArray{
    				&avi.GslbserviceGroupMemberArgs{
    					CloudUuid:   pulumi.String("string"),
    					ClusterUuid: pulumi.String("string"),
    					Description: pulumi.String("string"),
    					Enabled:     pulumi.String("string"),
    					Fqdn:        pulumi.String("string"),
    					Hostname:    pulumi.String("string"),
    					Ips: avi.GslbserviceGroupMemberIpArray{
    						&avi.GslbserviceGroupMemberIpArgs{
    							Addr: pulumi.String("string"),
    							Type: pulumi.String("string"),
    						},
    					},
    					Locations: avi.GslbserviceGroupMemberLocationArray{
    						&avi.GslbserviceGroupMemberLocationArgs{
    							Source: pulumi.String("string"),
    							Locations: avi.GslbserviceGroupMemberLocationLocationArray{
    								&avi.GslbserviceGroupMemberLocationLocationArgs{
    									Latitude:  pulumi.String("string"),
    									Longitude: pulumi.String("string"),
    									Name:      pulumi.String("string"),
    									Tag:       pulumi.String("string"),
    								},
    							},
    						},
    					},
    					PreferenceOrder: pulumi.String("string"),
    					PublicIps: avi.GslbserviceGroupMemberPublicIpArray{
    						&avi.GslbserviceGroupMemberPublicIpArgs{
    							Ips: avi.GslbserviceGroupMemberPublicIpIpArray{
    								&avi.GslbserviceGroupMemberPublicIpIpArgs{
    									Addr: pulumi.String("string"),
    									Type: pulumi.String("string"),
    								},
    							},
    						},
    					},
    					Ratio:           pulumi.String("string"),
    					ResolveFqdnToV6: pulumi.String("string"),
    					SrvRdatas: avi.GslbserviceGroupMemberSrvRdataArray{
    						&avi.GslbserviceGroupMemberSrvRdataArgs{
    							Port:     pulumi.String("string"),
    							Priority: pulumi.String("string"),
    							Weight:   pulumi.String("string"),
    						},
    					},
    					VsUuid: pulumi.String("string"),
    				},
    			},
    			Name:                pulumi.String("string"),
    			Algorithm:           pulumi.String("string"),
    			ConsistentHashMask:  pulumi.String("string"),
    			ConsistentHashMask6: pulumi.String("string"),
    			Description:         pulumi.String("string"),
    			Enabled:             pulumi.String("string"),
    			FallbackAlgorithm:   pulumi.String("string"),
    			ManualResume:        pulumi.String("string"),
    			MinHealthMonitorsUp: pulumi.String("string"),
    			Priority:            pulumi.String("string"),
    		},
    	},
    	IsFederated:                   pulumi.String("string"),
    	RecordType:                    pulumi.String("string"),
    	Description:                   pulumi.String("string"),
    	ControllerHealthStatusEnabled: pulumi.String("string"),
    	DownResponses: avi.GslbserviceDownResponseArray{
    		&avi.GslbserviceDownResponseArgs{
    			FallbackCname: pulumi.String("string"),
    			FallbackIp6s: avi.GslbserviceDownResponseFallbackIp6Array{
    				&avi.GslbserviceDownResponseFallbackIp6Args{
    					Addr: pulumi.String("string"),
    					Type: pulumi.String("string"),
    				},
    			},
    			FallbackIps: avi.GslbserviceDownResponseFallbackIpArray{
    				&avi.GslbserviceDownResponseFallbackIpArgs{
    					Addr: pulumi.String("string"),
    					Type: pulumi.String("string"),
    				},
    			},
    			Type: pulumi.String("string"),
    		},
    	},
    	Enabled: pulumi.String("string"),
    	ConfigpbAttributes: avi.GslbserviceConfigpbAttributeArray{
    		&avi.GslbserviceConfigpbAttributeArgs{
    			Version: pulumi.String("string"),
    		},
    	},
    	GslbserviceId: pulumi.String("string"),
    	HealthMonitorRefs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	HealthMonitorScope:               pulumi.String("string"),
    	HmOff:                            pulumi.String("string"),
    	IncludeAdditionalRecords:         pulumi.String("string"),
    	ApplicationPersistenceProfileRef: pulumi.String("string"),
    	Markers: avi.GslbserviceMarkerArray{
    		&avi.GslbserviceMarkerArgs{
    			Key: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	CreatedBy:              pulumi.String("string"),
    	NumDnsIp:               pulumi.String("string"),
    	MinMembers:             pulumi.String("string"),
    	PkiProfileRef:          pulumi.String("string"),
    	PoolAlgorithm:          pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	ResolveCname:           pulumi.String("string"),
    	SitePersistenceEnabled: pulumi.String("string"),
    	TenantRef:              pulumi.String("string"),
    	TopologyPolicyEnabled:  pulumi.String("string"),
    	Ttl:                    pulumi.String("string"),
    	UseEdnsClientSubnet:    pulumi.String("string"),
    	Uuid:                   pulumi.String("string"),
    	VrfUuidForGs:           pulumi.String("string"),
    	WildcardMatch:          pulumi.String("string"),
    })
    
    var gslbserviceResource = new Gslbservice("gslbserviceResource", GslbserviceArgs.builder()
        .domainNames("string")
        .groups(GslbserviceGroupArgs.builder()
            .members(GslbserviceGroupMemberArgs.builder()
                .cloudUuid("string")
                .clusterUuid("string")
                .description("string")
                .enabled("string")
                .fqdn("string")
                .hostname("string")
                .ips(GslbserviceGroupMemberIpArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .locations(GslbserviceGroupMemberLocationArgs.builder()
                    .source("string")
                    .locations(GslbserviceGroupMemberLocationLocationArgs.builder()
                        .latitude("string")
                        .longitude("string")
                        .name("string")
                        .tag("string")
                        .build())
                    .build())
                .preferenceOrder("string")
                .publicIps(GslbserviceGroupMemberPublicIpArgs.builder()
                    .ips(GslbserviceGroupMemberPublicIpIpArgs.builder()
                        .addr("string")
                        .type("string")
                        .build())
                    .build())
                .ratio("string")
                .resolveFqdnToV6("string")
                .srvRdatas(GslbserviceGroupMemberSrvRdataArgs.builder()
                    .port("string")
                    .priority("string")
                    .weight("string")
                    .build())
                .vsUuid("string")
                .build())
            .name("string")
            .algorithm("string")
            .consistentHashMask("string")
            .consistentHashMask6("string")
            .description("string")
            .enabled("string")
            .fallbackAlgorithm("string")
            .manualResume("string")
            .minHealthMonitorsUp("string")
            .priority("string")
            .build())
        .isFederated("string")
        .recordType("string")
        .description("string")
        .controllerHealthStatusEnabled("string")
        .downResponses(GslbserviceDownResponseArgs.builder()
            .fallbackCname("string")
            .fallbackIp6s(GslbserviceDownResponseFallbackIp6Args.builder()
                .addr("string")
                .type("string")
                .build())
            .fallbackIps(GslbserviceDownResponseFallbackIpArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .type("string")
            .build())
        .enabled("string")
        .configpbAttributes(GslbserviceConfigpbAttributeArgs.builder()
            .version("string")
            .build())
        .gslbserviceId("string")
        .healthMonitorRefs("string")
        .healthMonitorScope("string")
        .hmOff("string")
        .includeAdditionalRecords("string")
        .applicationPersistenceProfileRef("string")
        .markers(GslbserviceMarkerArgs.builder()
            .key("string")
            .values("string")
            .build())
        .createdBy("string")
        .numDnsIp("string")
        .minMembers("string")
        .pkiProfileRef("string")
        .poolAlgorithm("string")
        .name("string")
        .resolveCname("string")
        .sitePersistenceEnabled("string")
        .tenantRef("string")
        .topologyPolicyEnabled("string")
        .ttl("string")
        .useEdnsClientSubnet("string")
        .uuid("string")
        .vrfUuidForGs("string")
        .wildcardMatch("string")
        .build());
    
    gslbservice_resource = avi.Gslbservice("gslbserviceResource",
        domain_names=["string"],
        groups=[{
            "members": [{
                "cloud_uuid": "string",
                "cluster_uuid": "string",
                "description": "string",
                "enabled": "string",
                "fqdn": "string",
                "hostname": "string",
                "ips": [{
                    "addr": "string",
                    "type": "string",
                }],
                "locations": [{
                    "source": "string",
                    "locations": [{
                        "latitude": "string",
                        "longitude": "string",
                        "name": "string",
                        "tag": "string",
                    }],
                }],
                "preference_order": "string",
                "public_ips": [{
                    "ips": [{
                        "addr": "string",
                        "type": "string",
                    }],
                }],
                "ratio": "string",
                "resolve_fqdn_to_v6": "string",
                "srv_rdatas": [{
                    "port": "string",
                    "priority": "string",
                    "weight": "string",
                }],
                "vs_uuid": "string",
            }],
            "name": "string",
            "algorithm": "string",
            "consistent_hash_mask": "string",
            "consistent_hash_mask6": "string",
            "description": "string",
            "enabled": "string",
            "fallback_algorithm": "string",
            "manual_resume": "string",
            "min_health_monitors_up": "string",
            "priority": "string",
        }],
        is_federated="string",
        record_type="string",
        description="string",
        controller_health_status_enabled="string",
        down_responses=[{
            "fallback_cname": "string",
            "fallback_ip6s": [{
                "addr": "string",
                "type": "string",
            }],
            "fallback_ips": [{
                "addr": "string",
                "type": "string",
            }],
            "type": "string",
        }],
        enabled="string",
        configpb_attributes=[{
            "version": "string",
        }],
        gslbservice_id="string",
        health_monitor_refs=["string"],
        health_monitor_scope="string",
        hm_off="string",
        include_additional_records="string",
        application_persistence_profile_ref="string",
        markers=[{
            "key": "string",
            "values": ["string"],
        }],
        created_by="string",
        num_dns_ip="string",
        min_members="string",
        pki_profile_ref="string",
        pool_algorithm="string",
        name="string",
        resolve_cname="string",
        site_persistence_enabled="string",
        tenant_ref="string",
        topology_policy_enabled="string",
        ttl="string",
        use_edns_client_subnet="string",
        uuid="string",
        vrf_uuid_for_gs="string",
        wildcard_match="string")
    
    const gslbserviceResource = new avi.Gslbservice("gslbserviceResource", {
        domainNames: ["string"],
        groups: [{
            members: [{
                cloudUuid: "string",
                clusterUuid: "string",
                description: "string",
                enabled: "string",
                fqdn: "string",
                hostname: "string",
                ips: [{
                    addr: "string",
                    type: "string",
                }],
                locations: [{
                    source: "string",
                    locations: [{
                        latitude: "string",
                        longitude: "string",
                        name: "string",
                        tag: "string",
                    }],
                }],
                preferenceOrder: "string",
                publicIps: [{
                    ips: [{
                        addr: "string",
                        type: "string",
                    }],
                }],
                ratio: "string",
                resolveFqdnToV6: "string",
                srvRdatas: [{
                    port: "string",
                    priority: "string",
                    weight: "string",
                }],
                vsUuid: "string",
            }],
            name: "string",
            algorithm: "string",
            consistentHashMask: "string",
            consistentHashMask6: "string",
            description: "string",
            enabled: "string",
            fallbackAlgorithm: "string",
            manualResume: "string",
            minHealthMonitorsUp: "string",
            priority: "string",
        }],
        isFederated: "string",
        recordType: "string",
        description: "string",
        controllerHealthStatusEnabled: "string",
        downResponses: [{
            fallbackCname: "string",
            fallbackIp6s: [{
                addr: "string",
                type: "string",
            }],
            fallbackIps: [{
                addr: "string",
                type: "string",
            }],
            type: "string",
        }],
        enabled: "string",
        configpbAttributes: [{
            version: "string",
        }],
        gslbserviceId: "string",
        healthMonitorRefs: ["string"],
        healthMonitorScope: "string",
        hmOff: "string",
        includeAdditionalRecords: "string",
        applicationPersistenceProfileRef: "string",
        markers: [{
            key: "string",
            values: ["string"],
        }],
        createdBy: "string",
        numDnsIp: "string",
        minMembers: "string",
        pkiProfileRef: "string",
        poolAlgorithm: "string",
        name: "string",
        resolveCname: "string",
        sitePersistenceEnabled: "string",
        tenantRef: "string",
        topologyPolicyEnabled: "string",
        ttl: "string",
        useEdnsClientSubnet: "string",
        uuid: "string",
        vrfUuidForGs: "string",
        wildcardMatch: "string",
    });
    
    type: avi:Gslbservice
    properties:
        applicationPersistenceProfileRef: string
        configpbAttributes:
            - version: string
        controllerHealthStatusEnabled: string
        createdBy: string
        description: string
        domainNames:
            - string
        downResponses:
            - fallbackCname: string
              fallbackIp6s:
                - addr: string
                  type: string
              fallbackIps:
                - addr: string
                  type: string
              type: string
        enabled: string
        groups:
            - algorithm: string
              consistentHashMask: string
              consistentHashMask6: string
              description: string
              enabled: string
              fallbackAlgorithm: string
              manualResume: string
              members:
                - cloudUuid: string
                  clusterUuid: string
                  description: string
                  enabled: string
                  fqdn: string
                  hostname: string
                  ips:
                    - addr: string
                      type: string
                  locations:
                    - locations:
                        - latitude: string
                          longitude: string
                          name: string
                          tag: string
                      source: string
                  preferenceOrder: string
                  publicIps:
                    - ips:
                        - addr: string
                          type: string
                  ratio: string
                  resolveFqdnToV6: string
                  srvRdatas:
                    - port: string
                      priority: string
                      weight: string
                  vsUuid: string
              minHealthMonitorsUp: string
              name: string
              priority: string
        gslbserviceId: string
        healthMonitorRefs:
            - string
        healthMonitorScope: string
        hmOff: string
        includeAdditionalRecords: string
        isFederated: string
        markers:
            - key: string
              values:
                - string
        minMembers: string
        name: string
        numDnsIp: string
        pkiProfileRef: string
        poolAlgorithm: string
        recordType: string
        resolveCname: string
        sitePersistenceEnabled: string
        tenantRef: string
        topologyPolicyEnabled: string
        ttl: string
        useEdnsClientSubnet: string
        uuid: string
        vrfUuidForGs: string
        wildcardMatch: string
    

    Gslbservice Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Gslbservice resource accepts the following input properties:

    DomainNames List<string>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Groups List<GslbserviceGroup>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ApplicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GslbserviceConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DownResponses List<GslbserviceDownResponse>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GslbserviceId string
    HealthMonitorRefs List<string>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HealthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IncludeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    IsFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers List<GslbserviceMarker>
    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.
    MinMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    PoolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RecordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ResolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    TopologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames []string
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Groups []GslbserviceGroupArgs
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ApplicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GslbserviceConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DownResponses []GslbserviceDownResponseArgs
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GslbserviceId string
    HealthMonitorRefs []string
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HealthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IncludeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    IsFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers []GslbserviceMarkerArgs
    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.
    MinMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    PoolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RecordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ResolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    TopologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups List<GslbserviceGroup>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef String
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GslbserviceConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerHealthStatusEnabled String
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses List<GslbserviceDownResponse>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId String
    healthMonitorRefs List<String>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope String
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff String
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords String
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated String
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<GslbserviceMarker>
    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.
    minMembers String
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp String
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm String
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType String
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname String
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled String
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled String
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl String
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet String
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs String
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch String
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames string[]
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups GslbserviceGroup[]
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GslbserviceConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses GslbserviceDownResponse[]
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId string
    healthMonitorRefs string[]
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers GslbserviceMarker[]
    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.
    minMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domain_names Sequence[str]
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups Sequence[GslbserviceGroupArgs]
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    application_persistence_profile_ref str
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GslbserviceConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controller_health_status_enabled str
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    down_responses Sequence[GslbserviceDownResponseArgs]
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbservice_id str
    health_monitor_refs Sequence[str]
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    health_monitor_scope str
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hm_off str
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    include_additional_records str
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    is_federated str
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers Sequence[GslbserviceMarkerArgs]
    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.
    min_members str
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    num_dns_ip str
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pki_profile_ref str
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    pool_algorithm str
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    record_type str
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolve_cname str
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    site_persistence_enabled str
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topology_policy_enabled str
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl str
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    use_edns_client_subnet str
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrf_uuid_for_gs str
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcard_match str
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups List<Property Map>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef String
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. 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.
    controllerHealthStatusEnabled String
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses List<Property Map>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId String
    healthMonitorRefs List<String>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope String
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff String
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords String
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated String
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.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.
    minMembers String
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp String
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm String
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType String
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname String
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled String
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled String
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl String
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet String
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs String
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch String
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Gslbservice resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Gslbservice Resource

    Get an existing Gslbservice resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GslbserviceState, opts?: CustomResourceOptions): Gslbservice
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_persistence_profile_ref: Optional[str] = None,
            configpb_attributes: Optional[Sequence[GslbserviceConfigpbAttributeArgs]] = None,
            controller_health_status_enabled: Optional[str] = None,
            created_by: Optional[str] = None,
            description: Optional[str] = None,
            domain_names: Optional[Sequence[str]] = None,
            down_responses: Optional[Sequence[GslbserviceDownResponseArgs]] = None,
            enabled: Optional[str] = None,
            groups: Optional[Sequence[GslbserviceGroupArgs]] = None,
            gslbservice_id: Optional[str] = None,
            health_monitor_refs: Optional[Sequence[str]] = None,
            health_monitor_scope: Optional[str] = None,
            hm_off: Optional[str] = None,
            include_additional_records: Optional[str] = None,
            is_federated: Optional[str] = None,
            markers: Optional[Sequence[GslbserviceMarkerArgs]] = None,
            min_members: Optional[str] = None,
            name: Optional[str] = None,
            num_dns_ip: Optional[str] = None,
            pki_profile_ref: Optional[str] = None,
            pool_algorithm: Optional[str] = None,
            record_type: Optional[str] = None,
            resolve_cname: Optional[str] = None,
            site_persistence_enabled: Optional[str] = None,
            tenant_ref: Optional[str] = None,
            topology_policy_enabled: Optional[str] = None,
            ttl: Optional[str] = None,
            use_edns_client_subnet: Optional[str] = None,
            uuid: Optional[str] = None,
            vrf_uuid_for_gs: Optional[str] = None,
            wildcard_match: Optional[str] = None) -> Gslbservice
    func GetGslbservice(ctx *Context, name string, id IDInput, state *GslbserviceState, opts ...ResourceOption) (*Gslbservice, error)
    public static Gslbservice Get(string name, Input<string> id, GslbserviceState? state, CustomResourceOptions? opts = null)
    public static Gslbservice get(String name, Output<String> id, GslbserviceState state, CustomResourceOptions options)
    resources:  _:    type: avi:Gslbservice    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GslbserviceConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames List<string>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DownResponses List<GslbserviceDownResponse>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Groups List<GslbserviceGroup>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GslbserviceId string
    HealthMonitorRefs List<string>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HealthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IncludeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    IsFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers List<GslbserviceMarker>
    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.
    MinMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    PoolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RecordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ResolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    TopologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ApplicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GslbserviceConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames []string
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DownResponses []GslbserviceDownResponseArgs
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Groups []GslbserviceGroupArgs
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GslbserviceId string
    HealthMonitorRefs []string
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HealthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IncludeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    IsFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers []GslbserviceMarkerArgs
    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.
    MinMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    PoolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RecordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ResolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    TopologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef String
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GslbserviceConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerHealthStatusEnabled String
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses List<GslbserviceDownResponse>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups List<GslbserviceGroup>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId String
    healthMonitorRefs List<String>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope String
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff String
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords String
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated String
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<GslbserviceMarker>
    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.
    minMembers String
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp String
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm String
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType String
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname String
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled String
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled String
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl String
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet String
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs String
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch String
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef string
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GslbserviceConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerHealthStatusEnabled string
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames string[]
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses GslbserviceDownResponse[]
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups GslbserviceGroup[]
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId string
    healthMonitorRefs string[]
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope string
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff string
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords string
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated string
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers GslbserviceMarker[]
    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.
    minMembers string
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp string
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef string
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm string
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType string
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname string
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled string
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled string
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl string
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet string
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs string
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch string
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    application_persistence_profile_ref str
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GslbserviceConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controller_health_status_enabled str
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domain_names Sequence[str]
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    down_responses Sequence[GslbserviceDownResponseArgs]
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups Sequence[GslbserviceGroupArgs]
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbservice_id str
    health_monitor_refs Sequence[str]
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    health_monitor_scope str
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hm_off str
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    include_additional_records str
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    is_federated str
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers Sequence[GslbserviceMarkerArgs]
    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.
    min_members str
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    num_dns_ip str
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pki_profile_ref str
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    pool_algorithm str
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    record_type str
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolve_cname str
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    site_persistence_enabled str
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topology_policy_enabled str
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl str
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    use_edns_client_subnet str
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrf_uuid_for_gs str
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcard_match str
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    applicationPersistenceProfileRef String
    The federated application persistence associated with gslbservice site persistence functionality. It is a reference to an object of type applicationpersistenceprofile. Field introduced in 17.2.1. 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.
    controllerHealthStatusEnabled String
    Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Fully qualified domain name of the gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    downResponses List<Property Map>
    Response to the client query when the gslb service is down. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    groups List<Property Map>
    Select list of pools belonging to this gslb service. Minimum of 1 items required. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gslbserviceId String
    healthMonitorRefs List<String>
    Verify vs health by applying one or more health monitors. Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response. It is a reference to an object of type healthmonitor. Maximum of 6 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    healthMonitorScope String
    Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hmOff String
    This field is an internal field and is used in se. Field introduced in 18.2.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    includeAdditionalRecords String
    If enabled, provide the srv target's resolved ip in the response srv gslb service. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    isFederated String
    This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.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.
    minMembers String
    The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numDnsIp String
    Number of ip addresses of this gslb service to be returned by the dns service. Enter 0 to return all ip addresses. Allowed values are 1-20. Special values are 0- return all ip addresses. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Pki profile associated with the gslb service. It is a reference to an object of type pkiprofile. Field introduced in 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    poolAlgorithm String
    The load balancing algorithm will pick a gslb pool within the gslb service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    recordType String
    Field to specify the type of gslb service. Enum options - GSLB_SERVICE_RECORD_TYPE_A_AAAA_CNAME, GSLB_SERVICE_RECORD_TYPE_SRV. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    resolveCname String
    This field indicates that for a cname query, respond with resolved cnames in the additional section with a records. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sitePersistenceEnabled String
    Enable site-persistence for the gslbservice. Field introduced in 17.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.
    topologyPolicyEnabled String
    When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ttl String
    Ttl value (in seconds) for records served for this gslb service by the dns service. Allowed values are 0-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useEdnsClientSubnet String
    Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfUuidForGs String
    Vrf name of the dns vs to which this gs is bound to. In case it is bound to multiple dns vses on the se, this field will be inherited from the first dns vs in the configuration order. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    wildcardMatch String
    Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns request. Default is false. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    GslbserviceConfigpbAttribute, GslbserviceConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version String

    GslbserviceDownResponse, GslbserviceDownResponseArgs

    GslbserviceDownResponseFallbackIp, GslbserviceDownResponseFallbackIpArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    GslbserviceDownResponseFallbackIp6, GslbserviceDownResponseFallbackIp6Args

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    GslbserviceGroup, GslbserviceGroupArgs

    Members List<GslbserviceGroupMember>
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Algorithm string
    ConsistentHashMask string
    ConsistentHashMask6 string
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FallbackAlgorithm string
    ManualResume string
    MinHealthMonitorsUp string
    Priority string
    Members []GslbserviceGroupMember
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Algorithm string
    ConsistentHashMask string
    ConsistentHashMask6 string
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FallbackAlgorithm string
    ManualResume string
    MinHealthMonitorsUp string
    Priority string
    members List<GslbserviceGroupMember>
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    algorithm String
    consistentHashMask String
    consistentHashMask6 String
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fallbackAlgorithm String
    manualResume String
    minHealthMonitorsUp String
    priority String
    members GslbserviceGroupMember[]
    name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    algorithm string
    consistentHashMask string
    consistentHashMask6 string
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fallbackAlgorithm string
    manualResume string
    minHealthMonitorsUp string
    priority string
    members Sequence[GslbserviceGroupMember]
    name str
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    algorithm str
    consistent_hash_mask str
    consistent_hash_mask6 str
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fallback_algorithm str
    manual_resume str
    min_health_monitors_up str
    priority str
    members List<Property Map>
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    algorithm String
    consistentHashMask String
    consistentHashMask6 String
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fallbackAlgorithm String
    manualResume String
    minHealthMonitorsUp String
    priority String

    GslbserviceGroupMember, GslbserviceGroupMemberArgs

    CloudUuid string
    ClusterUuid string
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Fqdn string
    Hostname string
    Ips List<GslbserviceGroupMemberIp>
    Locations List<GslbserviceGroupMemberLocation>
    PreferenceOrder string
    PublicIps List<GslbserviceGroupMemberPublicIp>
    Ratio string
    ResolveFqdnToV6 string
    SrvRdatas List<GslbserviceGroupMemberSrvRdata>
    VsUuid string
    CloudUuid string
    ClusterUuid string
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Fqdn string
    Hostname string
    Ips []GslbserviceGroupMemberIp
    Locations []GslbserviceGroupMemberLocation
    PreferenceOrder string
    PublicIps []GslbserviceGroupMemberPublicIp
    Ratio string
    ResolveFqdnToV6 string
    SrvRdatas []GslbserviceGroupMemberSrvRdata
    VsUuid string
    cloudUuid String
    clusterUuid String
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fqdn String
    hostname String
    ips List<GslbserviceGroupMemberIp>
    locations List<GslbserviceGroupMemberLocation>
    preferenceOrder String
    publicIps List<GslbserviceGroupMemberPublicIp>
    ratio String
    resolveFqdnToV6 String
    srvRdatas List<GslbserviceGroupMemberSrvRdata>
    vsUuid String
    cloudUuid string
    clusterUuid string
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fqdn string
    hostname string
    ips GslbserviceGroupMemberIp[]
    locations GslbserviceGroupMemberLocation[]
    preferenceOrder string
    publicIps GslbserviceGroupMemberPublicIp[]
    ratio string
    resolveFqdnToV6 string
    srvRdatas GslbserviceGroupMemberSrvRdata[]
    vsUuid string
    cloud_uuid str
    cluster_uuid str
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fqdn str
    hostname str
    ips Sequence[GslbserviceGroupMemberIp]
    locations Sequence[GslbserviceGroupMemberLocation]
    preference_order str
    public_ips Sequence[GslbserviceGroupMemberPublicIp]
    ratio str
    resolve_fqdn_to_v6 str
    srv_rdatas Sequence[GslbserviceGroupMemberSrvRdata]
    vs_uuid str
    cloudUuid String
    clusterUuid String
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Enable or disable the gslb service. If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm. If the gslb service is disabled, then the vips are no longer available in the dns response. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fqdn String
    hostname String
    ips List<Property Map>
    locations List<Property Map>
    preferenceOrder String
    publicIps List<Property Map>
    ratio String
    resolveFqdnToV6 String
    srvRdatas List<Property Map>
    vsUuid String

    GslbserviceGroupMemberIp, GslbserviceGroupMemberIpArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    GslbserviceGroupMemberLocation, GslbserviceGroupMemberLocationArgs

    GslbserviceGroupMemberLocationLocation, GslbserviceGroupMemberLocationLocationArgs

    Latitude string
    Longitude string
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tag string
    Latitude string
    Longitude string
    Name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tag string
    latitude String
    longitude String
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag String
    latitude string
    longitude string
    name string
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag string
    latitude str
    longitude str
    name str
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag str
    latitude String
    longitude String
    name String
    Name for the gslb service. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag String

    GslbserviceGroupMemberPublicIp, GslbserviceGroupMemberPublicIpArgs

    GslbserviceGroupMemberPublicIpIp, GslbserviceGroupMemberPublicIpIpArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    GslbserviceGroupMemberSrvRdata, GslbserviceGroupMemberSrvRdataArgs

    Port string
    Priority string
    Weight string
    Port string
    Priority string
    Weight string
    port String
    priority String
    weight String
    port string
    priority string
    weight string
    port str
    priority str
    weight str
    port String
    priority String
    weight String

    GslbserviceMarker, GslbserviceMarkerArgs

    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>

    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