New-LMOpsNote
Syntax
Section titled “Syntax”New-LMOpsNote [-Note] <String> [[-NoteDate] <DateTime>] [[-Tags] <String[]>] [[-DeviceGroupIds] <String[]>] [[-WebsiteIds] <String[]>] [[-DeviceIds] <String[]>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The New-LMOpsNote function is used to create a new OpsNote in LogicMonitor. OpsNotes are used to document important information or events related to monitoring.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”New-LMOpsNote -Note "Server maintenance scheduled for tomorrow" -NoteDate (Get-Date).AddDays(1) -Tags "maintenance", "server"This example creates a new OpsNote with the content “Server maintenance scheduled for tomorrow” and a note date set to tomorrow. It also associates the tags “maintenance” and “server” with the OpsNote.
Parameters
Section titled “Parameters”Specifies the content of the OpsNote. This parameter is mandatory.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-NoteDate
Section titled “-NoteDate”Specifies the date and time of the OpsNote. If not provided, the current date and time will be used.
Type: DateTimeParameter Sets: (All)Aliases:
Required: FalsePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseSpecifies an array of tags to associate with the OpsNote.
Type: String[]Parameter Sets: (All)Aliases:
Required: FalsePosition: 3Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-DeviceGroupIds
Section titled “-DeviceGroupIds”Specifies an array of device group IDs to associate with the OpsNote.
Type: String[]Parameter Sets: (All)Aliases:
Required: FalsePosition: 4Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WebsiteIds
Section titled “-WebsiteIds”Specifies an array of website IDs to associate with the OpsNote.
Type: String[]Parameter Sets: (All)Aliases:
Required: FalsePosition: 5Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-DeviceIds
Section titled “-DeviceIds”Specifies an array of device IDs to associate with the OpsNote.
Type: String[]Parameter Sets: (All)Aliases:
Required: FalsePosition: 6Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
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.OpsNote object.
Section titled “Returns LogicMonitor.OpsNote object.”You must run Connect-LMAccount before running this command.