Skip to content
Logic.Monitor PowerShell Module

New-LMRecipientGroup

Syntax

Section titled “Syntax”
Terminal window
New-LMRecipientGroup [-Name] <String> [[-Description] <String>] [-Recipients] <Array>
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The New-LMRecipientGroup function creates a new LogicMonitor recipient group with the specified parameters.

Examples

Section titled “Examples”

Example 1

Section titled “Example 1”
Terminal window
$recipients = @(
    New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'email'
    New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'sms'
    New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'voice'
    New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'smsemail'
    New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method '<name_of_existing_integration>'
    New-LMRecipient -Type 'ARBITRARY' -Addr 'someone@other.com' -Method 'email'
    New-LMRecipient -Type 'GROUP' -Addr 'Helpdesk'
)
New-LMRecipientGroup -Name "MyRecipientGroup" -Description "This is a test recipient group" -Recipients $recipients
This example creates a new LogicMonitor recipient group named "MyRecipientGroup" with a description and recipients built using the New-LMRecipient function.

Parameters

Section titled “Parameters”

-Name

Section titled “-Name”

The name of the recipient group. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases:


Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Section titled “-Description”

The description of the recipient group.

Type: String
Parameter Sets: (All)
Aliases:


Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Recipients

Section titled “-Recipients”

A object containing the recipients for the recipient group. The object must contain a “method”, “type” and “addr” key.

Type: Array
Parameter Sets: (All)
Aliases:


Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Section titled “-WhatIf”

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi


Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Section titled “-Confirm”

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf


Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Section titled “-ProgressAction”

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga


Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Section titled “Inputs”

None. You cannot pipe objects to this command.

Section titled “None. You cannot pipe objects to this command.”

Outputs

Section titled “Outputs”

Returns LogicMonitor.RecipientGroup object.

Section titled “Returns LogicMonitor.RecipientGroup object.”

Notes

Section titled “Notes”

This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command.

Section titled “Related LINKS”