SnipeitPS/docs/Set-SnipeitCompany.md
Petri Asikainen 69faba1856 updates docs
2021-08-23 18:50:13 +03:00

3 KiB

external help file Module Name online version schema
SnipeitPS-help.xml snipeitps 2.0.0

Set-SnipeitCompany

SYNOPSIS

Updates company name

SYNTAX

Set-SnipeitCompany [-id] <Int32[]> [-name] <String> [[-image] <String>] [-image_delete]
 [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates companyt name on Snipe-It system

EXAMPLES

EXAMPLE 1

An example

PARAMETERS

-apiKey

Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key API Key for Snipeit.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

ID number of company

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-image

Image file name and path for item

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-image_delete

Remove current image

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-name

Company name

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False

-url

Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

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.

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.

INPUTS

OUTPUTS

NOTES

General notes