Invoke-ADCAddAnalyticsprofile

SYNOPSIS

Add Analytics configuration Object.

SYNTAX

Invoke-ADCAddAnalyticsprofile [-Name] <String> [[-Collectors] <String>] [-Type] <String>
 [[-Httpclientsidemeasurements] <String>] [[-Httppagetracking] <String>] [[-Httpurl] <String>]
 [[-Httphost] <String>] [[-Httpmethod] <String>] [[-Httpreferer] <String>] [[-Httpuseragent] <String>]
 [[-Httpcookie] <String>] [[-Httplocation] <String>] [[-Urlcategory] <String>] [[-Allhttpheaders] <String>]
 [[-Httpcontenttype] <String>] [[-Httpauthentication] <String>] [[-Httpvia] <String>]
 [[-Httpxforwardedforheader] <String>] [[-Httpsetcookie] <String>] [[-Httpsetcookie2] <String>]
 [[-Httpdomainname] <String>] [[-Httpurlquery] <String>] [[-Tcpburstreporting] <String>]
 [[-Cqareporting] <String>] [[-Integratedcache] <String>] [[-Grpcstatus] <String>] [[-Outputmode] <String>]
 [[-Metrics] <String>] [[-Events] <String>] [[-Auditlogs] <String>] [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for Analytics profile resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddAnalyticsprofile -name <string> -type <string>

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

PARAMETERS

-Name

Name for the analytics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

Type: String
Parameter Sets: (All)
Aliases:

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

-Collectors

The collector can be an IP, an appflow collector name, a service or a vserver. If IP is specified, the transport is considered as logstream and default port of 5557 is taken. If collector name is specified, the collector properties are taken from the configured collector. If service is specified, the configured service is assumed as the collector. If vserver is specified, the services bound to it are considered as collectors and the records are load balanced.

Type: String
Parameter Sets: (All)
Aliases:

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

-Type

This option indicates what information needs to be collected and exported. Possible values = global, webinsight, tcpinsight, securityinsight, videoinsight, hdxinsight, gatewayinsight, timeseries, lsninsight, botinsight, CIinsight

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpclientsidemeasurements

On enabling this option, the Citrix ADC will insert a javascript into the HTTP response to collect the client side page-timings and will send the same to the configured collectors. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httppagetracking

On enabling this option, the Citrix ADC will link the embedded objects of a page together. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpurl

On enabling this option, the Citrix ADC will log the URL in appflow records. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httphost

On enabling this option, the Citrix ADC will log the Host header in appflow records. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpmethod

On enabling this option, the Citrix ADC will log the method header in appflow records. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpreferer

On enabling this option, the Citrix ADC will log the referer header in appflow records. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpuseragent

On enabling this option, the Citrix ADC will log User-Agent header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpcookie

On enabling this option, the Citrix ADC will log cookie header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httplocation

On enabling this option, the Citrix ADC will log location header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Urlcategory

On enabling this option, the Citrix ADC will send the URL category record. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Allhttpheaders

On enabling this option, the Citrix ADC will log all the request and response headers. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpcontenttype

On enabling this option, the Citrix ADC will log content-length header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpauthentication

On enabling this option, the Citrix ADC will log Authentication header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpvia

On enabling this option, the Citrix ADC will Via header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpxforwardedforheader

On enabling this option, the Citrix ADC will log X-Forwarded-For header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpsetcookie

On enabling this option, the Citrix ADC will log set-cookie header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpsetcookie2

On enabling this option, the Citrix ADC will log set-cookie2 header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpdomainname

On enabling this option, the Citrix ADC will log domain name. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Httpurlquery

On enabling this option, the Citrix ADC will log URL Query. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcpburstreporting

On enabling this option, the Citrix ADC will log TCP burst parameters. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Cqareporting

On enabling this option, the Citrix ADC will log TCP CQA parameters. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Integratedcache

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Grpcstatus

On enabling this option, the Citrix ADC will log the gRPC status headers. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Outputmode

This option indicates the format of REST API POST body. It depends on the consumer of the analytics data. Possible values = avro, prometheus, influx

Type: String
Parameter Sets: (All)
Aliases:

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

-Metrics

This option indicates the whether metrics should be sent to the REST collector. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Events

This option indicates the whether events should be sent to the REST collector. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Auditlogs

This option indicates the whether auditlog should be sent to the REST collector. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created analyticsprofile 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-ADCAddAnalyticsprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/analytics/analyticsprofile/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.