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

get assigned items with by user is or asset id

Browse source
This commit is contained in:
Petri Asikainen 2021-06-17 14:37:37 +03:00
parent 64fa3799fe
commit b337608d7b
70 changed files with 3740 additions and 3749 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

192
docs/Get-SnipeitAccessory.md
View file

@ -52,42 +52,42 @@ Get accessories checked out to user 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: String
Parameter Sets: Search
Type: SwitchParameter
Parameter Sets: Search, Accessories checked out to user id
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Accessory
### -category_id
{{ Fill category_id Description }}
```yaml
Type: Int32
Parameter Sets: Get by ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -user_id
{{ Fill user_id Description }}
```yaml
Type: Int32
Parameter Sets: Accessories checked out to user id
Parameter Sets: Search
Aliases:
Required: False
@ -112,12 +112,12 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
### -id
A id of specific Accessory
```yaml
Type: Int32
Parameter Sets: Search
Parameter Sets: Get by ID
Aliases:
Required: False
@ -127,66 +127,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -204,6 +144,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Result offset to use
@ -219,17 +174,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
Parameter Sets: Search, Accessories checked out to user id
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
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: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -249,17 +249,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -user_id
{{ Fill user_id Description }}
```yaml
Type: String
Parameter Sets: (All)
Type: Int32
Parameter Sets: Accessories checked out to user id
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

42
docs/Get-SnipeitAccessoryOwner.md
View file

@ -29,6 +29,21 @@ Get-SnipeitAccessoryOwner -id 1
## 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 accessory to list
@ -59,16 +74,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
@ -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).

126
docs/Get-SnipeitActivity.md
View file

@ -35,8 +35,9 @@ Get-SnipeitAccessory -id 1
## PARAMETERS
### -search
A text string to search the Activity history
### -action_type
Type of action.
One from following list "add seats", "checkin from", 'checkout' or 'update'
```yaml
Type: String
@ -44,54 +45,37 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -target_type
Type of target.
One from following list 'Accessory','Asset','AssetMaintenance','AssetModel','Category','Company','Component','Consumable','CustomField','Depreciable','Depreciation','Group','Licence','LicenseSeat','Location','Manufacturer','Statuslabel','Supplier','User'
### -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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -target_id
Needed if target_type is specified
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -item_type
Type of target.
One from following list 'Accessory','Asset','AssetMaintenance','AssetModel','Category','Company','Component','Consumable','CustomField','Depreciable','Depreciation','Group','Licence','LicenseSeat','Location','Manufacturer','Statuslabel','Supplier','User'
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Required: True
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -112,9 +96,9 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -action_type
Type of action.
One from following list "add seats", "checkin from", 'checkout' or 'update'
### -item_type
Type of target.
One from following list 'Accessory','Asset','AssetMaintenance','AssetModel','Category','Company','Component','Consumable','CustomField','Depreciable','Depreciation','Group','Licence','LicenseSeat','Location','Manufacturer','Statuslabel','Supplier','User'
```yaml
Type: String
@ -122,7 +106,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -158,17 +142,48 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
### -search
A text string to search the Activity history
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -target_id
Needed if target_type is specified
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -target_type
Type of target.
One from following list 'Accessory','Asset','AssetMaintenance','AssetModel','Category','Company','Component','Consumable','CustomField','Depreciable','Depreciation','Group','Licence','LicenseSeat','Location','Manufacturer','Statuslabel','Supplier','User'
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -188,21 +203,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: 10
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).

374
docs/Get-SnipeitAsset.md
View file

