SnipeitPS/docs/Set-SnipeitInfo.md

73 lines
1.3 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:
2017-11-18 19:50:47 +00:00
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitInfo
2017-11-18 19:50:47 +00:00
## SYNOPSIS
2021-08-23 18:50:13 +03:00
Sets authetication information.
Deprecated, use Connect-SnipeitPS instead.
2017-11-18 19:50:47 +00:00
## SYNTAX
```
2021-08-23 18:50:13 +03:00
Set-SnipeitInfo [-url] <Uri> [-apiKey] <String> [<CommonParameters>]
2017-11-18 19:50:47 +00:00
```
## DESCRIPTION
2021-08-23 18:50:13 +03:00
Deprecated combatibilty function that Set apikey and url user to connect Snipe-It system.
Please use Connect-SnipeitPS instead.
2017-11-18 19:50:47 +00:00
## EXAMPLES
2021-05-19 15:51:49 +03:00
### EXAMPLE 1
2017-11-18 19:50:47 +00:00
```
2021-06-08 20:23:32 +03:00
Set-SnipeitInfo -url $url -apiKey -Verbose
2017-11-18 19:50:47 +00:00
```
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -apiKey
2021-08-23 18:50:13 +03:00
User's API Key for Snipeit.
2017-11-18 19:50:47 +00:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 19:50:47 +00:00
2021-08-23 18:50:13 +03:00
Required: True
2021-05-23 23:24:44 +03:00
Position: 2
2017-11-18 19:50:47 +00: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
URL of Snipeit system.
2017-11-18 19:50:47 +00:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Uri
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 19:50:47 +00:00
2021-08-23 18:50:13 +03:00
Required: True
2021-05-23 23:24:44 +03:00
Position: 1
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2018-04-29 08:58:34 +01:00
### 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
2017-11-18 19:50:47 +00:00
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS