DataCore Telemetry Cmdlet Reference Guide
Table of Contents
To Table of Contents
NAME
Get-DcsTelemetryProxySettings
SYNOPSIS
Returns telemetry proxy settings. Requires user to have administrator privileges.
SYNTAX
Get-DcsTelemetryProxySettings [ -InformationAction <ActionPreference> ] [ -InformationVariable <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Returns telemetry proxy settings. Requires user to have administrator privileges.
PARAMETERS
- -InformationAction<ActionPreference>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -InformationVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -PipelineVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
INPUTS
OUTPUTS
ConfigurationProxySettings : Object that describes telemetry proxy settings.
NOTES
EXAMPLES
-------------- Example 1 Gets telemetry proxy settings --------------
Get-DcsTelemetryProxySettings
Gets the settings for the proxy server.
| Address |
: |
Mimas |
| Port |
: |
80 |
| Username |
: |
|
| Password |
: |
|
| IsEnabled |
: |
True |
| |
|
|
To Table of Contents
NAME
Reset-DcsTelemetryProxySettings
SYNOPSIS
Clears the proxy settings and disables the proxy service. Requires user to have administrator privileges.
SYNTAX
Reset-DcsTelemetryProxySettings [ -InformationAction <ActionPreference> ] [ -InformationVariable <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Clears the proxy settings and disables the proxy service. Requires user to have administrator privileges.
PARAMETERS
- -InformationAction<ActionPreference>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -InformationVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -PipelineVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
INPUTS
OUTPUTS
ConfigurationProxySettings : Object that describes telemetry proxy settings.
NOTES
EXAMPLES
-------------- Example 1 Resets the proxy server settings --------------
Reset-DcsTelemetryProxySettings
| Address |
: |
|
| Port |
: |
0 |
| Username |
: |
|
| Password |
: |
|
| IsEnabled |
: |
False |
| |
|
|
To Table of Contents
NAME
Set-DcsTelemetryProxySettings
SYNOPSIS
Sets telemetry proxy settings for the proxy service. Requires user to have administrator privileges.
SYNTAX
Set-DcsTelemetryProxySettings -Host <String> -Port <UInt16> [ -Username <String> ] [ -Password <String> ] [ -IsEnabled <Boolean> ] [ -InformationAction <ActionPreference> ] [ -InformationVariable <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Sets telemetry proxy settings for the proxy service. Requires user to have administrator privileges.
PARAMETERS
- -Host<String>
- Fully qualified host name or IP address for the proxy server.
- Required: true
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -Port<UInt16>
- The port number that the proxy server is listening on.
- Required: true
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -Username<String>
- Enter if authentication is required for the proxy server.
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -Password<String>
- Enter if authentication is required for the proxy server.
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -IsEnabled<Boolean>
- Set to $true to enable the proxy setting or $false to disable. Default value is $true.
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -InformationAction<ActionPreference>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -InformationVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -PipelineVariable<String>
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
INPUTS
OUTPUTS
NOTES
EXAMPLES
-------------- Example 1 Sets telemetry proxy settings --------------
Set-DcsTelemetryProxySettings -Host Mimas -Port 80
Sets "Mimas" as the proxy server using port "80".