@ -120,32 +120,32 @@ Get Assets with component id 5
## PARAMETERS
### -search
A text string to search the assets data
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Parameter Sets: Search
Type: SwitchParameter
Parameter Sets: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: Int32
Parameter Sets: Get with id
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -165,21 +165,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
{{ Fill serial Description }}
```yaml
Type: String
Parameter Sets: Get with serial
Aliases: asset_serial
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -audit_due
Retrieve a list of assets that are due for auditing soon.
@ -210,66 +195,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -user_id
{{ Fill user_id Description }}
```yaml
Type: Int32
Parameter Sets: Assets checked out to user id
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -component_id
{{ Fill component_id Description }}
```yaml
Type: Int32
Parameter Sets: Assets with component id
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optionally restrict asset results to this order number
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Optionally restrict asset results to this asset model ID
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
Optionally restrict asset results to this category ID
@ -285,21 +210,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optionally restrict asset results to this company ID
@ -315,12 +225,12 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Optionally restrict asset results to this location ID
### -component_id
{{ Fill component_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Parameter Sets: Assets with component id
Aliases:
Required: False
@ -345,6 +255,128 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
```yaml
Type: Int32
Parameter Sets: Get with id
Aliases:
Required: False
Position: Named
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Optionally restrict asset results to this location ID
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
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: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optionally restrict asset results to this order number
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -requestable
{{ Fill requestable Description }}
@ -360,6 +392,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the assets data
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
{{ Fill serial Description }}
```yaml
Type: String
Parameter Sets: Get with serial
Aliases: asset_serial
Required: False
Position: Named
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: None
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
@ -390,83 +467,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: None
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: None
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
Aliases:
Required: False
Position: Named
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: Search, Assets due auditing soon, Assets overdue for auditing, Assets checked out to user id, Assets with component id
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
@ -482,17 +482,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -user_id
{{ Fill user_id Description }}
```yaml
Type: String
Parameter Sets: (All)
Type: Int32
Parameter Sets: Assets checked out to user id
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

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).

56
docs/Get-SnipeitCategory.md
View file

@ -40,16 +40,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -70,21 +85,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -117,38 +117,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
Url of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Categories data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
Url of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

56
docs/Get-SnipeitCompany.md
View file

@ -42,16 +42,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -72,21 +87,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -119,38 +119,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Companies data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

144
docs/Get-SnipeitComponent.md
View file

@ -49,32 +49,32 @@ 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: String
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Component
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: Int32
Parameter Sets: Get with ID
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -109,6 +109,38 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Component
```yaml
Type: Int32
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
@ -124,6 +156,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
@ -139,6 +186,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Components data
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
@ -154,53 +216,6 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
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: Search
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
@ -216,21 +231,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: 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).

176
docs/Get-SnipeitConsumable.md
View file

@ -49,30 +49,30 @@ Returns specific consumable
## PARAMETERS
### -search
A text string to search the consumables
### -all
A return all results
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific consumable
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: Int32[]
Parameter Sets: Get with ID
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
@ -109,6 +109,68 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expand
Whether to include detailed information on categories, etc (true) or just the text name (false)
```yaml
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific consumable
```yaml
Type: Int32[]
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: None
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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Id number of manufacturer
@ -124,8 +186,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
### -offset
Offset to use
```yaml
Type: Int32
@ -154,6 +216,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the consumables
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Sort results by column
@ -169,68 +246,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expand
Whether to include detailed information on categories, etc (true) or just the text name (false)
```yaml
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results
```yaml
Type: SwitchParameter
Parameter Sets: Search
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
@ -246,21 +261,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: 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/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).

74
docs/Get-SnipeitDepartment.md
View file

@ -45,16 +45,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,21 +90,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -122,17 +122,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: Search
Aliases:
Required: False
Position: Named
Default value: False
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: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -167,21 +182,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: 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/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).

370
docs/Get-SnipeitLicense.md
View file

