Invoke ADCUnsetClusterinstance - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUnsetClusterinstance

SYNOPSIS

Unset cluster configuration Object.

SYNTAX

Invoke-ADCUnsetClusterinstance [[-Clid] <Double>] [[-deadinterval] <Boolean>] [[-hellointerval] <Boolean>]
 [[-preemption] <Boolean>] [[-quorumtype] <Boolean>] [[-inc] <Boolean>] [[-processlocal] <Boolean>]
 [[-nodegroup] <Boolean>] [[-retainconnectionsoncluster] <Boolean>] [[-backplanebasedview] <Boolean>]
 [[-syncstatusstrictmode] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for cluster instance resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetClusterinstance -clid <double>

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

PARAMETERS

-Clid

Unique number that identifies the cluster.

Type: Double
Parameter Sets: (All)
Aliases:

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

-deadinterval

Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.If the value is less than 3 sec, set the helloInterval parameter to 200 msec.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-hellointerval

Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.Set the value to 200 msec, if the deadInterval parameter is less than 3 sec.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-preemption

Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-quorumtype

Quorum Configuration Choices - "Majority" (recommended) requires majority of nodes to be online for the cluster to be UP. "None" relaxes this requirement. Possible values = MAJORITY, NONE

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-inc

This option is required if the cluster nodes reside on different networks. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-processlocal

By turning on this option packets destined to a service in a cluster will not under go any steering. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-nodegroup

The node group in a Cluster system used for transition from L2 to L3.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-retainconnectionsoncluster

This option enables you to retain existing connections on a node joining a Cluster system or when a node is being configured for passive timeout. By default, this option is disabled. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-backplanebasedview

View based on heartbeat only on bkplane interface. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-syncstatusstrictmode

strict mode for sync status of cluster. Depending on the the mode if there are any errors while applying config, sync status is displayed accordingly. By default the flag is disabled. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
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-ADCUnsetClusterinstance Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/cluster/clusterinstance 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** ⚠️