Invoke-ADCUnsetServicegroup

SYNOPSIS

Unset Basic configuration Object.

SYNTAX

Invoke-ADCUnsetServicegroup [[-Servicegroupname] <String>] [[-servername] <Boolean>] [[-port] <Boolean>]
 [[-weight] <Boolean>] [[-customserverid] <Boolean>] [[-serverid] <Boolean>] [[-hashid] <Boolean>]
 [[-nameserver] <Boolean>] [[-dbsttl] <Boolean>] [[-maxclient] <Boolean>] [[-maxreq] <Boolean>]
 [[-cacheable] <Boolean>] [[-cip] <Boolean>] [[-usip] <Boolean>] [[-useproxyport] <Boolean>] [[-sp] <Boolean>]
 [[-rtspsessionidremap] <Boolean>] [[-clttimeout] <Boolean>] [[-svrtimeout] <Boolean>] [[-cka] <Boolean>]
 [[-tcpb] <Boolean>] [[-cmp] <Boolean>] [[-maxbandwidth] <Boolean>] [[-monthreshold] <Boolean>]
 [[-tcpprofilename] <Boolean>] [[-httpprofilename] <Boolean>] [[-appflowlog] <Boolean>]
 [[-netprofile] <Boolean>] [[-autodisablegraceful] <Boolean>] [[-autodisabledelay] <Boolean>]
 [[-monitor_name_svc] <Boolean>] [[-dup_weight] <Boolean>] [[-healthmonitor] <Boolean>]
 [[-cipheader] <Boolean>] [[-pathmonitor] <Boolean>] [[-pathmonitorindv] <Boolean>]
 [[-downstateflush] <Boolean>] [[-comment] <Boolean>] [[-monconnectionclose] <Boolean>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for service group resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetServicegroup -servicegroupname <string>

An example how to unset servicegroup configuration Object(s).

PARAMETERS

-Servicegroupname

Name of the 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: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-servername

Name of the server to which to bind the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-port

Server port number.

in CLI is represented as 65535 in NITRO API

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-weight

Weight to assign to the servers in the service group. Specifies the capacity of the servers relative to the other servers in the load balancing configuration. The higher the weight, the higher the percentage of requests sent to the service.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-customserverid

The identifier for this IP:Port pair. Used when the persistency type is set to Custom Server ID.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-serverid

The identifier for the service. This is used when the persistency type is set to Custom Server ID.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-hashid

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-nameserver

Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-dbsttl

Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-maxclient

Maximum number of simultaneous open connections for the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-maxreq

Maximum number of requests that can be sent on a persistent connection to the service group. Note: Connection requests beyond this value are rejected.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cacheable

Use the transparent cache redirection virtual server to forward the request to the cache server. Note: Do not set this parameter if you set the Cache Type. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cip

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-usip

Use client's IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-useproxyport

Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection. Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-sp

Enable surge protection for the service group. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-rtspsessionidremap

Enable RTSP session ID mapping for the service group. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-clttimeout

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-svrtimeout

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cka

Enable client keep-alive for the service group. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-tcpb

Enable TCP buffering for the service group. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cmp

Enable compression for the specified service. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-maxbandwidth

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-monthreshold

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-tcpprofilename

Name of the TCP profile that contains TCP configuration settings for the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpprofilename

Name of the HTTP profile that contains HTTP configuration settings for the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-appflowlog

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

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-netprofile

Network profile for the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-autodisablegraceful

Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-autodisabledelay

The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-monitor_name_svc

Name of the monitor bound to the service group. Used to assign a weight to the monitor.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-dup_weight

weight of the monitor that is bound to servicegroup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-healthmonitor

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

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: False
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: Boolean
Parameter Sets: (All)
Aliases:

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

-pathmonitor

Path monitoring for clustering. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-pathmonitorindv

Individual Path monitoring decisions. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-downstateflush

Flush all active transactions associated with all the services in the 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: Boolean
Parameter Sets: (All)
Aliases:

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

-comment

Any information about the service group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-monconnectionclose

Close monitoring connections by sending the service a connection termination message with the specified bit set. Possible values = RESET, FIN

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 40
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-ADCUnsetServicegroup Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/basic/servicegroup Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.