Edit

Share via


Set-CsTelemetryConfiguration

Use the Set-CsTelemetryConfiguration cmdlet to change the settings on existing telemetry configurations. UNRESOLVED_TOKEN_VAL(PS_TelemetryDataStatement)

Syntax

Identity

Set-CsTelemetryConfiguration
    [[-Identity] <XdsIdentity>]
    [-Confirm]
    [-EnableClientTelemetry <Boolean>]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

Instance

Set-CsTelemetryConfiguration
    [-Confirm]
    [-EnableClientTelemetry <Boolean>]
    [-Force]
    [-Instance <PSObject>]
    [-WhatIf]
    [<CommonParameters>]

Description

For privacy information, see the Skype for Business Privacy Statement (https://go.microsoft.com/fwlink/?LinkID=517480&clcid=0x409).

Examples

Example 1

Set-CsTelemetryConfiguration -Identity site:Redmond -EnableClientTelemetry $True

This example enables client telemetry on the configuration scoped to the Redmond site.

Parameters

-Confirm

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableClientTelemetry

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

When set to true, client telemetry will be enabled. The default is false.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Suppresses the display of any non-fatal error messages and completes the cmdlet operation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). The format of the service scope is "Service:<Identity>", where identity is derived from the topology. You can use the following commands to identify the relevant services.

Get-CsService -WebServer | fl Identity

Get-CsService -PoolFqdn \<pool\> | fl Identity

The first command will give you all of the WebServices in the topology, regardless of the pool. The second will give you all of the services on the pool, regardless of their role. You can combine the two commands to zero in on a single role in a single pool.

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Instance

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Instance
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Management.Automation.PSObject

This cmdlet takes pipeline input of the Get-CsTelemetryConfiguration cmdlet.

Outputs

None