SnipeitPS/docs/New-Location.md

239 lines
3.8 KiB
Markdown
Raw Normal View History

2021-05-19 15:51:49 +03:00
---
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-Location
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Add a new Location to Snipe-it asset system
2018-04-29 08:58:34 +01:00
## SYNTAX
```
New-Location [-name] <String> [[-address] <String>] [[-address2] <String>] [[-state] <String>]
2021-05-18 05:57:40 +03:00
[[-country] <String>] [[-zip] <String>] [[-parent_id] <Int32>] [[-manager_id] <Int32>] [[-ldap_ou] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
2018-04-29 08:58:34 +01:00
```
## DESCRIPTION
Long description
## EXAMPLES
2021-05-18 05:57:40 +03:00
### EXAMPLE 1
2018-04-29 08:58:34 +01:00
```
2021-05-19 15:51:49 +03:00
New-Location -name "Room 1" -address "123 Asset Street" -parent_id 14
2018-04-29 08:58:34 +01:00
```
## PARAMETERS
### -address
2021-05-19 15:51:49 +03:00
Address line 1 of the location
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: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address2
2021-05-19 15:51:49 +03:00
Address line 2 of the location
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: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -apiKey
Users API Key for Snipeit, can be set using Set-Info 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
2021-05-18 05:57:40 +03:00
Required: True
Position: 11
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -country
2021-05-19 15:51:49 +03:00
Country of the location
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: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -ldap_ou
The LDAP OU of the location
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: False
2021-05-18 05:57:40 +03:00
Position: 9
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -manager_id
The manager ID of the location
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
2021-05-19 15:51:49 +03:00
Name of the Location
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-18 05:57:40 +03:00
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -parent_id
Parent location ID for the location
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2018-04-29 08:58:34 +01:00
Position: 7
2021-05-18 05:57:40 +03:00
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -state
2021-05-19 15:51:49 +03:00
Address State of the location
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -url
URL of Snipeit system, can be set using Set-Info 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-18 05:57:40 +03:00
Position: 10
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -zip
2021-05-19 15:51:49 +03:00
The zip code of the location
2018-04-29 08:58:34 +01:00
```yaml
2021-05-18 05:57:40 +03:00
Type: String
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
2021-05-18 05:57:40 +03:00
Position: 6
2018-04-29 08:58:34 +01: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
```
2021-05-18 05:57:40 +03:00
### -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
```
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
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS