SnipeitPS/docs/Set-SnipeitDepartment.md

242 lines
3.9 KiB
Markdown
Raw Permalink Normal View History

2021-06-14 00:19:47 +03:00
---
external help file: SnipeitPS-help.xml
2021-10-27 14:11:27 +03:00
Module Name: SnipeitPS
2021-06-14 00:19:47 +03:00
online version:
schema: 2.0.0
---
# Set-SnipeitDepartment
## SYNOPSIS
Updates a department
## SYNTAX
```
Set-SnipeitDepartment [-id] <Int32[]> [[-name] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
2021-07-14 11:16:55 +03:00
[[-manager_id] <Int32>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
2021-08-23 18:50:13 +03:00
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2021-06-14 00:19:47 +03:00
```
## DESCRIPTION
Updates the department on Snipe-It system
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeitDepartment -id 4 -manager_id 3
```
## PARAMETERS
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
2021-06-14 00:19:47 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 10
2021-06-14 00:19:47 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
ID number of company
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
2021-06-16 10:37:57 +03:00
Default value: None
2021-06-14 00:19:47 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Id number of Department
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
2021-07-08 23:59:31 +03:00
### -image
Image file name and path for item
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
2021-06-14 00:19:47 +03:00
### -location_id
ID number of location
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
2021-06-16 10:37:57 +03:00
Default value: None
2021-06-14 00:19:47 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
2021-06-16 10:37:57 +03:00
Default value: None
2021-06-14 00:19:47 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Department Name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
{{ Fill notes Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-07-14 11:16:55 +03:00
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
2021-06-14 00:19:47 +03:00
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2021-06-14 00:19:47 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 9
2021-06-14 00:19:47 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
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.
```yaml
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS