Get-SCSMAnnouncement

Get-SCSMAnnouncement

Retrieves announcements that are defined in Service Manager.

Syntax

Parameter Set: Default
Get-SCSMAnnouncement [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-DisplayName <String> ] [-Id <String> ] [-Priority <String> ] [-SCSession <Connection[]> ] [-Title <String> ] [ <CommonParameters>]

Detailed Description

The Get-SCSMAnnouncement cmdlet retrieves announcements that are defined in Service Manager. This includes announcements that have been published and that have expired. You can restrict the results by providing a filter or criteria. Use the Where-Object cmdlet to retrieve only announcements that are active or that have expired. The Title, Id, and Name parameters are additive. If you use the Title and the Id parameters, only those announcements which satisfy both parameters are returned.

Parameters

-ComputerName<String[]>

Specifies the name of the computer on which the System Center Data Access service runs. The user account that is specified in the Credential parameter must have access rights to the specified computer.

Aliases

none

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the credentials that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights to that server.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-DisplayName<String>

Specifies the display name of an announcement. You can specify a regular expression.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id<String>

Specifies the ID of the announcement to retrieve.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Priority<String>

Specifies the priority of an announcement. This allows you to retrieve announcements of a specified priority. Allowed values are Medium, Critical, Low, and custom values.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Represents the session to the Service Manager server.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Title<String>

Specifies the title of the announcement. This parameter accepts a wildcard character.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.

    You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Announcement.Item

    The output of this cmdlet is a list of announcements.

Examples

Example 1: Get all announcements

This command retrieves all announcements that are defined in Service Manager.

C:\PS>Get-SCSMAmannouncement

Example 2: Get announcements for an ID

This command retrieves the announcement in which the ID equals 008.

C:\PS>Get-SCSMAmannouncement -Id "008"

Example 3: Get announcements for a title

This command retrieves the announcement in which the title equals 33.

C:\PS>Get-SCSMAmannouncement -Title "33"

New-SCSMAnnouncement

Update-SCSMAnnouncement

Remove-SCSMAnnouncement