SnipeitPS/docs/New-SnipeItDepartment.md

178 lines
2.9 KiB
Markdown
Raw Normal View History

---
2018-04-29 08:58:34 +01:00
external help file: SnipeItPS-help.xml
2021-05-18 05:57:40 +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
---
# 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
```
New-SnipeItDepartment [-name] <String> [[-company_id] <Int32>] [[-location_id] <Int32>] [[-manager_id] <Int32>]
2021-05-18 05:57:40 +03:00
[[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-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-05-23 23:22:23 +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:22:23 +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
Required: True
2021-05-23 23:22:23 +03:00
Position: 1
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
```
### -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:22:23 +03:00
### -notes
{{ Fill notes Description }}
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:22:23 +03:00
Required: False
Position: 5
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:22:23 +03:00
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:22:23 +03:00
Required: True
Position: 6
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:22:23 +03:00
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
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
Required: True
2021-05-23 23:22:23 +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:22:23 +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:22:23 +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
```
2021-05-23 23:22:23 +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:22:23 +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
```
### 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