Get-RSS Cmdlet

Parameters Output Objects Configuration Settings

The Get-RSS cmdlet is used to retrieve and parse RSS syndicated content.

Syntax

Get-RSS [parameters]

Remarks

This cmdlet implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

To parse a feed, set the Feed parameter to the URL for the RSS feed. Each item parsed out of the Feed will be returned in an Item object. If required, authentication is provided with the Credential parameter.

By default, information will be returned for each item in the feed. If you would like to retrieve the information for the channel instead, use the Channel switch to retrieve a single Channel object.

You can also use the Property parameter to return a specific property of an item or the channel element. If Property is set, a single Property object will be returned.

To use SSL encryption to retrieve the Feed, set SSL to True.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# get the items of a feed
get-rss -feed http://www.nsoftware.com/rss/ |where {[datetime]$_.PubDate -gt $(Get-Date -month 12 -day 31 -year 2006)}
# get the channel element of a feed
get-rss -feed http://www.nsoftware.com/rss/ 
# get the description of the first item in the feed
get-rss -feed http://www.nsoftware.com/rss/ -property item[1]/description
# get the channel title
get-rss -feed http://www.nsoftware.com/rss/ -property channel/title

Parameter List

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.


LogFile	The location of a file to which debug information is written.
AuthenticationMode	The authentication mode to use when presenting login credentials to the server.
CertPassword	The password to the certificate store.
CertStore	The name of the certificate store for the client certificate.
CertStoreType	The type of certificate store for the client certificate.
CertSubject	The subject of the certificate used for client authentication.
Channel	Defines whether to get the channel information from the feed.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for user/password authentication.
Feed	The URL of the RSS feed to fetch.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Force	Forces the cmdlet to accept the default behavior instead of querying the user.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Password	The password to use for authentication.
Property	Get the value of a specific RSS feed property.
ProxyAutoDetect	Specifies if proxy information is automatically detected.
ProxyPassword	The password to authenticate with.
ProxyPort	The TCP port of the Proxy .
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	The User value to authenticate with.
RawData	Whether to return the XML of the feed without any parsing.
SSLAccept	The encoded public key of the certificate which is to be trusted explicitly.
Timeout	The maximum time allowed for the operation.
User	The username to use for authentication.

Output Objects

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.


Channel	If the Channel parameter is set, this object represents the channel information of the feed.
Cookie	This object contains the name and value of an HTTP cookie.
HTTP	This object contains the text of the downloaded web page.
Item	Created for each Item parsed from the RSS feed.
Property	Created for each Property found in the RSS feed.

Configuration Settings

The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.