@ -53,51 +53,36 @@ 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: Search, Get licenses checked out to user ID, Get licenses checked out to asset ID
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: Search
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific License
```yaml
Type: Int32
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -user_id
{{ Fill user_id Description }}
```yaml
Type: Int32
Parameter Sets: Get licenses checked out to user ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
{{ Fill asset_id Description }}
@ -113,17 +98,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
{{ Fill name Description }}
### -category_id
{{ Fill category_id Description }}
```yaml
Type: String
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -143,111 +128,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -product_key
{{ Fill product_key Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{ Fill order_number Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_order
{{ Fill purchase_order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_name
{{ Fill license_name Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
{{ Fill license_email Description }}
```yaml
Type: MailAddress
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
@ -263,8 +143,100 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
### -id
A id of specific License
```yaml
Type: Int32
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
{{ Fill license_email Description }}
```yaml
Type: MailAddress
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_name
{{ Fill license_name Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
{{ Fill name Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
@ -293,6 +265,66 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{ Fill order_number Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -product_key
{{ Fill product_key Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_order
{{ Fill purchase_order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
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: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
@ -308,25 +340,8 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
@ -340,21 +355,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: Search, Get licenses checked out to user ID, Get licenses checked out to asset ID
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
@ -370,17 +370,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -user_id
{{ Fill user_id Description }}
```yaml
Type: String
Parameter Sets: (All)
Type: Int32
Parameter Sets: Get licenses checked out to user ID
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

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).

56
docs/Get-SnipeitLocation.md
View file

@ -40,16 +40,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -70,21 +85,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -117,38 +117,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
### -search
A text string to search the Locations data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
```yaml
Type: String

58
docs/Get-SnipeitManufacturer.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:
@ -42,16 +42,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -72,21 +87,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -119,38 +119,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Manufactures data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

56
docs/Get-SnipeitModel.md
View file

@ -40,16 +40,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -70,21 +85,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -117,38 +117,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Models data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

56
docs/Get-SnipeitStatus.md
View file

@ -40,16 +40,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -70,21 +85,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -117,38 +117,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Status Labels data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

58
docs/Get-SnipeitSupplier.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:
@ -40,16 +40,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: String
Type: SwitchParameter
Parameter Sets: Search
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -70,21 +85,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -117,38 +117,38 @@ 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: Search
Aliases:
Required: False
Position: Named
Default value: False
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -search
A text string to search the Supliers data
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String

178
docs/Get-SnipeitUser.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:
@ -62,36 +62,6 @@ Get users with accessory id 3 has been checked out to
## PARAMETERS
### -search
A text string to search the User data
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
```yaml
Type: String
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -accessory_id
{{ Fill accessory_id Description }}
@ -107,6 +77,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: Search, Get users a specific accessory id has been checked out to
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
@ -122,36 +122,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -group_id
{{ Fill group_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
{{ Fill department_id Description }}
@ -167,21 +137,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Search string for username field
```yaml
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Search string for email field
@ -197,17 +152,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -group_id
{{ Fill group_id Description }}
```yaml
Type: String
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
```yaml
Type: String
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -229,6 +199,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -244,17 +229,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
Parameter Sets: Search, Get users a specific accessory id has been checked out to
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
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: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -274,15 +274,15 @@ 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)
Parameter Sets: Search
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

126
docs/New-SnipeitAccessory.md
View file

@ -31,8 +31,8 @@ New-SnipeitAccessory -name "Accessory" -qty 3 -category_id 1
## PARAMETERS
### -name
Accessory name
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: String
@ -40,27 +40,12 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 14
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: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
ID number of the category the accessory belongs to
@ -91,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
ID number of the manufacturer for this accessory.
@ -106,17 +106,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number for this accessory.
### -min_amt
Min quantity of the accessory before alert is triggered
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -136,6 +136,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Accessory name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number for this accessory.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
@ -166,16 +196,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Min quantity of the accessory before alert is triggered
### -qty
Quantity of the accessory you have
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -196,21 +226,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```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
@ -226,16 +241,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: 14
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -257,21 +272,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).

222
docs/New-SnipeitAsset.md
View file

@ -45,21 +45,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: CustomValues
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
@ -90,66 +136,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
@ -165,17 +151,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
```
@ -210,21 +196,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
@ -240,6 +211,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
@ -255,32 +271,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
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Required: False
Position: 9
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.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: Hashtable
Type: SwitchParameter
Parameter Sets: (All)
Aliases: CustomValues
Aliases: cf
Required: False
Position: 16
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -302,21 +317,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).

48
docs/New-SnipeitAudit.md
View file

@ -29,8 +29,8 @@ New-SnipeitAudit -tag 1 -location_id 1
## PARAMETERS
### -tag
The asset tag of the asset you wish to audit
### -apiKey
{{ Fill apiKey Description }}
```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,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -tag
The asset tag of the asset you wish to audit
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
{{ Fill url Description }}
@ -74,16 +89,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
{{ Fill apiKey Description }}
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 4
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -105,21 +120,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-SnipeitCategory.md
View file

@ -30,8 +30,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
@ -39,7 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -60,6 +60,21 @@ 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
```
### -eula_text
This allows you to customize your EULAs for specific types of assets
@ -75,17 +90,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -use_default_eula
If switch is present, use the primary default EULA
### -name
Name of new category to be created
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -105,21 +120,6 @@ 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
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -135,16 +135,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -use_default_eula
If switch is present, use the primary default EULA
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Required: False
Position: Named
Default value: False
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
@ -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).

42
docs/New-SnipeitCompany.md
View file

@ -29,6 +29,21 @@ New-SnipeitCompany -name "Acme Company"
## 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
```
### -name
Comapany name
@ -59,16 +74,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
@ -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-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: 10
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,6 +90,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number of the component
@ -120,21 +120,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
@ -150,6 +135,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: 7
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
@ -165,16 +180,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: 10
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -196,21 +211,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).

180
docs/New-SnipeitConsumable.md
View file

@ -33,8 +33,8 @@ Create consumable with stock count 20 , alert when stock is 5 or lower
## PARAMETERS
### -name
Required Name of the Consumable
### -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: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Required Quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
Required Category ID of the Consumable, this can be got using Get-SnipeitCategory
@ -78,21 +63,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Optional minimum quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
@ -108,8 +78,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optional Order number
### -item_no
Item number for the consumable
```yaml
Type: String
@ -117,27 +87,12 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufaturer id number of the consumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Location id number of the consumable
@ -153,31 +108,76 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -requestable
Is consumable requestable?
### -manufacturer_id
Manufaturer id number of the consumable
```yaml
Type: Boolean
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Optional Purchase cost of the consumable
### -min_amt
Optional minimum quantity of comsumable
```yaml
Type: DateTime
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the consumable in months
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Required Name of the Consumable
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optional Order number
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -198,32 +198,47 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the consumable in months
### -purchase_date
Optional Purchase cost of the consumable
```yaml
Type: String
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -item_no
Item number for the consumable
### -qty
Required Quantity of comsumable
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -requestable
Is consumable requestable?
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -243,16 +258,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: 15
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -274,21 +289,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/New-SnipeitCustomField.md
View file

@ -30,8 +30,8 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I
## PARAMETERS
### -name
The field's name, which is also the form label
### -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: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -help_text
Any additional text you wish to display under the new form field to make it clearer what the gauges should be.
### -custom_format
In the case of format 'CUSTOM REGEX', this should be validation regex this field
```yaml
Type: String
@ -54,7 +54,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,36 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -format
How the field should be validated
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_values
In the case of list boxes, etc, this should be a list of the options available
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_encrypted
Whether the field should be encrypted.
(This can cause issues if you change it after the field was created.)
@ -121,6 +91,66 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -field_values
In the case of list boxes, etc, this should be a list of the options available
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -format
How the field should be validated
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -help_text
Any additional text you wish to display under the new form field to make it clearer what the gauges should be.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
The field's name, which is also the form label
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -show_in_email
Whether or not to show the custom field in email notifications
@ -136,21 +166,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -custom_format
In the case of format 'CUSTOM REGEX', this should be validation regex this field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -166,16 +181,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: 10
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -197,21 +212,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).

164
docs/New-SnipeitLocation.md
View file

@ -31,21 +31,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
@ -76,6 +61,21 @@ 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: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -city
City of the location
@ -91,21 +91,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -country
Country of the location
@ -121,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
The zip code of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -currency
Currency used at the location
@ -151,6 +121,51 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
The LDAP OU of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
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: 10
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
```
### -parent_id
Parent location ID for the location
@ -166,23 +181,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: 10
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
@ -190,7 +190,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -211,16 +211,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: 13
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
@ -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).

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

@ -33,66 +33,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
Password for user
```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 }}
@ -108,61 +48,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
@ -183,21 +78,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
@ -213,17 +93,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
```
@ -243,6 +123,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
@ -258,6 +183,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
Password for user
```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
@ -273,8 +273,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
@ -282,7 +282,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
@ -304,21 +319,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-SnipeitAccessory.md
View file

@ -34,6 +34,21 @@ Get-SnipeitAccessory -search needle | Remove-SnipeitAccessory
## 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 accessory to be removed
@ -64,16 +79,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
@ -95,21 +110,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

@ -34,6 +34,21 @@ Get-SnipeitAsset -serial 123456789 | Remove-SnipeitAsset
## 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
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitAssetMaintenance.md
View file

@ -29,6 +29,21 @@ Remove-SnipeitAssetMaintenance -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 of the asset maintenance to be removed
@ -59,16 +74,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
@ -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).

42
docs/Remove-SnipeitCategory.md
View file

@ -34,6 +34,21 @@ Get-SnipeitCategory -search something | Remove-SnipeitCategory
## 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 categoryto be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitCompany.md
View file

@ -34,6 +34,21 @@ Get-SnipeitCompany | | Where-object {$_.name -like '*some*'} | Remove-SnipeitCom
## 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 Company to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitComponent.md
View file

@ -34,6 +34,21 @@ Get-SnipeitComponent -search 123456789 | Remove-SnipeitComponent
## 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
{{ Fill id Description }}
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitConsumable.md
View file

@ -34,6 +34,21 @@ Get-SnipeitConsumable -search "paper" | Remove-Snipeitconsumable
## 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 consumable to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitCustomField.md
View file

@ -34,6 +34,21 @@ Get-SnipeitCustomField | Where-object {$_.name -like '*address*'} | Remove-Snip
## 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 field to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitDepartment.md
View file

@ -34,6 +34,21 @@ Get-SnipeitDepartment | Where-object {$_.name -like '*head*'} | Remove-SnipeitDe
## 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 department to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitLicense.md
View file

@ -34,6 +34,21 @@ Get-SnipeitLicence -product_key 123456789 | Remove-SnipeitLicense
## 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 licence to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitLocation.md
View file

@ -34,6 +34,21 @@ Get-SnipeitLocation -city Arkham | Remove-SnipeitLocation
## 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 location to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitManufacturer.md
View file

@ -34,6 +34,21 @@ Get-SnipeitManufacturer | Where-object {$_.name -like '*something*'} | Remove-S
## 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 manufacturer to be removed
@ -64,16 +79,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
@ -95,21 +110,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-SnipeitModel.md
View file

@ -34,6 +34,21 @@ Get-SnipeitModel -search needle | Remove-SnipeitModel
## 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 Model to be removed
@ -64,16 +79,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
@ -95,21 +110,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).

42
docs/Reset-SnipeitAccessoryOwner.md
View file

@ -35,6 +35,21 @@ Get-SnipeitAccessoryOwner -assigned_pivot_id xxx
## 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
```
### -assigned_pivot_id
This is the assigned_pivot_id of the accessory+user relationships in the accessories_users table
Use Get-SnipeitAccessoryOwner to find out nooded value
@ -66,16 +81,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
@ -97,21 +112,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).

72
docs/Reset-SnipeitAssetOwner.md
View file

@ -29,6 +29,21 @@ Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For asset to checkin
@ -44,21 +59,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
Change asset status to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Location id to change asset location to
@ -89,6 +89,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
Change asset status to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
@ -104,16 +119,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 6
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,21 +150,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/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: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -name
ID number of Accessory or array of IDs 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: 14
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: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -manufacturer_id
ID number of the manufacturer for this accessory.
@ -121,6 +106,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Minimum amount of the accessory, before alert is triggered
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number for this accessory
@ -136,6 +136,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
ID number of Accessory or array of IDs 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.
@ -181,8 +196,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Minimum amount of the accessory, before alert is triggered
### -qty
Quantity of the accessory you have
```yaml
Type: Int32
@ -190,8 +205,8 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -226,16 +241,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: 14
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -257,21 +272,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).

