< Back

Test-ChocolateySource

Mon Jan 13, 2020 1:45 am

NAME Test-ChocolateySource



SYNOPSIS

Verify the source settings matches the given parameters.





SYNTAX

Test-ChocolateySource [-Name] <String> [[-Source] <Object>] [-Disabled] [-BypassProxy] [-SelfService] [[-Priority]

<Int32>] [[-Credential] <PSCredential>] [[-KeyUser] <Object>] [[-Key] <Object>] [<CommonParameters>]





DESCRIPTION

This command compares the properties of the source found by name, with the parameters given.





PARAMETERS

-Name <String>

Name - the name of the source to find for comparison.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Source <Object>

Source - The source. This can be a folder/file share or an http location.

If it is a url, it will be a location you can go to in a browser and

it returns OData with something that says Packages in the browser,

similar to what you see when you go to https://chocolatey.org/api/v2/.

Defaults to empty.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Disabled [<SwitchParameter>]

Test whether the source to is registered but disabled.

By default it checks if enabled.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-BypassProxy [<SwitchParameter>]

Bypass Proxy - Is this source explicitly bypass any explicitly or

system configured proxies? Defaults to false. Available in 0.10.4+.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-SelfService [<SwitchParameter>]

Is Self-Service ? - Is this source be allowed to be used with self-

service? Requires business edition (v1.10.0+) with feature

'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to

false. Available in 0.10.4+.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Priority <Int32>

Priority - The priority order of this source as compared to other

sources, lower is better. Defaults to 0 (no priority). All priorities

above 0 will be evaluated first, then zero-based values will be

evaluated in config file order. Available in 0.9.9.9+.



Required? false

Position? 3

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Credential <PSCredential>

Validate Credential used with authenticated feeds.



Required? false

Position? 4

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-KeyUser <Object>

API Key User for the registered source.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Key <Object>

API Key for the registered source (used instead of credential when password length > 240 char).



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





https://github.com/chocolatey/choco/wiki/CommandsSource



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Test-ChocolateySource -source https://chocolatey.org/api/v2 -priority 0















RELATED LINKS