Invoke ADCUnsetAppflowparam - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUnsetAppflowparam

SYNOPSIS

Unset Appflow configuration Object.

SYNTAX

Invoke-ADCUnsetAppflowparam [[-templaterefresh] <Boolean>] [[-appnamerefresh] <Boolean>]
 [[-flowrecordinterval] <Boolean>] [[-securityinsightrecordinterval] <Boolean>] [[-udppmtu] <Boolean>]
 [[-httpurl] <Boolean>] [[-aaausername] <Boolean>] [[-httpcookie] <Boolean>] [[-httpreferer] <Boolean>]
 [[-httpmethod] <Boolean>] [[-httphost] <Boolean>] [[-httpuseragent] <Boolean>]
 [[-clienttrafficonly] <Boolean>] [[-httpcontenttype] <Boolean>] [[-httpauthorization] <Boolean>]
 [[-httpvia] <Boolean>] [[-httpxforwardedfor] <Boolean>] [[-httplocation] <Boolean>]
 [[-httpsetcookie] <Boolean>] [[-httpsetcookie2] <Boolean>] [[-connectionchaining] <Boolean>]
 [[-httpdomain] <Boolean>] [[-skipcacheredirectionhttptransaction] <Boolean>] [[-identifiername] <Boolean>]
 [[-identifiersessionname] <Boolean>] [[-observationdomainid] <Boolean>] [[-observationdomainname] <Boolean>]
 [[-subscriberawareness] <Boolean>] [[-subscriberidobfuscation] <Boolean>]
 [[-subscriberidobfuscationalgo] <Boolean>] [[-gxsessionreporting] <Boolean>]
 [[-securityinsighttraffic] <Boolean>] [[-cacheinsight] <Boolean>] [[-videoinsight] <Boolean>]
 [[-httpquerywithurl] <Boolean>] [[-urlcategory] <Boolean>] [[-lsnlogging] <Boolean>]
 [[-cqareporting] <Boolean>] [[-emailaddress] <Boolean>] [[-usagerecordinterval] <Boolean>]
 [[-websaasappusagereporting] <Boolean>] [[-metrics] <Boolean>] [[-events] <Boolean>] [[-auditlogs] <Boolean>]
 [[-observationpointid] <Boolean>] [[-distributedtracing] <Boolean>] [[-disttracingsamplingrate] <Boolean>]
 [[-tcpattackcounterinterval] <Boolean>] [[-logstreamovernsip] <Boolean>] [[-analyticsauthtoken] <Boolean>]
 [[-timeseriesovernsip] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for AppFlow parameter resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetAppflowparam

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

PARAMETERS

-templaterefresh

Refresh interval, in seconds, at which to export the template data. Because data transmission is in UDP, the templates must be resent at regular intervals.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-appnamerefresh

Interval, in seconds, at which to send Appnames to the configured collectors. Appname refers to the name of an entity (virtual server, service, or service group) in the Citrix ADC.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-flowrecordinterval

Interval, in seconds, at which to send flow records to the configured collectors.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-securityinsightrecordinterval

Interval, in seconds, at which to send security insight flow records to the configured collectors.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-udppmtu

MTU, in bytes, for IPFIX UDP packets.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpurl

Include the http URL that the Citrix ADC received from the client. 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

-aaausername

Enable AppFlow AAA Username logging. 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

-httpcookie

Include the cookie that was in the HTTP request the appliance received from the client. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpreferer

Include the web page that was last visited by the client. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpmethod

Include the method that was specified in the HTTP request that the appliance received from the client. 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

-httphost

Include the host identified in the HTTP request that the appliance received from the client. 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

-httpuseragent

Include the client application through which the HTTP request was received by the Citrix ADC. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-clienttrafficonly

Generate AppFlow records for only the traffic from the client. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpcontenttype

Include the HTTP Content-Type header sent from the server to the client to determine the type of the content sent. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpauthorization

Include the HTTP Authorization header information. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpvia

Include the httpVia header which contains the IP address of proxy server through which the client accessed the server. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpxforwardedfor

Include the httpXForwardedFor header, which contains the original IP Address of the client using a proxy server to access the server. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httplocation

Include the HTTP location headers returned from the HTTP responses. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpsetcookie

Include the Set-cookie header sent from the server to the client in response to a HTTP request. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpsetcookie2

Include the Set-cookie header sent from the server to the client in response to a HTTP request. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-connectionchaining

Enable connection chaining so that the client server flows of a connection are linked. Also the connection chain ID is propagated across Citrix ADCs, so that in a multi-hop environment the flows belonging to the same logical connection are linked. This id is also logged as part of appflow record. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpdomain

Include the http domain request to be exported. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-skipcacheredirectionhttptransaction

Skip Cache http transaction. This HTTP transaction is specific to Cache Redirection module. In Case of Cache Miss there will be another HTTP transaction initiated by the cache server. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-identifiername

Include the stream identifier name to be exported. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-identifiersessionname

Include the stream identifier session name to be exported. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-observationdomainid

An observation domain groups a set of Citrix ADCs based on deployment: cluster, HA etc. A unique Observation Domain ID is required to be assigned to each such group.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-observationdomainname

Name of the Observation Domain defined by the observation domain ID.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-subscriberawareness

Enable this option for logging end user MSISDN in L4/L7 appflow records. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-subscriberidobfuscation

Enable this option for obfuscating MSISDN in L4/L7 appflow records. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-subscriberidobfuscationalgo

Algorithm(MD5 or SHA256) to be used for obfuscating MSISDN. Possible values = MD5, SHA256

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-gxsessionreporting

Enable this option for Gx session reporting. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-securityinsighttraffic

Enable/disable the feature individually on appflow action. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cacheinsight

Flag to determine whether cache records need to be exported or not. If this flag is true and IC is enabled, cache records are exported instead of L7 HTTP records. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-videoinsight

Enable/disable the feature individually on appflow action. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-httpquerywithurl

Include the HTTP query segment along with the URL that the Citrix ADC received from the client. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-urlcategory

Include the URL category record. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-lsnlogging

On enabling this option, the Citrix ADC will send the Large Scale Nat(LSN) records to the configured collectors. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cqareporting

TCP CQA reporting enable/disable knob. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-emailaddress

Enable AppFlow user email-id logging. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-usagerecordinterval

On enabling this option, the NGS will send bandwidth usage record to configured collectors.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-websaasappusagereporting

On enabling this option, NGS will send data used by Web/saas app at the end of every HTTP transaction to configured collectors. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-metrics

Enable Citrix ADC Stats to be sent to the Telemetry Agent. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-events

Enable Events to be sent to the Telemetry Agent. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-auditlogs

Enable Auditlogs to be sent to the Telemetry Agent. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-observationpointid

An observation point ID is identifier for the NetScaler from which appflow records are being exported. By default, the NetScaler IP is the observation point ID.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-distributedtracing

Enable generation of the distributed tracing templates in the Appflow records. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-disttracingsamplingrate

Sampling rate for Distributed Tracing.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-tcpattackcounterinterval

Interval, in seconds, at which to send tcp attack counters to the configured collectors. If 0 is configured, the record is not sent.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-logstreamovernsip

To use the Citrix ADC IP to send Logstream records instead of the SNIP. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-analyticsauthtoken

Authentication token to be set by the agent.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-timeseriesovernsip

To use the Citrix ADC IP to send Time series data such as metrics and events, instead of the SNIP. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

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