52
docs/Set-SnipeitAccessoryOwner.md
View file

@ -29,18 +29,18 @@ Set-SnipeitAccessoryOwner -id 1 -assigned_id 1 -note "testing check out to user
## PARAMETERS
### -id
Unique ID For accessory or array of IDs 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
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
@ -59,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For accessory or array of IDs to checkout
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -note
Notes about checkout
@ -89,16 +104,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: 5
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -120,21 +135,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).

224
docs/Set-SnipeitAsset.md
View file

@ -43,77 +43,33 @@ Get-SnipeitAsset -serial 12345678 | Set-SnipeitAsset -notes 'Just updated'
## PARAMETERS
### -id
ID of the Asset or array of IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -name
Asset name
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Required: True
Position: 19
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: Int32
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Model ID of the asset, this can be got using Get-Model
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
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
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -148,8 +104,68 @@ 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: CustomValues
Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID of the Asset or array of IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Asset name
```yaml
Type: String
@ -157,7 +173,22 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Notes about asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -178,21 +209,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: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Purchase cost of the asset, without a currency symbol
@ -238,18 +254,18 @@ 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
### -RequestType
Http request type to send Snipe IT system.
Defaults to Put youc use Patch if needed
```yaml
Type: Boolean
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Position: 17
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
@ -269,8 +285,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Notes about asset
### -serial
Serial number of the asset
```yaml
Type: String
@ -278,24 +294,23 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Put youc use Patch if needed
### -status_id
Status ID of the asset, this can be got using Get-Status
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: Patch
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -315,31 +330,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
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 19
Required: False
Position: 10
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
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: Hashtable
Type: SwitchParameter
Parameter Sets: (All)
Aliases: CustomValues
Aliases: cf
Required: False
Position: 20
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -361,21 +376,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,18 +30,18 @@ Set-SnipeitAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing
## PARAMETERS
### -id
Unique IDs For assets 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
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
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 IDs For assets to checkout
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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).

160
docs/Set-SnipeitCategory.md
View file

@ -30,6 +30,66 @@ Set-SnipeitCategory -id 4 -name "Laptops"
## 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: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_type
{{ Fill category_type Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
Should the user be emailed the EULA and/or an acceptance confirmation email when this item is checked in?
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -eula_text
This allows you to customize your EULAs for specific types of assets
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
@ -60,51 +120,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -category_type
{{ Fill category_type Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -eula_text
This allows you to customize your EULAs for specific types of assets
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
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
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
@ -120,21 +135,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
Should the user be emailed the EULA and/or an acceptance confirmation email when this item is checked in?
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -150,16 +150,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -use_default_eula
If switch is present, use the primary default EULA
```yaml
Type: String
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Required: False
Position: 5
Default value: False
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
@ -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).

