Location Custom Fields

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Sets an location's custom fields.

SYNTAX

Set-NinjaOneLocationCustomFields [-organisationId] <Int32> [-locationId] <Int32>
 [-locationCustomFields] <Object> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sets location custom field values using the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

$LocationCustomFields = @{
    field1 = 'value1'
    field2 = 'value2'
}
PS> Update-NinjaOneLocationCustomFields -organisationId 1 -locationId 2 -locationCustomFields $LocationCustomFields

Updates the custom fields for the location with id 2 belonging to the organisation with id 1.

EXAMPLE 2

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
    additionalProp1 = @{
    }
}
PS> Set-NinjaOneLocationCustomFields -organisationId 1 -locationId 1 -locationCustomFields $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-organisationId

The organisation to set the custom fields for.

Type: Int32
Parameter Sets: (All)
Aliases: id, organizationId

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-locationId

The location to set the custom fields for.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-locationCustomFields

The organisation custom field body object.

Type: Object
Parameter Sets: (All)
Aliases: customFields, body

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

-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

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

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

OUTPUTS

A powershell object containing the response.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/locationcustomfields