Skip to main content

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​

Gets a custom field by field name.

SYNTAX​

Get-NinjaOneCustomField [-FieldName] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves a specific custom field by its unique field name from the NinjaOne v2 API.

EXAMPLES​

EXAMPLE 1​

Get-NinjaOneCustomField -FieldName 'department'

Gets the custom field with the name 'department'.

PARAMETERS​

-FieldName​

The field name of the custom field

Type: String
Parameter Sets: (All)
Aliases: name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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 custom field.​

NOTES​

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/customfield

Last updated on by Mikey O'Toole