< Back

Edit-HPERedfishData

Tue Jan 14, 2020 1:53 am

NAME Edit-HPERedfishData



SYNOPSIS

Executes HTTP PUT method on the destination server.





SYNTAX

Edit-HPERedfishData [-Odataid] <String> [[-Setting] <Object>] [[-Session] <PSObject>]

[-DisableCertificateAuthentication] [<CommonParameters>]





DESCRIPTION

Executes HTTP PUT method on the desitination server with the data from Setting parameter.





PARAMETERS

-Odataid <String>

Odataid where the setting is to be sent using HTTP PUT method.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Setting <Object>

Data is the payload body for the HTTP PUT request in name-value pair format. The parameter can be a hashtable

with multiple name-value pairs or a JSON string.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Session <PSObject>

Session PSObject returned by executing Connect-HPERedfish cmdlet. It must have RootURI and X-Auth-Token for

executing this cmdlet.



Required? false

Position? 3

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-DisableCertificateAuthentication [<SwitchParameter>]

If this switch parameter is present then server certificate authentication is disabled for the execution of

this cmdlet. If not present it will execute according to the global certificate authentication setting. The

default is to authenticate server certificates. See Enable-HPERedfishCertificateAuthentication and

Disable-HPERedfishCertificateAuthentication to set the per PowerShell session default.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

You can pipe the Odataid to Edit-HPERedfishData. Odataid points to the location where the PUT method is to be

executed.





OUTPUTS

System.Management.Automation.PSCustomObject

Edit-HPERedfishData returns a PSObject that has message from the HTTP response. The response may be informational

or may have a message requiring an action like server reset.





NOTES





- Edit-HPERedfishData is for HTTP PUT method.

- Invoke-HPERedfishAction is for HTTP POST method.

- Remove-HPERedfishData is for HTTP DELETE method.

- Set-HPERedfishData is for HTTP PATCH method.



See typical usage examples in the HPERedfishExamples.ps1 file installed with this module.





RELATED LINKS

http://www.hpe.com/servers/powershell