Invoke ADCUpdateDnspolicy - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateDnspolicy

SYNOPSIS

Update Domain Name Service configuration Object.

SYNTAX

Invoke-ADCUpdateDnspolicy [-Name] <String> [[-Rule] <String>] [[-Viewname] <String>]
 [[-Preferredlocation] <String>] [[-Preferredloclist] <String[]>] [[-Drop] <String>] [[-Cachebypass] <String>]
 [[-Actionname] <String>] [[-Logaction] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for DNS policy resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateDnspolicy -name <string>

An example how to update dnspolicy configuration Object(s).

PARAMETERS

-Name

Name for the DNS policy.

Type: String
Parameter Sets: (All)
Aliases:

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

-Rule

Expression against which DNS traffic is evaluated. Note:

  • On the command line interface, if the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
  • If the expression itself includes double quotation marks, you must 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. Example: CLIENT.UDP.DNS.DOMAIN.EQ("domainname").
Type: String
Parameter Sets: (All)
Aliases:

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

-Viewname

The view name that must be used for the given policy.

Type: String
Parameter Sets: (All)
Aliases:

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

-Preferredlocation

The location used for the given policy. This is deprecated attribute. Please use -prefLocList.

Type: String
Parameter Sets: (All)
Aliases:

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

-Preferredloclist

The location list in priority order used for the given policy.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Drop

The dns packet must be dropped. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

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

-Cachebypass

By pass dns cache for this. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

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

-Actionname

Name of the DNS action to perform when the rule evaluates to TRUE. The built in actions function as follows:

  • dns_default_act_Drop. Drop the DNS request.
  • dns_default_act_Cachebypass. Bypass the DNS cache and forward the request to the name server. You can create custom actions by using the add dns action command in the CLI or the DNS > Actions > Create DNS Action dialog box in the Citrix ADC configuration utility.
Type: String
Parameter Sets: (All)
Aliases:

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

-Logaction

Name of the messagelog action to use for requests that match this policy.

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

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