3.3 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| SnipeItPS-help.xml | SnipeitPS | 2.0.0 |
New-CustomField
SYNOPSIS
Add a new Custom Field to Snipe-it asset system
SYNTAX
New-CustomField [-Name] <String> [[-HelpText] <String>] [[-Element] <String>] [[-Format] <String>]
[[-field_encrypted] <Boolean>] [[-CustomFormat] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Add a new Custom Field to Snipe-it asset system
EXAMPLES
EXAMPLE 1
New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
PARAMETERS
-apiKey
Users API Key for Snipeit, can be set using Set-Info command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CustomFormat
{{ Fill CustomFormat Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Element
{{ Fill Element Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Text
Accept pipeline input: False
Accept wildcard characters: False
-field_encrypted
{{ Fill field_encrypted Description }}
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Format
{{ Fill Format Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: ANY
Accept pipeline input: False
Accept wildcard characters: False
-HelpText
{{ Fill HelpText Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Name of the Custom Field
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-url
URL of Snipeit system, can be set using Set-Info command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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
-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
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.