dips/SnipeitPS
1
0
Fork 0
mirror of https://github.com/snazy2000/SnipeitPS.git synced 2025-12-13 01:42:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs and examples

Browse source
This commit is contained in:
Petri Asikainen 2021-05-23 23:24:44 +03:00
parent 7d95d5078f
commit 06305b1b63
41 changed files with 2448 additions and 2457 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

174
docs/Get-SnipeItAccessory.md
View file

@ -35,36 +35,36 @@ Get-SnipeItAccessory -id 1
## PARAMETERS
### -search
A text string to search the Accessory data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -80,8 +80,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
@ -89,57 +89,12 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -157,6 +112,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Result offset to use
@ -172,17 +142,62 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 7
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Accessory data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -202,21 +217,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
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).

328
docs/Get-SnipeItAsset.md
View file

@ -47,46 +47,31 @@ Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token
## PARAMETERS
### -search
A text string to search the assets data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Exact asset tag to query
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Required: True
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -107,32 +92,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optionally restrict asset results to this order number
### -asset_tag
Exact asset tag to query
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Optionally restrict asset results to this asset model ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -152,21 +122,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optionally restrict asset results to this company ID
@ -182,6 +137,53 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Optionally restrict asset results to this location ID
@ -197,8 +199,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
@ -206,7 +208,67 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Optionally restrict asset results to this asset model ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optionally restrict asset results to this order number
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -227,6 +289,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the assets data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -status
Optionally restrict asset results to one of these status types: RTD, Deployed, Undeployable, Deleted, Archived, Requestable
@ -257,83 +349,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -349,21 +364,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 20
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).

128
docs/Get-SnipeItAssetMaintenance.md
View file

@ -39,16 +39,31 @@ Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.co
## PARAMETERS
### -search
Search string
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -69,36 +84,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -116,21 +101,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -146,6 +116,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
Search string
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -161,21 +176,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
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).

78
docs/Get-SnipeItCategory.md
View file

@ -34,16 +34,31 @@ Get-SnipeItCategory -search "Laptop"
## PARAMETERS
### -search
A text string to search the Categories data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -64,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,17 +111,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Categories data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -141,21 +156,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

78
docs/Get-SnipeItCompany.md
View file

@ -38,16 +38,31 @@ Gets specific company
## PARAMETERS
### -search
A text string to search the Companies data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -68,21 +83,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -115,17 +115,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Companies data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -145,21 +160,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

144
docs/Get-SnipeItComponent.md
View file

@ -46,36 +46,36 @@ Returns specific component
## PARAMETERS
### -search
A text string to search the Components data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Component
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -106,8 +106,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
### -id
A id of specific Component
```yaml
Type: Int32
@ -115,42 +115,12 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -168,6 +138,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -183,17 +168,47 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 6
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Components data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
@ -213,21 +228,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
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).

30
docs/Get-SnipeItCustomField.md
View file

@ -28,6 +28,21 @@ Get-SnipeItCustomField -url "https://assets.example.com" -token "token..."
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific field
@ -58,21 +73,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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).

78
docs/Get-SnipeItDepartment.md
View file

@ -39,16 +39,31 @@ Get-SnipeItDepartment -id 1
## PARAMETERS
### -search
A text string to search the Departments data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -69,21 +84,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -116,17 +116,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Departments data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -161,21 +176,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
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).

30
docs/Get-SnipeItFieldset.md
View file

@ -33,6 +33,21 @@ Get-SnipeItFieldset -url "https://assets.example.com" -token "token..." | Where-
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific fieldset
@ -63,21 +78,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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).

318
docs/Get-SnipeItLicense.md
View file

@ -37,23 +37,38 @@ Get-SnipeItLicense -id 1
## PARAMETERS
### -search
A text string to search the Licenses data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific License
### -category_id
{{ Fill category_id Description }}
```yaml
Type: Int32
@ -61,27 +76,12 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
{{ Fill name Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
@ -97,111 +97,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -product_key
{{ Fill product_key Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{ Fill order_number Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_order
{{ Fill purchase_order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_name
{{ Fill license_name Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
{{ Fill license_email Description }}
```yaml
Type: MailAddress
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
@ -217,8 +112,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
### -id
A id of specific License
```yaml
Type: Int32
@ -226,29 +121,29 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -license_email
{{ Fill license_email Description }}
```yaml
Type: String
Type: MailAddress
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: Desc
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
### -license_name
{{ Fill license_name Description }}
```yaml
Type: String
@ -256,8 +151,8 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -279,6 +174,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
{{ Fill name Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -294,17 +219,107 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 14
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{ Fill order_number Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -product_key
{{ Fill product_key Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_order
{{ Fill purchase_order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Licenses data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -324,21 +339,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 19
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).

70
docs/Get-SnipeItLicenseSeat.md
View file

@ -29,6 +29,36 @@ Get-SnipeItLicenseSeat -id 1
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific License
@ -44,21 +74,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
A id of specific seat
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -91,17 +106,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -seat_id
A id of specific seat
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -121,21 +136,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
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).

80
docs/Get-SnipeItManufacturer.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -38,16 +38,31 @@ Returns manufacturer with id 3
## PARAMETERS
### -search
A text string to search the Manufactures data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -68,21 +83,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -115,17 +115,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Manufactures data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -145,21 +160,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

78
docs/Get-SnipeItModel.md
View file

@ -34,16 +34,31 @@ Get-SnipeItModel -id 1
## PARAMETERS
### -search
A text string to search the Models data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -64,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,17 +111,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Models data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -141,21 +156,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

78
docs/Get-SnipeItStatus.md
View file

@ -34,16 +34,31 @@ Get-SnipeItStatus -id 3
## PARAMETERS
### -search
A text string to search the Status Labels data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -64,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,17 +111,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Status Labels data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -141,21 +156,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

80
docs/Get-SnipeItSupplier.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -34,16 +34,31 @@ Get-SnipeItSupplier -id 2
## PARAMETERS
### -search
A text string to search the Supliers data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -64,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,17 +111,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Supliers data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -141,21 +156,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

136
docs/Get-SnipeItUser.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -46,31 +46,31 @@ Get-SnipeItUser -email user@somedomain.com
## PARAMETERS
### -search
A text string to search the User data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -91,36 +91,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -group_id
{{ Fill group_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
{{ Fill department_id Description }}
@ -136,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Search string for username field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Search string for email field
@ -166,8 +121,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -group_id
{{ Fill group_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
```yaml
Type: String
@ -175,8 +145,8 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Desc
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -198,6 +168,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -213,17 +198,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 9
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the User data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -243,16 +243,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -username
Search string for username field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

78
docs/Get-SnipeitLocation.md
View file

@ -34,16 +34,31 @@ Get-SnipeItLocation -id 3
## PARAMETERS
### -search
A text string to search the Locations data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -64,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,17 +111,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -order
{{ Fill order Description }}
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Locations data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -141,21 +156,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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).

238
docs/New-SnipeItAsset.md
View file

@ -48,21 +48,67 @@ Using customfields when creating asset.
## PARAMETERS
### -status_id
Required Status ID of the asset, this can be got using Get-Status
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Asset Tag for the Asset, not required when snipe asset_tag autogeneration is on.
```yaml
Type: String
Parameter Sets: (All)
Aliases: tag
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit.
Use internal field names from snipeit .You can use Get-CustomField to get internal field names.
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Required Model ID of the asset, this can be got using Get-Model
@ -93,66 +139,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Asset Tag for the Asset, not required when snipe asset_tag autogeneration is on.
```yaml
Type: String
Parameter Sets: (All)
Aliases: tag
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Optional Serial number of the Asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optional Order number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional Notes
@ -168,17 +154,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
{{ Fill warranty_months Description }}
### -order_number
Optional Order number
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -213,21 +199,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -rtd_location_id
Optional Default location id for the asset
@ -243,6 +214,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Optional Serial number of the Asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
Required Status ID of the asset, this can be got using Get-Status
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -258,32 +274,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -warranty_months
{{ Fill warranty_months Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit.
Use internal field names from snipeit .You can use Get-CustomField to get internal field names.
```yaml
Type: Hashtable
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Position: 9
Default value: 0
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
@ -305,21 +320,6 @@ 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
```
### 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).

158
docs/New-SnipeItAssetMaintenance.md
View file

@ -31,6 +31,21 @@ New-SnipeItAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard"
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
Required ID of the asset, this can be got using Get-Asset
@ -46,21 +61,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
Required maintenance supplier
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_maintenance_type
{{ Fill asset_maintenance_type Description }}
@ -76,16 +76,61 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -title
Required Title of maintenance
### -completion_date
{{ Fill completion_date Description }}
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -cost
Optional cost
```yaml
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -is_warranty
Optional Maintenance done under warranty
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional cost
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -106,61 +151,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -completion_date
{{ Fill completion_date Description }}
### -supplier_id
Required maintenance supplier
```yaml
Type: DateTime
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -is_warranty
Optional Maintenance done under warranty
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -cost
Optional cost
```yaml
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional cost
### -title
Required Title of maintenance
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,16 +196,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 11
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -212,21 +227,6 @@ 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
```
### 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).

104
docs/New-SnipeItCategory.md
View file

@ -29,8 +29,8 @@ New-SnipeItCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here
## PARAMETERS
### -name
Name of new category to be created
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -38,7 +38,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -59,6 +59,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
If switch is present, send email to user on checkin/checkout
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of new category to be created
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -74,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -use_default_eula
If switch is present, use the primary default EULA
@ -104,32 +134,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
If switch is present, send email to user on checkin/checkout
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -150,21 +165,6 @@ 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
```
### 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).

88
docs/New-SnipeItComponent.md
View file

@ -30,8 +30,8 @@ An example
## PARAMETERS
### -name
Component name
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -39,7 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -60,21 +60,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
@ -105,16 +90,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
### -name
Component name
```yaml
Type: DateTime
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,6 +120,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -150,16 +165,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 9
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,21 +196,6 @@ 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
```
### 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).

90
docs/New-SnipeItCustomField.md
View file

@ -30,8 +30,8 @@ New-SnipeItCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I
## PARAMETERS
### -Name
Name of the Custom Field
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -39,14 +39,14 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -HelpText
{{ Fill HelpText Description }}
### -CustomFormat
{{ Fill CustomFormat Description }}
```yaml
Type: String
@ -54,7 +54,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,21 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Format
{{ Fill Format Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: ANY
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_encrypted
{{ Fill field_encrypted Description }}
@ -105,8 +90,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -CustomFormat
{{ Fill CustomFormat Description }}
### -Format
{{ Fill Format Description }}
```yaml
Type: String
@ -114,7 +99,37 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 4
Default value: ANY
Accept pipeline input: False
Accept wildcard characters: False
```
### -HelpText
{{ Fill HelpText Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Name of the Custom Field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,16 +150,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 8
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -166,21 +181,6 @@ 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
```
### 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).

48
docs/New-SnipeItDepartment.md
View file

@ -29,8 +29,8 @@ New-SnipeItDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager
## PARAMETERS
### -name
Department Name
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -38,7 +38,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -89,6 +89,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Department Name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
{{ Fill notes Description }}
@ -119,16 +134,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 7
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -150,21 +165,6 @@ 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
```
### 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).

78
docs/New-SnipeItLicense.md
View file

@ -33,8 +33,8 @@ New-SnipeItLicence -name "License" -seats 3 -company_id 1
## PARAMETERS
### -name
Name of license being created
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -42,27 +42,12 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -168,6 +153,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license being created
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
License Notes
@ -243,6 +243,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serialnumber of license
@ -303,16 +318,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 19
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -334,21 +349,6 @@ 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
```
### 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).

118
docs/New-SnipeItLocation.md
View file

@ -30,21 +30,6 @@ New-SnipeItLocation -name "Room 1" -address "123 Asset Street" -parent_id 14
## PARAMETERS
### -name
Name of the Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address
Address line 1 of the location
@ -75,16 +60,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State of the location
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -105,8 +90,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
The zip code of the location
### -ldap_ou
The LDAP OU of the location
```yaml
Type: String
@ -114,7 +99,37 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -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
Name of the Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,23 +150,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -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
```
### -ldap_ou
The LDAP OU of the location
### -state
Address State of the location
```yaml
Type: String
@ -159,7 +159,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -180,16 +180,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -zip
The zip code of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Required: False
Position: 6
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
@ -211,21 +226,6 @@ 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
```
### 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).

42
docs/New-SnipeItManufacturer.md
View file

@ -29,6 +29,21 @@ New-SnipeItManufacturer -name "HP"
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Name of the Manufacturer
@ -59,16 +74,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 3
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -90,21 +105,6 @@ 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
```
### 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).

108
docs/New-SnipeItModel.md
View file

@ -30,8 +30,8 @@ New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
## PARAMETERS
### -name
Name of the Asset Model
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -39,22 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,21 +60,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -eol
{{ Fill eol Description }}
@ -120,6 +90,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -135,16 +150,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 8
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -166,21 +181,6 @@ 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
```
### 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).

294
docs/New-SnipeItUser.md
View file

@ -34,66 +34,6 @@ Creates new a new user who can't login to system
## PARAMETERS
### -first_name
Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Users last name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Username for user
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -password
{{ Fill password Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
{{ Fill activated Description }}
@ -109,61 +49,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Phone number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Required: True
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -184,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
@ -214,17 +94,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
### -email
email address
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -244,6 +124,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Users last name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_import
Mark user as import from ldap
@ -259,6 +184,81 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -password
{{ Fill password Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Phone number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -274,8 +274,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -username
Username for user
```yaml
Type: String
@ -283,7 +283,22 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Position: 3
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
@ -305,21 +320,6 @@ 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
```
### 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).

42
docs/Remove-SnipeItAsset.md
View file

@ -28,6 +28,21 @@ Remove-SnipeItAsset -ID 44 -Verbose
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ID
Unique ID For Asset to be removed
@ -58,16 +73,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 3
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -89,21 +104,6 @@ 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
```
### 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).

42
docs/Remove-SnipeItUser.md
View file

@ -28,6 +28,21 @@ Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ID
Unique ID For User to be removed
@ -58,16 +73,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 3
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -89,21 +104,6 @@ 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
```
### 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).

120
docs/Set-SnipeItAccessory.md
View file

@ -31,51 +31,21 @@ Set-SnipeItAccessory -id 1 -qty 3
## PARAMETERS
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
ID number of Accessory on Snipe-It system
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the accessory you have
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
ID number of the category the accessory belongs to
@ -106,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
ID number of the manufacturer for this accessory.
@ -121,6 +106,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_qty
Min quantity of the accessory before alert is triggered
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
ID number of Accessory on Snipe-It system
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number for this accessory.
@ -166,17 +181,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_qty
Min quantity of the accessory before alert is triggered
### -qty
Quantity of the accessory you have
```yaml
Type: Boolean
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -211,16 +226,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 13
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -242,21 +257,6 @@ 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
```
### 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).

244
docs/Set-SnipeItAsset.md
View file

@ -37,77 +37,33 @@ Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues =
## PARAMETERS
### -id
ID of the Asset
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Asset name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Status_id
Status ID of the asset, this can be got using Get-Status
### -archived
Whether or not the asset is archived.
Archived assets cannot be checked out and do not show up in the deployable asset screens
```yaml
Type: String
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Model_id
Model ID of the asset, this can be got using Get-Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_checkout
Date the asset was last checked out
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -142,8 +98,53 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serial number of the asset
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID of the Asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_checkout
Date the asset was last checked out
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Model_id
Model ID of the asset, this can be got using Get-Model
```yaml
Type: String
@ -151,7 +152,22 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Asset name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -172,21 +188,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
Number of months for the asset warranty
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Purchase cost of the asset, without a currency symbol
@ -232,22 +233,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -archived
Whether or not the asset is archived.
Archived assets cannot be checked out and do not show up in the deployable asset screens
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -rtd_location_id
The id that corresponds to the location where the asset is usually located when not checked out
@ -263,6 +248,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serial number of the asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Status_id
Status ID of the asset, this can be got using Get-Status
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
@ -278,31 +293,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
### -warranty_months
Number of months for the asset warranty
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
```yaml
Type: Hashtable
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Position: 10
Default value: 0
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
@ -324,21 +339,6 @@ 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
```
### 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).

112
docs/Set-SnipeItAssetOwner.md
View file

@ -30,17 +30,17 @@ Set-SnipeItAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing
## PARAMETERS
### -id
Unique ID For asset to checkout
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -60,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_at
Optional date to override the checkout time of now
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_to_type
{{ Fill checkout_to_type Description }}
@ -75,6 +90,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expected_checkin
Optional date the asset is expected to be checked in
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For asset to checkout
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Optional new asset name.
This is useful for changing the asset's name on new checkout,
@ -108,36 +153,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expected_checkin
Optional date the asset is expected to be checked in
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_at
Optional date to override the checkout time of now
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -153,16 +168,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 9
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -184,21 +199,6 @@ 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
```
### 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).

116
docs/Set-SnipeItComponent.md
View file

@ -30,8 +30,8 @@ An example
## PARAMETERS
### -id
ID number of name
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -39,37 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -90,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
@ -105,16 +90,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
### -name
Component name
```yaml
Type: DateTime
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,6 +120,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -150,16 +165,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 9
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,21 +196,6 @@ 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
```
### 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).

30
docs/Set-SnipeItInfo.md
View file

@ -28,21 +28,6 @@ Set-SnipeItInfo -url $url -apiKey -Verbose
## PARAMETERS
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
@ -58,6 +43,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
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).

110
docs/Set-SnipeItLicense.md
View file

@ -33,51 +33,21 @@ Set-SnipeItLicence -name "License" -seats 3 -company_id 1
## PARAMETERS
### -id
ID number of licence
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Required: True
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -123,6 +93,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of licence
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
Email address associated with license
@ -183,6 +168,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
License Notes
@ -258,6 +258,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serialnumber of license
@ -318,16 +333,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 20
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -349,21 +364,6 @@ 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
```
### 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).

68
docs/Set-SnipeItLicenseSeat.md
View file

@ -38,31 +38,31 @@ Checkout licence to asset id 3
## PARAMETERS
### -id
Unique ID For asset to checkout
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
{{ Fill seat_id Description }}
### -asset_id
Id of target asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -83,16 +83,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
Id of target asset
### -id
Unique ID For asset to checkout
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -113,6 +113,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
{{ Fill seat_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -128,16 +143,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 7
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -159,21 +174,6 @@ 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
```
### 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).

126
docs/Set-SnipeItModel.md
View file

@ -30,46 +30,16 @@ New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
## PARAMETERS
### -id
ID number of the Asset Model
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -90,16 +60,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
### -custom_fieldset_id
{{ Fill custom_fieldset_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Aliases: fieldset_id
Required: False
Position: 5
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -120,21 +90,66 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -custom_fieldset_id
{{ Fill custom_fieldset_id Description }}
### -id
ID number of the Asset Model
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: fieldset_id
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -150,16 +165,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 9
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,21 +196,6 @@ 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
```
### 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).

316
docs/Set-SnipeItUser.md
View file

@ -34,106 +34,31 @@ Updates user with id 3
## PARAMETERS
### -id
{{ Fill id Description }}
### -activated
{{ Fill activated Description }}
```yaml
Type: Int32
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Users last name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
Username for user
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Phone number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -154,21 +79,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
@ -184,6 +94,111 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Users last name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
@ -199,36 +214,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
{{ Fill activated Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
@ -244,6 +229,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Phone number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -259,16 +259,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
### -userName
Username for user
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Required: False
Position: 4
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
@ -290,21 +305,6 @@ 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
```
### 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).

144
docs/Set-SnipeitLocation.md
View file

@ -30,36 +30,6 @@ Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100
## PARAMETERS
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address
Address line 1
@ -90,16 +60,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Required: True
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -120,31 +90,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
Address zipcode
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Location manager as id
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -165,6 +120,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Location manager as id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -parent_id
Parent location as id
@ -180,6 +165,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -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
@ -195,16 +195,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -zip
Address zipcode
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Required: False
Position: 7
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
@ -226,21 +241,6 @@ 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
```
### 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).

83
docs/SnipeItPS.md
View file

@ -12,122 +12,113 @@ Locale: en-US
## SnipeitPS Cmdlets
### [Get-SnipeItAccessory](Get-SnipeItAccessory.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Accessories
### [Get-SnipeItAsset](Get-SnipeItAsset.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Assets or specific asset
### [Get-SnipeItAssetMaintenance](Get-SnipeItAssetMaintenance.md)
{{ Fill in the Description }}
Lists Snipe-it Assets Maintenances
### [Get-SnipeItCategory](Get-SnipeItCategory.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Categories
### [Get-SnipeItCompany](Get-SnipeItCompany.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Companies
### [Get-SnipeItComponent](Get-SnipeItComponent.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Components
### [Get-SnipeItCustomField](Get-SnipeItCustomField.md)
{{ Fill in the Description }}
Returns specific Snipe-IT custom field or a list of all custom field
### [Get-SnipeItDepartment](Get-SnipeItDepartment.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Departments
### [Get-SnipeItFieldset](Get-SnipeItFieldset.md)
{{ Fill in the Description }}
Returns a fieldset or list of Snipe-it Fieldsets
### [Get-SnipeItLicense](Get-SnipeItLicense.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Licenses
### [Get-SnipeItLicenseSeat](Get-SnipeItLicenseSeat.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Licenses Seats or specific Seat
### [Get-SnipeitLocation](Get-SnipeitLocation.md)
{{ Fill in the Description }}
### [Get-SnipeItManufacturer](Get-SnipeItManufacturer.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Locations
### [Get-SnipeItModel](Get-SnipeItModel.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Models
### [Get-SnipeItStatus](Get-SnipeItStatus.md)
{{ Fill in the Description }}
### [Get-SnipeItSupplier](Get-SnipeItSupplier.md)
{{ Fill in the Description }}
### [Get-SnipeItUser](Get-SnipeItUser.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Status Labels
### [New-SnipeItAsset](New-SnipeItAsset.md)
{{ Fill in the Description }}
Add a new Asset to Snipe-it asset system
### [New-SnipeItAssetMaintenance](New-SnipeItAssetMaintenance.md)
{{ Fill in the Description }}
Add a new Asset maintenence to Snipe-it asset system
### [New-SnipeItCategory](New-SnipeItCategory.md)
{{ Fill in the Description }}
Create a new Snipe-IT Category
### [New-SnipeItComponent](New-SnipeItComponent.md)
{{ Fill in the Description }}
Create a new component
### [New-SnipeItCustomField](New-SnipeItCustomField.md)
{{ Fill in the Description }}
Add a new Custom Field to Snipe-it asset system
### [New-SnipeItDepartment](New-SnipeItDepartment.md)
{{ Fill in the Description }}
Creates a department
### [New-SnipeItLicense](New-SnipeItLicense.md)
{{ Fill in the Description }}
Creates a licence
### [New-SnipeItLocation](New-SnipeItLocation.md)
{{ Fill in the Description }}
Add a new Location to Snipe-it asset system
### [New-SnipeItManufacturer](New-SnipeItManufacturer.md)
{{ Fill in the Description }}
Add a new Manufacturer to Snipe-it asset system
### [New-SnipeItModel](New-SnipeItModel.md)
{{ Fill in the Description }}
Add a new Model to Snipe-it asset system
### [New-SnipeItUser](New-SnipeItUser.md)
{{ Fill in the Description }}
Creates a new user
### [Remove-SnipeItAsset](Remove-SnipeItAsset.md)
{{ Fill in the Description }}
Removes Asset from Snipe-it asset system
### [Remove-SnipeItUser](Remove-SnipeItUser.md)
{{ Fill in the Description }}
Removes User from Snipe-it asset system
### [Set-SnipeItAccessory](Set-SnipeItAccessory.md)
{{ Fill in the Description }}
Updates accessory on Snipe-It system
### [Set-SnipeItAsset](Set-SnipeItAsset.md)
{{ Fill in the Description }}
Update a specific Asset in the Snipe-it asset system
### [Set-SnipeItAssetOwner](Set-SnipeItAssetOwner.md)
{{ Fill in the Description }}
Checkout asset
### [Set-SnipeItComponent](Set-SnipeItComponent.md)
{{ Fill in the Description }}
Updates component
### [Set-SnipeItInfo](Set-SnipeItInfo.md)
{{ Fill in the Description }}
Sets authetication information
### [Set-SnipeItLicense](Set-SnipeItLicense.md)
{{ Fill in the Description }}
Updates a licence
### [Set-SnipeItLicenseSeat](Set-SnipeItLicenseSeat.md)
{{ Fill in the Description }}
Set license seat or checkout license seat
### [Set-SnipeitLocation](Set-SnipeitLocation.md)
{{ Fill in the Description }}
Updates Location in Snipe-it asset system
### [Set-SnipeItModel](Set-SnipeItModel.md)
{{ Fill in the Description }}
Updates Model on Snipe-it asset system
### [Set-SnipeItUser](Set-SnipeItUser.md)
{{ Fill in the Description }}
Creates a new user