< Back

Connect-SonarrInstance

Sat Jan 18, 2020 8:27 pm

NAME Connect-SonarrInstance



SYNTAX

Connect-SonarrInstance [[-SonarrServerName] <string>] -ApiKey <ApiKey> [-ReverseProxyUriBase <string>] [-UseSSL]

[-SkipCertificateCheck] [-AllowRedirects] [-Proxy <string>] [-ProxyCredential <ProxyCredential>]

[-ProxyBypassOnLocal] [-NoApiPrefix] [-PassThru] [-PortNumber <int>] [<CommonParameters>]



Connect-SonarrInstance [-SonarrUrl] <uri> -ApiKey <ApiKey> [-SkipCertificateCheck] [-AllowRedirects] [-Proxy

<string>] [-ProxyCredential <ProxyCredential>] [-ProxyBypassOnLocal] [-NoApiPrefix] [-PassThru]

[<CommonParameters>]





PARAMETERS

-AllowRedirects



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-ApiKey <ApiKey>

Can be retrieved from your Sonarr website (Settings => General => Security), or in the "Config.xml" file in

the AppData directory.



Required? true

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-NoApiPrefix



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-PassThru



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-PortNumber <int>



Required? false

Position? Named

Accept pipeline input? false

Parameter set name ByServerName

Aliases None

Dynamic? false



-Proxy <string>



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-ProxyBypassOnLocal



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-ProxyCredential <ProxyCredential>



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-ReverseProxyUriBase <string>



Required? false

Position? Named

Accept pipeline input? false

Parameter set name ByServerName

Aliases None

Dynamic? false



-SkipCertificateCheck



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-SonarrServerName <string>



Required? false

Position? 0

Accept pipeline input? false

Parameter set name ByServerName

Aliases HostName

Dynamic? false



-SonarrUrl <uri>



Required? true

Position? 0

Accept pipeline input? false

Parameter set name BySonarrUrl

Aliases Url

Dynamic? false



-UseSSL



Required? false

Position? Named

Accept pipeline input? false

Parameter set name ByServerName

Aliases None

Dynamic? 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

None





OUTPUTS

MG.Sonarr.Results.SonarrStatusResult





ALIASES

Connect-Sonarr





REMARKS

Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help.

-- To download and install Help files for the module that includes this cmdlet, use Update-Help.