SnipeitPS/docs/New-SnipeitCompany.md

135 lines
2.3 KiB
Markdown
Raw Normal View History

2021-06-14 10:00:06 +03:00
---
external help file: SnipeitPS-help.xml
2021-08-23 18:50:13 +03:00
Module Name: snipeitps
2021-06-14 10:00:06 +03:00
online version:
schema: 2.0.0
---
# New-SnipeitCompany
## SYNOPSIS
Creates a new Company
## SYNTAX
```
2021-08-23 18:50:13 +03:00
New-SnipeitCompany [-name] <String> [[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
2021-06-14 10:00:06 +03:00
```
## DESCRIPTION
Creates new company on Snipe-It system
## EXAMPLES
### EXAMPLE 1
```
New-SnipeitCompany -name "Acme Company"
```
## PARAMETERS
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
2021-06-14 10:00:06 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-08 23:59:31 +03:00
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image
2021-07-14 11:16:55 +03:00
Company image filename and path
2021-07-08 23:59:31 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
2021-06-14 10:00:06 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Comapany name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2021-06-14 10:00:06 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-08 23:59:31 +03:00
Position: 3
2021-06-14 10:00:06 +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