2017-11-18 19:50:47 +00:00
|
|
|
---
|
|
|
|
|
external help file: SnipeItPS-help.xml
|
|
|
|
|
Module Name: SnipeItPS
|
|
|
|
|
online version:
|
|
|
|
|
schema: 2.0.0
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# New-Component
|
|
|
|
|
|
|
|
|
|
## SYNOPSIS
|
2017-11-20 09:07:58 +00:00
|
|
|
Short description
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
## SYNTAX
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
New-Component [-name] <String> [-category_id] <String> [-qty] <String> [-url] <String> [-apiKey] <String>
|
2017-11-18 21:41:35 +00:00
|
|
|
[-WhatIf] [-Confirm]
|
2017-11-18 19:50:47 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## DESCRIPTION
|
2017-11-20 09:07:58 +00:00
|
|
|
Long description
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
## EXAMPLES
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -------------------------- EXAMPLE 1 --------------------------
|
2017-11-18 19:50:47 +00:00
|
|
|
```
|
2017-11-20 09:07:58 +00:00
|
|
|
An example
|
2017-11-18 19:50:47 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## PARAMETERS
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -name
|
|
|
|
|
Parameter description
|
2017-11-18 21:41:35 +00:00
|
|
|
|
|
|
|
|
```yaml
|
2017-11-20 09:07:58 +00:00
|
|
|
Type: String
|
2017-11-18 21:41:35 +00:00
|
|
|
Parameter Sets: (All)
|
2017-11-20 09:07:58 +00:00
|
|
|
Aliases:
|
2017-11-18 21:41:35 +00:00
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
Required: True
|
|
|
|
|
Position: 1
|
2017-11-18 21:41:35 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -category_id
|
|
|
|
|
Parameter description
|
2017-11-18 21:41:35 +00:00
|
|
|
|
|
|
|
|
```yaml
|
2017-11-20 09:07:58 +00:00
|
|
|
Type: String
|
2017-11-18 21:41:35 +00:00
|
|
|
Parameter Sets: (All)
|
2017-11-20 09:07:58 +00:00
|
|
|
Aliases:
|
2017-11-18 21:41:35 +00:00
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
Required: True
|
|
|
|
|
Position: 2
|
2017-11-18 21:41:35 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -qty
|
|
|
|
|
Parameter description
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
Type: String
|
|
|
|
|
Parameter Sets: (All)
|
|
|
|
|
Aliases:
|
|
|
|
|
|
|
|
|
|
Required: True
|
2017-11-20 09:07:58 +00:00
|
|
|
Position: 3
|
2017-11-18 19:50:47 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -url
|
|
|
|
|
Parameter description
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
Type: String
|
|
|
|
|
Parameter Sets: (All)
|
|
|
|
|
Aliases:
|
|
|
|
|
|
|
|
|
|
Required: True
|
2017-11-20 09:07:58 +00:00
|
|
|
Position: 4
|
2017-11-18 19:50:47 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -apiKey
|
|
|
|
|
Parameter description
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
Type: String
|
|
|
|
|
Parameter Sets: (All)
|
|
|
|
|
Aliases:
|
|
|
|
|
|
|
|
|
|
Required: True
|
2017-11-20 09:07:58 +00:00
|
|
|
Position: 5
|
2017-11-18 19:50:47 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -WhatIf
|
|
|
|
|
Shows what would happen if the cmdlet runs.
|
|
|
|
|
The cmdlet is not run.
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
```yaml
|
2017-11-20 09:07:58 +00:00
|
|
|
Type: SwitchParameter
|
2017-11-18 19:50:47 +00:00
|
|
|
Parameter Sets: (All)
|
2017-11-20 09:07:58 +00:00
|
|
|
Aliases: wi
|
2017-11-18 19:50:47 +00:00
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
Required: False
|
|
|
|
|
Position: Named
|
2017-11-18 19:50:47 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
### -Confirm
|
|
|
|
|
Prompts you for confirmation before running the cmdlet.
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
```yaml
|
2017-11-20 09:07:58 +00:00
|
|
|
Type: SwitchParameter
|
2017-11-18 19:50:47 +00:00
|
|
|
Parameter Sets: (All)
|
2017-11-20 09:07:58 +00:00
|
|
|
Aliases: cf
|
2017-11-18 19:50:47 +00:00
|
|
|
|
2017-11-20 09:07:58 +00:00
|
|
|
Required: False
|
|
|
|
|
Position: Named
|
2017-11-18 19:50:47 +00:00
|
|
|
Default value: None
|
|
|
|
|
Accept pipeline input: False
|
|
|
|
|
Accept wildcard characters: False
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## INPUTS
|
|
|
|
|
|
|
|
|
|
## OUTPUTS
|
|
|
|
|
|
|
|
|
|
## NOTES
|
2017-11-20 09:07:58 +00:00
|
|
|
General notes
|
2017-11-18 19:50:47 +00:00
|
|
|
|
|
|
|
|
## RELATED LINKS
|
|
|
|
|
|