3.5 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| SnipeitPS-help.xml | SnipeitPS | 2.0.0 |
Get-SnipeitDepartment
SYNOPSIS
Gets a list of Snipe-it Departments
SYNTAX
Search
<<<<<<< HEAD:docs/Get-SnipeitDepartment.md
Get-SnipeitDepartment [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [[-sort] <String>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
=======
Get-SnipeItDepartment [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
[-sort <String>] -url <String> -apiKey <String> [<CommonParameters>]
Get with ID
Get-SnipeItDepartment [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
>>>>>>> 9f68e602e32566c28846ccb9572fa0b078d64696:docs/Get-SnipeItDepartment.md
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
EXAMPLE 1
Get-SnipeitDepartment -url "https://assets.example.com" -token "token..."
EXAMPLE 2
Get-SnipeitDepartment -search Department1
EXAMPLE 3
Get-SnipeitDepartment -id 1
PARAMETERS
-all
A return all results, works with -offset and other parameters
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-id
A id of specific Department
Type: Int32
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-limit
Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
-offset
Offset to use
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-order
{{ Fill order Description }}
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
-search
A text string to search the Departments data
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-sort
{{ Fill sort Description }}
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
-url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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.