SnipeitPS/docs/Set-SnipeitLocation.md

285 lines
4.4 KiB
Markdown
Raw Normal View History

2021-05-23 23:22:23 +03:00
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-SnipeitLocation
## SYNOPSIS
Updates Location in Snipe-it asset system
## SYNTAX
```
2021-06-06 06:22:08 +03:00
Set-SnipeitLocation [-id] <Int32[]> [[-name] <String>] [[-address] <String>] [[-address2] <String>]
2021-05-25 16:11:47 +03:00
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-city] <String>] [[-currency] <String>]
[[-manager_id] <Int32>] [[-ldap_ou] <String>] [[-parent_id] <Int32>] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100
```
## PARAMETERS
2021-05-23 23:22:23 +03:00
### -address
Address line 1
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:22:23 +03:00
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:22:23 +03:00
### -address2
Address line 2
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:22:23 +03:00
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: True
2021-05-25 16:11:47 +03:00
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -city
City of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:22:23 +03:00
### -country
Address Contry
```yaml
2021-05-23 23:22:23 +03:00
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:22:23 +03:00
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-25 16:11:47 +03:00
### -currency
Currency used at the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
{{ Fill id Description }}
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
2021-05-23 23:24:44 +03:00
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
2021-06-06 06:22:08 +03:00
Accept pipeline input: True (ByPropertyName)
2021-05-23 23:24:44 +03:00
Accept wildcard characters: False
```
### -ldap_ou
LDAP OU of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-25 16:11:47 +03:00
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Location manager as id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-25 16:11:47 +03:00
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -name
Name of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -parent_id
Parent location as id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-25 16:11:47 +03:00
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -state
Address State
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-25 16:11:47 +03:00
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -zip
Address zipcode
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 7
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.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
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.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
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