Indicates that all API requests should not append '/api' to the end of the URL path. The key can be retrieved from your Sonarr website (Settings => General => Security), or in the "Config.xml" file in the AppData directory. The key is 32, all lower-case, alphanumeric characters. Indicates that the proxy should be used on local connections. Specifies a set of credentials in order to access the proxy. Specifies a proxy URL that HttpClient must use. See the wiki article for more information: Specifies the HttpClient to follow any HTTP redirects. Specifies the HttpClient to ignore any certificate errors that may occur. Indicates that connection should establish over an SSL connection when using the "ByServerName" parameter set.
If you don't use a reverse proxy with Sonarr, then you don't need this parameter :) Specifies a custom URL base for use with reverse proxies. Specifies the direct URL to the Sonarr instance including any reverse proxy bases. If this command is not run first, all other cmdlets will throw an error.Ĭonnect-Sonarr -Server "MEDIASERVER" -ApiKey "xxxxxxxxxxxxxxxx" -PassThruĬonnect-SonarrInstance -Url '' -ApiKey "xxxxxxxxxxxxxxxx" -NoApiPrefix The "/api" path is automatically appended unless the '-NoApiPrefix' parameter is used. The connection is created either via hostname/port/url base or by direct URL.
#How to configure sonarr to search for certain strings series#
The optional series ID to perform the rescan on.īuilds the connection context for subsequent cmdlets.Įstablishes a custom HttpClient context for use with all subsequent PoshSonarr cmdlets. Instructs Sonarr to perform a series rescan on all series or a specified series by its ID. THe optional series ID to perform the refresh on. Instructs Sonarr to perform a series refresh for either all series or a specified series by ID. Sonarr performs a backup of its database when this cmdlet is run. The series ID to perform the series search on. Instructs Sonarr to perform a series search for the specified seriesID. Specifies to bypass the confirmation prompt. The optional season number to perform the search on. The ID of the series to perform the search on. If a season number is not specified, all seasons will be searched. Instructs Sonarr to perform a season search for the specified series and, optionally, a given season number. Instructs to perform an RSS sync on all specified RSS feeds. The episode id(s) retrieved from 'Get-SonarrEpisode'. Tells SOnarr to perform an episode search for the given episodes. Instructs Sonarr to perform an episode search. The job id(s) of the command(s) to retrieves their statuses. Retrieves the status of a given command issued to Sonarr.Īfter issuing a command to Sonarr, this command can retrieve additional details about Return only the specified series from the calendar. Specifies the DayOfWeeks to get entries in the specified date range. The end date to retrieve calendar entries from. The start date to retrieve calendar entries from. Gets the calendar schedule for the specified date range. WriteError from a base, , and Target Object. The base exception will be become the InnerException of the and its type will be used as the FullyQualifiedErrorId. WriteError from a given base exception and. The exception whose InnerException will be become the InnerException of the and its type will be used as the FullyQualifiedErrorId. WriteError from a given string message, base, , and Target Object. The object used as the 'targetObject' in an.
WriteError from a given string message,, and Target Object. The exception message to be displayed in the. WriteError from a given string message and. The exception to pull the innermost from. Takes in an and returns the innermost as a result. The JSON payload content to be sent with the PUT request. The Sonarr API endpoint to send the PUT request to. Sends a PUT request to the specified Sonarr endpoint with the specified string payload formatted in JSON The JSON payload content to be sent with the POST request. The Sonarr API endpoint to send the POST request to. Returning a JSON-formatted string in response. Sends a POST request to the specified Sonarr endpoint with the specified string payload formatted in JSON The Sonarr API endpoint to send the GET request to. Sends a GET request to the specified Sonarr endpoint returning a JSON-formatted string in response. The Sonarr API endpoint to send the DELETE request to. Sends a DELETE request to the specified Sonarr endpoint. Sends a GET request to the specified Sonarr endpoint and returning a JSON-formatted string in response. Includes custom API methods along with advanced error-handling. The main base class for all PoshSonarr cmdlets. The set of parameters to build the POST body with, Takes in a generic dictionary of parameters and issues a command to Sonarr with the dictionary as its payload. A base PowerShell class that provides functionality for posting commands to Sonarr.
0 kommentar(er)
