Invoke ADCAddGslbservicegroup - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddGslbservicegroup

SYNOPSIS

Add Global Server Load Balancing configuration Object.

SYNTAX

Invoke-ADCAddGslbservicegroup [-Servicegroupname] <String> [-Servicetype] <String> [[-Maxclient] <Double>]
 [[-Cip] <String>] [[-Cipheader] <String>] [[-Healthmonitor] <String>] [[-Clttimeout] <Double>]
 [[-Svrtimeout] <Double>] [[-Maxbandwidth] <Double>] [[-Monthreshold] <Double>] [[-State] <String>]
 [[-Downstateflush] <String>] [[-Comment] <String>] [[-Appflowlog] <String>] [[-Autoscale] <String>]
 [-Sitename] <String> [[-Sitepersistence] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for GSLB service group resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddGslbservicegroup -servicegroupname <string> -servicetype <string> -sitename <string>

An example how to add gslbservicegroup configuration Object(s).

PARAMETERS

-Servicegroupname

Name of the GSLB service group. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the name is created.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Servicetype

Protocol used to exchange data with the GSLB service. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, ANY, SIP_UDP, SIP_TCP, SIP_SSL, RADIUS, RDP, RTSP, MYSQL, MSSQL, ORACLE

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Maxclient

Maximum number of simultaneous open connections for the GSLB service group.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Cip

Insert the Client IP header in requests forwarded to the GSLB service. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cipheader

Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client's IP header name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Healthmonitor

Monitor the health of this GSLB service.Available settings function are as follows: YES - Send probes to check the health of the GSLB service. NO - Do not send probes to check the health of the GSLB service. With the NO option, the appliance shows the service as UP at all times. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: YES
Accept pipeline input: False
Accept wildcard characters: False

-Clttimeout

Time, in seconds, after which to terminate an idle client connection.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Svrtimeout

Time, in seconds, after which to terminate an idle server connection.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Maxbandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Monthreshold

Minimum sum of weights of the monitors that are bound to this GSLB service. Used to determine whether to mark a GSLB service as UP or DOWN.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-State

Initial state of the GSLB service group. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Downstateflush

Flush all active transactions associated with all the services in the GSLB service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Comment

Any information about the GSLB service group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Appflowlog

Enable logging of AppFlow information for the specified GSLB service group. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Autoscale

Auto scale option for a GSLB servicegroup. Possible values = DISABLED, DNS

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Sitename

Name of the GSLB site to which the service group belongs.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sitepersistence

Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale enabled GSLB servicegroups. Possible values = ConnectionProxy, HTTPRedirect, NONE

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created gslbservicegroup item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCAddGslbservicegroup Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/gslb/gslbservicegroup/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️