Skip to content
Logic.Monitor PowerShell Module

Copy-LMDevicePropertyToGroup

Syntax

Section titled “Syntax”

SourceDevice (Default)

Section titled “SourceDevice (Default)”
Terminal window
Copy-LMDevicePropertyToGroup -SourceDeviceId <string> -TargetGroupId <string[]>
 -PropertyNames <string[]> [-PassThru] [<CommonParameters>]

SourceGroup

Section titled “SourceGroup”
Terminal window
Copy-LMDevicePropertyToGroup -SourceGroupId <string> -TargetGroupId <string[]>
 -PropertyNames <string[]> [-PassThru] [<CommonParameters>]

Description

Section titled “Description”

The Copy-LMDevicePropertyToGroup function copies specified properties from a source device to one or more target device groups. The source device can be randomly selected from a group or explicitly specified. Properties are copied to the target groups while preserving other existing group properties.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Copy-LMDevicePropertyToGroup -SourceDeviceId 123 -TargetGroupId 456 -PropertyNames "location","department"

Copies the location and department properties from device 123 to group 456.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Copy-LMDevicePropertyToGroup -SourceGroupId 789 -TargetGroupId 456,457 -PropertyNames "location" -PassThru
Randomly selects a device from group 789 and copies its location property to groups 456 and 457, returning the updated groups.

Parameters

Section titled “Parameters”

-PassThru

Section titled “-PassThru”

If specified, returns the updated device group objects.

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

-PropertyNames

Section titled “-PropertyNames”

Array of property names to copy. These can be only be custom properties directly assigned to the device.

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

-SourceDeviceId

Section titled “-SourceDeviceId”

The ID of the source device to copy properties from. This parameter is part of the “SourceDevice” parameter set.

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

-SourceGroupId

Section titled “-SourceGroupId”

The ID of the source group to randomly select a device from. This parameter is part of the “SourceGroup” parameter set.

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

-TargetGroupId

Section titled “-TargetGroupId”

The ID of the target group(s) to copy properties to. Multiple group IDs can be specified.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  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.