Invoke ADCClearNsconfig - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCClearNsconfig

SYNOPSIS

Clear NS configuration Object.

SYNTAX

Invoke-ADCClearNsconfig [[-Force] <Boolean>] [-Level] <String> [[-Rbaconfig] <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for system config resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCClearNsconfig -level <string>

An example how to clear nsconfig configuration Object(s).

PARAMETERS

-Force

Configurations will be cleared without prompting for confirmation.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Level

Types of configurations to be cleared.

  • basic: Clears all configurations except the following:
  • NSIP, default route (gateway), static routes, MIPs, and SNIPs
  • Network settings (DG, VLAN, RHI and DNS settings)
  • Cluster settings
  • HA node definitions
  • Feature and mode settings
  • nsroot password
  • extended: Clears the same configurations as the 'basic' option. In addition, it clears the feature and mode settings.
  • full: Clears all configurations except NSIP, default route, and interface settings. Note: When you clear the configurations through the cluster IP address, by specifying the level as 'full', the cluster is deleted and all cluster nodes become standalone appliances. The 'basic' and 'extended' levels are propagated to the cluster nodes. Possible values = basic, extended, full
Type: String
Parameter Sets: (All)
Aliases:

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

-Rbaconfig

RBA configurations and TACACS policies bound to system global will not be cleared if RBA is set to NO.This option is applicable only for BASIC level of clear configuration.Default is YES, which will clear rba configurations. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
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-ADCClearNsconfig Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nsconfig/ 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** ⚠️