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

Updated docs

Browse source
This commit is contained in:
Petri Asikainen 2021-07-14 11:16:55 +03:00
parent fd2f5c51c7
commit 7f6a5e1244
29 changed files with 463 additions and 199 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/New-SnipeitAccessory.md
View file

@ -16,8 +16,7 @@ Creates new accessory on Snipe-It system
New-SnipeitAccessory [-name] <String> [-qty] <Int32> [-category_id] <Int32> [[-company_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-order_number] <String>] [[-model_number] <String>] [[-purchase_cost] <Single>]
[[-purchase_date] <DateTime>] [[-min_amt] <Int32>] [[-supplier_id] <Int32>] [[-location_id] <Int32>]
[[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
[[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -78,7 +77,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Accessory image fileame and path
```yaml
Type: String
@ -92,21 +91,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to

21
docs/New-SnipeitAsset.md
View file

@ -16,8 +16,8 @@ Add a new Asset to Snipe-it asset system
New-SnipeitAsset [-status_id] <Int32> [-model_id] <Int32> [[-name] <String>] [[-asset_tag] <String>]
[[-serial] <String>] [[-company_id] <Int32>] [[-order_number] <String>] [[-notes] <String>]
[[-warranty_months] <Int32>] [[-purchase_cost] <String>] [[-purchase_date] <DateTime>]
[[-supplier_id] <Int32>] [[-rtd_location_id] <Int32>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
[[-supplier_id] <Int32>] [[-rtd_location_id] <Int32>] [[-image] <String>] [-url] <String> [-apiKey] <String>
[[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -107,7 +107,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Asset image filename and path
```yaml
Type: String
@ -121,21 +121,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Required Model ID of the asset, this can be got using Get-Model

21
docs/New-SnipeitCategory.md
View file

@ -14,8 +14,8 @@ Create a new Snipe-IT Category
```
New-SnipeitCategory [-name] <String> [-category_type] <String> [[-eula_text] <String>] [-use_default_eula]
[-require_acceptance] [-checkin_email] [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
[-require_acceptance] [-checkin_email] [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -91,7 +91,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Category image filename and path
```yaml
Type: String
@ -105,21 +105,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of new category to be created

21
docs/New-SnipeitCompany.md
View file

@ -13,8 +13,8 @@ Creates a new Company
## SYNTAX
```
New-SnipeitCompany [-name] <String> [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
New-SnipeitCompany [-name] <String> [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -45,7 +45,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Company image filename and path
```yaml
Type: String
@ -59,21 +59,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Comapany name

20
docs/New-SnipeitComponent.md
View file

@ -15,8 +15,7 @@ Create a new component
```
New-SnipeitComponent [-name] <String> [-category_id] <Int32> [-qty] <String> [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-order_number] <String>] [[-purchase_date] <DateTime>] [[-purchase_cost] <Single>]
[[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
[[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -77,7 +76,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Component image filename and path
```yaml
Type: String
@ -91,21 +90,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to

21
docs/New-SnipeitConsumable.md
View file

@ -16,8 +16,8 @@ Add a new Consumable to Snipe-it asset system
New-SnipeitConsumable [-name] <String> [-qty] <Int32> [-category_id] <Int32> [[-min_amt] <Int32>]
[[-company_id] <Int32>] [[-order_number] <String>] [[-manufacturer_id] <Int32>] [[-location_id] <Int32>]
[[-requestable] <Boolean>] [[-purchase_date] <DateTime>] [[-purchase_cost] <String>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -79,7 +79,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Consumable Image filename and path
```yaml
Type: String
@ -93,21 +93,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -item_no
Item number for the consumable

4
docs/New-SnipeitDepartment.md
View file

@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Department Image filename and path
```yaml
Type: String
@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -image_delete
Remove current image
{{ Fill image_delete Description }}
```yaml
Type: SwitchParameter

4
docs/New-SnipeitLocation.md
View file

@ -122,7 +122,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Location Image filename and path
```yaml
Type: String
@ -137,7 +137,7 @@ Accept wildcard characters: False
```
### -image_delete
Remove current image
{{ Fill image_delete Description }}
```yaml
Type: SwitchParameter

2
docs/New-SnipeitManufacturer.md
View file

@ -45,7 +45,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Manufacturer Image filename and path
```yaml
Type: String

21
docs/New-SnipeitModel.md
View file

@ -14,8 +14,8 @@ Add a new Model to Snipe-it asset system
```
New-SnipeitModel [-name] <String> [[-model_number] <String>] [-category_id] <Int32> [-manufacturer_id] <Int32>
[[-eol] <Int32>] [-fieldset_id] <Int32> [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
[[-eol] <Int32>] [-fieldset_id] <Int32> [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -91,7 +91,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
Asset model Image filename and path
```yaml
Type: String
@ -105,21 +105,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer

2
docs/New-SnipeitSupplier.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:

21
docs/New-SnipeitUser.md
View file

@ -16,8 +16,8 @@ Creates a new user
New-SnipeitUser [-first_name] <String> [-last_name] <String> [-username] <String> [[-password] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>]
[[-employee_num] <String>] [[-ldap_import] <Boolean>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-employee_num] <String>] [[-ldap_import] <Boolean>] [[-image] <String>] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -139,7 +139,7 @@ Accept wildcard characters: False
```
### -image
Image file name and path for item
User Image file name and path
```yaml
Type: String
@ -153,21 +153,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle

2
docs/Remove-SnipeitSupplier.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:

24
docs/Set-SnipeitAccessory.md
View file

@ -16,8 +16,8 @@ Updates accessory on Snipe-It system
Set-SnipeitAccessory [-id] <Int32[]> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
[[-company_id] <Int32>] [[-manufacturer_id] <Int32>] [[-model_number] <String>] [[-order_number] <String>]
[[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-min_amt] <Int32>] [[-supplier_id] <Int32>]
[[-location_id] <Int32>] [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
[[-location_id] <Int32>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -41,7 +41,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -257,6 +257,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
ID number of the supplier for this accessory
@ -281,7 +297,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitCategory.md
View file

@ -15,8 +15,8 @@ Create a new Snipe-IT Category
```
Set-SnipeitCategory [-id] <Int32[]> [[-name] <String>] [[-category_type] <String>] [[-eula_text] <String>]
[[-use_default_eula] <Boolean>] [[-require_acceptance] <Boolean>] [[-checkin_email] <Boolean>]
[[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
[[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -40,7 +40,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 10
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -151,6 +151,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
@ -175,7 +191,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitCompany.md
View file

@ -13,8 +13,8 @@ Updates company name
## SYNTAX
```
Set-SnipeitCompany [-id] <Int32[]> [-name] <String> [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Set-SnipeitCompany [-id] <Int32[]> [-name] <String> [[-image] <String>] [-image_delete]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -38,7 +38,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -104,6 +104,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -113,7 +129,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitComponent.md
View file

@ -15,8 +15,8 @@ Updates component
```
Set-SnipeitComponent [-id] <Int32[]> [-qty] <Int32> [[-min_amt] <Int32>] [[-name] <String>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-order_number] <String>] [[-purchase_date] <DateTime>]
[[-purchase_cost] <Single>] [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
[[-purchase_cost] <Single>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -40,7 +40,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -211,6 +211,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -220,7 +236,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitConsumable.md
View file

@ -16,8 +16,8 @@ Add a new Consumable to Snipe-it asset system
Set-SnipeitConsumable [-id] <Int32[]> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
[[-min_amt] <Int32>] [[-company_id] <Int32>] [[-order_number] <String>] [[-manufacturer_id] <Int32>]
[[-location_id] <Int32>] [[-requestable] <Boolean>] [[-purchase_date] <DateTime>] [[-purchase_cost] <String>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -42,7 +42,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -288,6 +288,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -297,7 +313,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

23
docs/Set-SnipeitCustomField.md
View file

@ -15,7 +15,8 @@ Add a new Custom Field to Snipe-it asset system
```
Set-SnipeitCustomField [-id] <Int32[]> [[-name] <String>] [[-help_text] <String>] [-element] <String>
[[-format] <String>] [[-field_values] <String>] [[-field_encrypted] <Boolean>] [[-show_in_email] <Boolean>]
[[-custom_format] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-custom_format] <String>] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -39,7 +40,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -166,6 +167,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Put you could use Patch if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: Put
Accept pipeline input: False
Accept wildcard characters: False
```
### -show_in_email
Whether or not to show the custom field in email notifications
@ -190,7 +207,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 10
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitDepartment.md
View file

@ -14,8 +14,8 @@ Updates a department
```
Set-SnipeitDepartment [-id] <Int32[]> [[-name] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
[[-manager_id] <Int32>] [[-notes] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-manager_id] <Int32>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -39,7 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -165,6 +165,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -174,7 +190,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

22
docs/Set-SnipeitLicense.md
View file

@ -18,7 +18,7 @@ Set-SnipeitLicense [-id] <Int32[]> [[-name] <String>] [[-seats] <Int32>] [[-cate
[[-license_name] <String>] [[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>]
[[-order_number] <String>] [[-purchase_cost] <Single>] [[-purchase_date] <DateTime>]
[[-reassignable] <Boolean>] [[-serial] <String>] [[-supplier_id] <Int32>] [[-termination_date] <DateTime>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -42,7 +42,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 20
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -258,6 +258,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
@ -327,7 +343,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 19
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

23
docs/Set-SnipeitLicenseSeat.md
View file

@ -14,7 +14,8 @@ Set license seat or checkout license seat
```
Set-SnipeitLicenseSeat [-id] <Int32[]> [-seat_id] <Int32> [[-assigned_to] <Int32>] [[-asset_id] <Int32>]
[[-note] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-note] <String>] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -51,7 +52,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -117,6 +118,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
{{ Fill seat_id Description }}
@ -141,7 +158,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

22
docs/Set-SnipeitLocation.md
View file

@ -16,7 +16,7 @@ Updates Location in Snipe-it asset system
Set-SnipeitLocation [-id] <Int32[]> [[-name] <String>] [[-address] <String>] [[-address2] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-city] <String>] [[-currency] <String>]
[[-manager_id] <Int32>] [[-ldap_ou] <String>] [[-parent_id] <Int32>] [[-image] <String>] [-image_delete]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -70,7 +70,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -226,6 +226,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State
@ -250,7 +266,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 14
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

163
docs/Set-SnipeitManufacturer.md Normal file
View file

@ -0,0 +1,163 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-SnipeitManufacturer
## SYNOPSIS
Add a new Manufacturer to Snipe-it asset system
## SYNTAX
```
Set-SnipeitManufacturer [-Name] <String> [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### EXAMPLE 1
```
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: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image
Image file name and path for item
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Name of the Manufacturer
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

23
docs/Set-SnipeitModel.md
View file

@ -15,7 +15,8 @@ Updates Model on Snipe-it asset system
```
Set-SnipeitModel [-id] <Int32[]> [[-name] <String>] [[-model_number] <String>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-eol] <Int32>] [[-custom_fieldset_id] <Int32>] [[-image] <String>]
[-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[-image_delete] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -39,7 +40,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 10
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -180,6 +181,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -189,7 +206,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

24
docs/Set-SnipeitStatus.md
View file

@ -14,8 +14,8 @@ Sets Snipe-it Status Labels
```
Set-SnipeitStatus [-id] <Int32[]> [[-name] <String>] [-type] <String> [[-notes] <String>] [[-color] <String>]
[[-show_in_nav] <Boolean>] [[-default_label] <Boolean>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
[[-show_in_nav] <Boolean>] [[-default_label] <Boolean>] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -44,7 +44,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -125,6 +125,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: Patch
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
@ -164,7 +180,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

2
docs/Set-SnipeitSupplier.md
View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:

24
docs/Set-SnipeitUser.md
View file

@ -16,8 +16,8 @@ Creates a new user
Set-SnipeitUser [-id] <Int32[]> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
[[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-password] <String>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-activated] <Boolean>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -57,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 18
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -288,6 +288,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
@ -297,7 +313,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

12
docs/SnipeitPS.md
View file

@ -104,6 +104,9 @@ Add a new Manufacturer to Snipe-it asset system
### [New-SnipeitModel](New-SnipeitModel.md)
Add a new Model to Snipe-it asset system
### [New-SnipeitSupplier](New-SnipeitSupplier.md)
Creates a supplier
### [New-SnipeitUser](New-SnipeitUser.md)
Creates a new user
@ -146,6 +149,9 @@ Removes manufacturer from Snipe-it asset system
### [Remove-SnipeitModel](Remove-SnipeitModel.md)
Removes Asset model from Snipe-it asset system
### [Remove-SnipeitSupplier](Remove-SnipeitSupplier.md)
Removes supplier from Snipe-it asset system
### [Remove-SnipeitUser](Remove-SnipeitUser.md)
Removes User from Snipe-it asset system
@ -197,12 +203,18 @@ Set license seat or checkout license seat
### [Set-SnipeitLocation](Set-SnipeitLocation.md)
Updates Location in Snipe-it asset system
### [Set-SnipeitManufacturer](Set-SnipeitManufacturer.md)
Add a new Manufacturer to Snipe-it asset system
### [Set-SnipeitModel](Set-SnipeitModel.md)
Updates Model on Snipe-it asset system
### [Set-SnipeitStatus](Set-SnipeitStatus.md)
Sets Snipe-it Status Labels
### [Set-SnipeitSupplier](Set-SnipeitSupplier.md)
Modify the supplier
### [Set-SnipeitUser](Set-SnipeitUser.md)
Creates a new user