Invoke ADCAddAppfwprofilejsondosurlbinding - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddAppfwprofilejsondosurlbinding

SYNOPSIS

Add Application Firewall configuration Object.

SYNTAX

Invoke-ADCAddAppfwprofilejsondosurlbinding [-Name] <String> [[-Comment] <String>] [[-State] <String>]
 [[-Jsondosurl] <String>] [[-Jsonmaxcontainerdepthcheck] <String>] [[-Jsonmaxcontainerdepth] <Double>]
 [[-Jsonmaxdocumentlengthcheck] <String>] [[-Jsonmaxdocumentlength] <Double>]
 [[-Jsonmaxobjectkeycountcheck] <String>] [[-Jsonmaxobjectkeycount] <Double>]
 [[-Jsonmaxobjectkeylengthcheck] <String>] [[-Jsonmaxobjectkeylength] <Double>]
 [[-Jsonmaxarraylengthcheck] <String>] [[-Jsonmaxarraylength] <Double>] [[-Jsonmaxstringlengthcheck] <String>]
 [[-Jsonmaxstringlength] <Double>] [[-Isautodeployed] <String>] [[-Resourceid] <String>] [[-Ruletype] <String>]
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Binding object showing the jsondosurl that can be bound to appfwprofile.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddAppfwprofilejsondosurlbinding -name <string>

An example how to add appfwprofile_jsondosurl_binding configuration Object(s).

PARAMETERS

-Name

Name of the profile to which to bind an exemption or rule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Comment

Any comments about the purpose of profile, or other useful information about the profile.

Type: String
Parameter Sets: (All)
Aliases:

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

-State

Enabled. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsondosurl

The URL on which we need to enforce the specified JSON denial-of-service (JSONDoS) attack protections. An JSON DoS configuration consists of the following items: * URL. PCRE-format regular expression for the URL.

  • Maximum-document-length-check toggle. ON to enable this check, OFF to disable it.
  • Maximum document length. Positive integer representing the maximum length of the JSON document.
  • Maximum-container-depth-check toggle. ON to enable, OFF to disable.
  • Maximum container depth. Positive integer representing the maximum container depth of the JSON document.
  • Maximum-object-key-count-check toggle. ON to enable, OFF to disable.
  • Maximum object key count. Positive integer representing the maximum allowed number of keys in any of the JSON object.
  • Maximum-object-key-length-check toggle. ON to enable, OFF to disable.
  • Maximum object key length. Positive integer representing the maximum allowed length of key in any of the JSON object.
  • Maximum-array-value-count-check toggle. ON to enable, OFF to disable.
  • Maximum array value count. Positive integer representing the maximum allowed number of values in any of the JSON array.
  • Maximum-string-length-check toggle. ON to enable, OFF to disable.
  • Maximum string length. Positive integer representing the maximum length of string in JSON.
Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxcontainerdepthcheck

State if JSON Max depth check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxcontainerdepth

Maximum allowed nesting depth of JSON document. JSON allows one to nest the containers (object and array) in any order to any depth. This check protects against documents that have excessive depth of hierarchy.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Jsonmaxdocumentlengthcheck

State if JSON Max document length check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxdocumentlength

Maximum document length of JSON document, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Jsonmaxobjectkeycountcheck

State if JSON Max object key count check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxobjectkeycount

Maximum key count in the any of JSON object. This check protects against objects that have large number of keys.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Jsonmaxobjectkeylengthcheck

State if JSON Max object key length check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxobjectkeylength

Maximum key length in the any of JSON object. This check protects against objects that have large keys.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Jsonmaxarraylengthcheck

State if JSON Max array value count check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxarraylength

Maximum array length in the any of JSON object. This check protects against arrays having large lengths.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Jsonmaxstringlengthcheck

State if JSON Max string value count check is ON or OFF. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Jsonmaxstringlength

Maximum string length in the JSON. This check protects against strings that have large length.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Isautodeployed

Is the rule auto deployed by dynamic profile ?. Possible values = AUTODEPLOYED, NOTAUTODEPLOYED

Type: String
Parameter Sets: (All)
Aliases:

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

-Resourceid

A "id" that identifies the rule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Ruletype

Specifies rule type of binding. Possible values = ALLOW, DENY

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

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