New-PveClusterNotificationsMatchers

Create a new matcher

API: POST /cluster/notifications/matchers, Proxmox VE API viewer

Syntax

New-PveClusterNotificationsMatchers
    [-PveTicket <PveTicket>]
    [-Comment <string>]
    [-Disable <bool>]
    [-InvertMatch <bool>]
    [-MatchCalendar <array>]
    [-MatchField <array>]
    [-MatchSeverity <array>]
    [-Mode <string>]
    -Name <string>
    [-Target <array>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Comment	string	No	Comment.
-Disable	bool	No	Disable this matcher.
-InvertMatch	bool	No	Invert match of the whole matcher.
-MatchCalendar	array	No	Match notification timestamp.
-MatchField	array	No	Metadata fields to match (regex or exact match). Must be in the form (regex|exact):<field>=<value>.
-MatchSeverity	array	No	Notification severities to match.
-Mode	string	No	Choose between ‘all’ and ‘any’ for when multiple properties are specified. Values: all, any.
-Name	string	Yes	Name of the matcher.
-Target	array	No	Targets to notify on match.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.