SnipeitPS/docs/New-SnipeitDepartment.md

211 lines
3.5 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-10-27 14:11:27 +03:00
Module Name: SnipeitPS
2021-05-19 15:51:49 +03:00
online version:
2018-04-29 08:58:34 +01:00
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# New-SnipeitDepartment
2018-04-29 08:58:34 +01:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Creates a department
2018-04-29 08:58:34 +01:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
New-SnipeitDepartment [-name] <String> [[-company_id] <Int32>] [[-location_id] <Int32>] [[-manager_id] <Int32>]
2021-08-23 18:50:13 +03:00
[[-notes] <String>] [[-image] <String>] [-image_delete] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
2021-07-08 23:59:31 +03:00
[-Confirm] [<CommonParameters>]
2018-04-29 08:58:34 +01:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Creates a new department on Snipe-It system
2018-04-29 08:58:34 +01:00
## EXAMPLES
2021-05-18 05:57:40 +03:00
### EXAMPLE 1
2018-04-29 08:58:34 +01:00
```
2021-06-08 20:23:32 +03:00
New-SnipeitDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
2018-04-29 08:58:34 +01:00
```
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-08 23:59:31 +03:00
Position: 8
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
2021-05-19 15:51:49 +03:00
ID number of company
2018-04-29 08:58:34 +01:00
```yaml
2021-05-18 05:57:40 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
Position: 2
2021-05-19 15:51:49 +03:00
Default value: 0
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-07-08 23:59:31 +03:00
### -image
2021-07-14 11:16:55 +03:00
Department Image filename and path
2021-07-08 23:59:31 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
2021-07-14 11:16:55 +03:00
{{ Fill image_delete Description }}
2021-07-08 23:59:31 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
2018-04-29 08:58:34 +01:00
### -location_id
2021-05-19 15:51:49 +03:00
ID number of location
2018-04-29 08:58:34 +01:00
```yaml
2021-05-18 05:57:40 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
Position: 3
2021-05-19 15:51:49 +03:00
Default value: 0
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
2021-05-19 15:51:49 +03:00
ID number of manager
2018-04-29 08:58:34 +01:00
```yaml
2021-05-18 05:57:40 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
Position: 4
2021-05-19 15:51:49 +03:00
Default value: 0
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -name
Department Name
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -notes
{{ Fill notes Description }}
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 5
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-08 23:59:31 +03:00
Position: 7
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2018-04-29 08:58:34 +01:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2018-04-29 08:58:34 +01:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
2018-04-29 08:58:34 +01:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2018-04-29 08:58:34 +01:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
2021-05-18 05:57:40 +03:00
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).
2018-04-29 08:58:34 +01:00
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS