DataCore Intelligence Service Cmdlets Reference Guide

Get-DcsProxySettings

Reset-DcsProxySettings

Set-DcsProxySettings

To Table of Contents

NAME

Get-DcsProxySettings

SYNOPSIS

Returns telemetry proxy settings. Requires user to have administrator privileges.

SYNTAX

Get-DcsProxySettings [ -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-DcsProxySettings

Gets the settings for the proxy server.

Address	:	Mimas
Port	:	80
Username	:
Password	:
IsEnabled	:	True

To Table of Contents

NAME

Reset-DcsProxySettings

SYNOPSIS

Clears the proxy settings and disables the proxy service. Requires user to have administrator privileges.

SYNTAX

Reset-DcsProxySettings [ -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-DcsProxySettings

Address	:
Port	:	0
Username	:
Password	:
IsEnabled	:	False

To Table of Contents

NAME

Set-DcsProxySettings

SYNOPSIS

Sets telemetry proxy settings for the proxy service. Requires user to have administrator privileges.

SYNTAX

Set-DcsProxySettings -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-DcsProxySettings -Host Mimas -Port 80

Sets "Mimas" as the proxy server using port "80".