42
docs/Set-SnipeitCompany.md
View file

@ -29,6 +29,21 @@ An example
## 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: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of company
@ -74,16 +89,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: 4
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -105,21 +120,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).

142
docs/Set-SnipeitComponent.md
View file

@ -30,6 +30,36 @@ An example
## 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: 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: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of name
@ -45,17 +75,17 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -90,36 +120,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number for the accessory
@ -135,21 +135,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
@ -165,6 +150,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: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```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
@ -180,16 +195,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: 11
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).

330
docs/Set-SnipeitConsumable.md
View file

@ -33,51 +33,21 @@ Create consumable with stock count 20 , alert when stock is 5 or lower
## PARAMETERS
### -id
Optional id number of the Consumable
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Optional Name of the Consumable
### -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: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Optional Quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
Required Category ID of the Consumable, this can be got using Get-SnipeitCategory
@ -93,21 +63,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Optional minimum quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
@ -123,106 +78,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optional Order number
### -id
Optional id number of the Consumable
```yaml
Type: String
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufaturer id number of the consumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Location id number of the consumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -requestable
Is consumable requestable?
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Optional Purchase cost of the consumable
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Optional Purchase cost of the consumable
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the consumable in months
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -243,6 +108,156 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Location id number of the consumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufaturer id number of the consumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Optional minimum quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the consumable in months
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Optional Name of the Consumable
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
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
```
### -purchase_cost
Optional Purchase cost of the consumable
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Optional Purchase cost of the consumable
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Optional Quantity of comsumable
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -requestable
Is consumable requestable?
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -258,16 +273,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: 16
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -289,21 +304,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).

224
docs/Set-SnipeitCustomField.md
View file

@ -30,6 +30,112 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I
## 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
```
### -custom_format
In the case of format 'CUSTOM REGEX', this should be validation regex this field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -element
Form field type that should be displayed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_encrypted
Whether the field should be encrypted.
(This can cause issues if you change it after the field was created.)
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_values
In the case of list boxes, etc, this should be a list of the options available
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -format
How the field should be validated
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -help_text
Any additional text you wish to display under the new form field to make it clearer what the gauges should be.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
@ -60,82 +166,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -help_text
Any additional text you wish to display under the new form field to make it clearer what the gauges should be.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -element
Form field type that should be displayed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -format
How the field should be validated
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_values
In the case of list boxes, etc, this should be a list of the options available
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -field_encrypted
Whether the field should be encrypted.
(This can cause issues if you change it after the field was created.)
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -show_in_email
Whether or not to show the custom field in email notifications
@ -151,21 +181,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -custom_format
In the case of format 'CUSTOM REGEX', this should be validation regex this field
```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
@ -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).

80
docs/Set-SnipeitDepartment.md
View file

@ -30,31 +30,16 @@ Set-SnipeitDepartment -id 4 -manager_id 3
## PARAMETERS
### -id
Id number of Department
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -name
Department Name
### -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: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Id number of Department
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -location_id
ID number of location
@ -105,6 +105,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Department Name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
{{ Fill notes Description }}
@ -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).

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 license or array of license IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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 license or array of license IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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).

110
docs/Set-SnipeitLicenseSeat.md
View file

@ -42,46 +42,16 @@ Checkin licence seat id 1 of licence id 1
## PARAMETERS
### -id
Unique ID For license to checkout or array of IDs
### -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: None
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
```
### -assigned_to
Id of target user
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: assigned_id
Required: False
Position: 3
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -102,6 +72,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_to
Id of target user
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: assigned_id
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For license to checkout or array of IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -note
Notes about checkout
@ -117,6 +117,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
@ -132,16 +147,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
@ -163,21 +178,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).

