Skip to content
Logic.Monitor PowerShell Module

Set-LMLogPartition

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Set-LMLogPartition [-Id <int>] [-Description <string>] [-Retention <int>] [-Sku <string>]
 [-Status <string>] [-ContractIntervalHours <int>] [-AutoRestartOnRenewal <bool>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

IdUsageLimit

Section titled “IdUsageLimit”
Terminal window
Set-LMLogPartition -Id <int> -UsageLimit <string> -StopIngestionOnLimit <bool>
 [-Description <string>] [-Retention <int>] [-Sku <string>] [-Status <string>]
 [-ContractIntervalHours <int>] [-AutoRestartOnRenewal <bool>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

NameUsageLimit

Section titled “NameUsageLimit”
Terminal window
Set-LMLogPartition -Name <string> -UsageLimit <string> -StopIngestionOnLimit <bool>
 [-Description <string>] [-Retention <int>] [-Sku <string>] [-Status <string>]
 [-ContractIntervalHours <int>] [-AutoRestartOnRenewal <bool>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Set-LMLogPartition -Name <string> [-Description <string>] [-Retention <int>] [-Sku <string>]
 [-Status <string>] [-ContractIntervalHours <int>] [-AutoRestartOnRenewal <bool>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Set-LMLogPartition function modifies an existing log partition in LogicMonitor.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Set-LMLogPartition -Id 123 -Description "New description" -Retention 30 -Status "active"

Updates the log partition with ID 123 with a new description, retention, and status.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Set-LMLogPartition -Id 123 -UsageLimit "100GB" -StopIngestionOnLimit $true -AutoRestartOnRenewal $true

Updates usage limit controls for the log partition with ID 123.

Parameters

Section titled “Parameters”

-AutoRestartOnRenewal

Section titled “-AutoRestartOnRenewal”

When true, ingestion automatically restarts on contract renewal.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Section titled “-Confirm”

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ContractIntervalHours

Section titled “-ContractIntervalHours”

The contract interval in hours. 0 = monthly (1st of next month), 24 = daily, 168 = weekly (next Monday), or a custom hour value.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Description

Section titled “-Description”

Specifies the new description for the log partition.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

Specifies the ID of the log partition to modify.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: IdUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
- Name: Id
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Section titled “-Name”

Specifies the current name of the log partition.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Retention

Section titled “-Retention”

Specifies the new retention for the log partition.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Sku

Section titled “-Sku”

Specifies the new sku for the log partition.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Status

Section titled “-Status”

Specifies the new status for the log partition. Possible values are “active” or “inactive”.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-StopIngestionOnLimit

Section titled “-StopIngestionOnLimit”

When true, ingestion stops when the usage limit is exceeded. Use with the UsageLimit parameter set together with UsageLimit.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UsageLimit

Section titled “-UsageLimit”

The usage limit for the log partition contract, for example 100GB. Use with the UsageLimit parameter set together with StopIngestionOnLimit.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdUsageLimit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Section titled “-WhatIf”

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

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