Invoke ADCAddLbgroup - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddLbgroup

SYNOPSIS

Add Load Balancing configuration Object.

SYNTAX

Invoke-ADCAddLbgroup [-Name] <String> [[-Persistencetype] <String>] [[-Persistencebackup] <String>]
 [[-Backuppersistencetimeout] <Double>] [[-Persistmask] <String>] [[-Cookiename] <String>]
 [[-V6persistmasklen] <Double>] [[-Cookiedomain] <String>] [[-Timeout] <Double>] [[-Rule] <String>]
 [[-Usevserverpersistency] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for LB group resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddLbgroup -name <string>

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

PARAMETERS

-Name

Name of the load balancing virtual server group.

Type: String
Parameter Sets: (All)
Aliases:

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

-Persistencetype

Type of persistence for the group. Available settings function as follows:

  • SOURCEIP - Create persistence sessions based on the client IP.
  • COOKIEINSERT - Create persistence sessions based on a cookie in client requests. The cookie is inserted by a Set-Cookie directive from the server, in its first response to a client.
  • RULE - Create persistence sessions based on a user defined rule.
  • NONE - Disable persistence for the group. Possible values = SOURCEIP, COOKIEINSERT, RULE, NONE
Type: String
Parameter Sets: (All)
Aliases:

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

-Persistencebackup

Type of backup persistence for the group. Possible values = SOURCEIP, NONE

Type: String
Parameter Sets: (All)
Aliases:

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

-Backuppersistencetimeout

Time period, in minutes, for which backup persistence is in effect.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Persistmask

Persistence mask to apply to source IPv4 addresses when creating source IP based persistence sessions.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookiename

Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

Type: String
Parameter Sets: (All)
Aliases:

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

-V6persistmasklen

Persistence mask to apply to source IPv6 addresses when creating source IP based persistence sessions.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Cookiedomain

Domain attribute for the HTTP cookie.

Type: String
Parameter Sets: (All)
Aliases:

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

-Timeout

Time period for which a persistence session is in effect.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Rule

Expression, or name of a named expression, against which traffic is evaluated. The following requirements apply only to the Citrix ADC CLI:

  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
  • If the expression itself includes double quotation marks, escape the quotations by using the \ character.
  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.
Type: String
Parameter Sets: (All)
Aliases:

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

-Usevserverpersistency

Use this parameter to enable vserver level persistence on group members. This allows member vservers to have their own persistence, but need to be compatible with other members persistence rules. When this setting is enabled persistence sessions created by any of the members can be shared by other member vservers. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created lbgroup 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-ADCAddLbgroup Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/lb/lbgroup/ 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** ⚠️