172
docs/Set-SnipeitLocation.md
View file

@ -31,36 +31,6 @@ Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100
## PARAMETERS
### -id
ID number of location or array or IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
@ -91,46 +61,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
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -country
Address Contry
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
Address zipcode
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Required: True
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -151,6 +91,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -country
Address Contry
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -currency
Currency used at the location
@ -166,6 +121,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of location or array or IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ldap_ou
LDAP OU of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Location manager as id
@ -181,8 +166,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
LDAP OU of Location
### -name
Name of Location
```yaml
Type: String
@ -190,7 +175,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -211,6 +196,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
@ -226,16 +226,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: 14
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
@ -257,21 +272,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).

128
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 or array of IDs
### -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: None
Accept pipeline input: True (ByPropertyName)
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,17 +60,17 @@ 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
Default value: 0
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -120,16 +90,61 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -custom_fieldset_id
{{ Fill custom_fieldset_id Description }}
### -id
ID number of the Asset Model or array of IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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: fieldset_id
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
@ -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).

114
docs/Set-SnipeitStatus.md
View file

@ -35,6 +35,51 @@ Set-SnipeitStatus -id 3 -name 'Waiting for arrival' -type pending
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -color
Hex code showing what color the status label should be on the pie chart in the dashboard
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -default_label
1 or 0 - determine whether it should be bubbled up to the top of the list of available statuses
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Status Label
@ -65,21 +110,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -type
{{ Fill type Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
{{ Fill notes Description }}
@ -95,21 +125,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -color
Hex code showing what color the status label should be on the pie chart in the dashboard
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -show_in_nav
1 or 0 - determine whether the status label should show in the left-side nav of the web GUI
@ -125,17 +140,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -default_label
1 or 0 - determine whether it should be bubbled up to the top of the list of available statuses
### -type
{{ Fill type Description }}
```yaml
Type: Boolean
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -155,16 +170,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
@ -186,21 +201,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).

