Set-AksEdgeNodeToDrain
Drains a local node.
Syntax
Set-AksEdgeNodeToDrain [[-NodeType] <String>] [[-TimeoutSeconds] <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Drains a local node. This is useful for gracefully terminating the pods running on the node, for instance, for servicing or removing the node.
Parameters
-NodeType
This parameter indicates whether the 'Linux' node or the 'Windows' node, or both at the same time with 'LinuxAndWindows', should be drained. When not specified, only the 'Linux' node is drained. When both nodes are drained, the Windows node is drained first, then the Linux node.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: Linux
Accept pipeline input: False
Accept wildcard characters: False
-TimeoutSeconds
This parameter is to provide the time out value in seconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 300
Accept pipeline input: False
Accept wildcard characters: False
-Force
Drains node without any prompts.
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 isn't 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.