304
docs/Set-SnipeitUser.md
View file

@ -33,121 +33,31 @@ Updates user with id 3
## PARAMETERS
### -id
ID number of Snipe--It user or array of IDs
### -activated
Can user log in to snipe-it?
```yaml
Type: Int32[]
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
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: None
Accept pipeline input: True (ByPropertyName)
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
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -password
Password for user
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -168,21 +78,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: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
@ -198,16 +93,16 @@ 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: 12
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -228,17 +123,92 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
Can user log in to snipe-it?
### -first_name
Users first name
```yaml
Type: Boolean
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of Snipe--It user or array of IDs
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -258,6 +228,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -password
Password for user
```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: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -273,16 +273,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: 17
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
@ -304,21 +319,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).

141
docs/SnipeitPS.md
View file

@ -12,209 +12,200 @@ Locale: en-US
## SnipeitPS Cmdlets
### [Get-SnipeitAccessory](Get-SnipeitAccessory.md)
{{ Fill in the Description }}
Gets a list of Snipe-it Accessories
### [Get-SnipeitAccessoryOwner](Get-SnipeitAccessoryOwner.md)
{{ Fill in the Description }}
Get list of checked out accessories
### [Get-SnipeitActivity](Get-SnipeitActivity.md)
{{ Fill in the Description }}
Gets and search Snipe-it Activity history
### [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-SnipeitConsumable](Get-SnipeitConsumable.md)
{{ Fill in the Description }}
Gets a list of Snipe-it consumables
### [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-SnipeitAccessory](New-SnipeitAccessory.md)
{{ Fill in the Description }}
Creates new accessory on Snipe-It system
### [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-SnipeitAudit](New-SnipeitAudit.md)
{{ Fill in the Description }}
Add a new Audit to Snipe-it asset system
### [New-SnipeitCategory](New-SnipeitCategory.md)
{{ Fill in the Description }}
Create a new Snipe-IT Category
### [New-SnipeitCompany](New-SnipeitCompany.md)
{{ Fill in the Description }}
Creates a new Company
### [New-SnipeitComponent](New-SnipeitComponent.md)
{{ Fill in the Description }}
Create a new component
### [New-SnipeitConsumable](New-SnipeitConsumable.md)
{{ Fill in the Description }}
Add a new Consumable to Snipe-it asset system
### [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-SnipeitAccessory](Remove-SnipeitAccessory.md)
{{ Fill in the Description }}
Removes Accessory from Snipe-it asset system
### [Remove-SnipeitAsset](Remove-SnipeitAsset.md)
{{ Fill in the Description }}
Removes Asset from Snipe-it asset system
### [Remove-SnipeitAssetMaintenance](Remove-SnipeitAssetMaintenance.md)
{{ Fill in the Description }}
Remove asset maintenance from Snipe-it asset system
### [Remove-SnipeitCategory](Remove-SnipeitCategory.md)
{{ Fill in the Description }}
Removes category from Snipe-it asset system
### [Remove-SnipeitCompany](Remove-SnipeitCompany.md)
{{ Fill in the Description }}
Removes Company from Snipe-it asset system
### [Remove-SnipeitComponent](Remove-SnipeitComponent.md)
{{ Fill in the Description }}
Removes component from Snipe-it asset system
### [Remove-SnipeitConsumable](Remove-SnipeitConsumable.md)
{{ Fill in the Description }}
Removes consumable from Snipe-it asset system
### [Remove-SnipeitCustomField](Remove-SnipeitCustomField.md)
{{ Fill in the Description }}
Removes custom field from Snipe-it asset system
### [Remove-SnipeitDepartment](Remove-SnipeitDepartment.md)
{{ Fill in the Description }}
Removes department from Snipe-it asset system
### [Remove-SnipeitLicense](Remove-SnipeitLicense.md)
{{ Fill in the Description }}
Removes licence from Snipe-it asset system
### [Remove-SnipeitLocation](Remove-SnipeitLocation.md)
{{ Fill in the Description }}
Removes Location from Snipe-it asset system
### [Remove-SnipeitManufacturer](Remove-SnipeitManufacturer.md)
{{ Fill in the Description }}
Removes manufacturer from Snipe-it asset system
### [Remove-SnipeitModel](Remove-SnipeitModel.md)
{{ Fill in the Description }}
Removes Asset model from Snipe-it asset system
### [Remove-SnipeitUser](Remove-SnipeitUser.md)
{{ Fill in the Description }}
Removes User from Snipe-it asset system
### [Reset-SnipeitAccessoryOwner](Reset-SnipeitAccessoryOwner.md)
{{ Fill in the Description }}
Checkin accessories
### [Reset-SnipeitAssetOwner](Reset-SnipeitAssetOwner.md)
{{ Fill in the Description }}
Checkin asset
### [Set-SnipeitAccessory](Set-SnipeitAccessory.md)
{{ Fill in the Description }}
Updates accessory on Snipe-It system
### [Set-SnipeitAccessoryOwner](Set-SnipeitAccessoryOwner.md)
{{ Fill in the Description }}
Checkout accessory
### [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-SnipeitCategory](Set-SnipeitCategory.md)
{{ Fill in the Description }}
Create a new Snipe-IT Category
### [Set-SnipeitCompany](Set-SnipeitCompany.md)
{{ Fill in the Description }}
Updates company name
### [Set-SnipeitComponent](Set-SnipeitComponent.md)
{{ Fill in the Description }}
Updates component
### [Set-SnipeitConsumable](Set-SnipeitConsumable.md)
{{ Fill in the Description }}
Add a new Consumable to Snipe-it asset system
### [Set-SnipeitCustomField](Set-SnipeitCustomField.md)
{{ Fill in the Description }}
Add a new Custom Field to Snipe-it asset system
### [Set-SnipeitDepartment](Set-SnipeitDepartment.md)
{{ Fill in the Description }}
Updates a department
### [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-SnipeitStatus](Set-SnipeitStatus.md)
{{ Fill in the Description }}
Sets Snipe-it Status Labels
### [Set-SnipeitUser](Set-SnipeitUser.md)
{{ Fill in the Description }}
Creates a new user
### [Update-SnipeitAlias](Update-SnipeitAlias.md)
{{ Fill in the Description }}
Replaces old SnipeitPS commands with new ones

14
docs/Update-SnipeitAlias.md
View file

@ -46,14 +46,13 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases: cf
Required: False
Position: Named
@ -62,13 +61,14 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named