Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Updates the value of a named global configuration setting on the HPE OneView appliance.

​
Syntax

By name: 
Set-OVApplianceGlobalSetting
    -Name <String>
    -Value <String>
    [-ApplianceConnection <Object>]
    [<CommonParameters>]
From pipeline (Get-OVApplianceGlobalSetting): 
Get-OVApplianceGlobalSetting -Name <String> | Set-OVApplianceGlobalSetting
    -Value <String>
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Set-OVApplianceGlobalSetting modifies the value of an existing HPE OneView global setting. Settings control appliance-wide behavior such as session timeouts, login banner text, and other administrative options. The cmdlet supports two parameter sets:
  • Default: Specify the setting by -Name and provide the new -Value.
  • Pipeline: Pipe a HPEOneView.Appliance.GlobalSetting object from Get-OVApplianceGlobalSetting and supply the new -Value.
To discover available setting names, first run Get-OVApplianceGlobalSetting.

​
Parameters

​
InputObject
HPEOneView.Appliance.GlobalSetting
A HPEOneView.Appliance.GlobalSetting object received from the pipeline (e.g. from Get-OVApplianceGlobalSetting). Alias: Object. Required in the Pipeline parameter set.
​
Name
String
required
The exact name of the global setting to update. Required in the Default parameter set.
​
Value
String
required
The new value to assign to the setting. Required in both parameter sets.
​
ApplianceConnection
Object
Specifies the HPE OneView appliance connection(s) to configure. Defaults to the default connection from ${Global:ConnectedSessions}. Alias: Appliance.

​
Examples

Example 1: Update a setting by name 
Set-OVApplianceGlobalSetting -Name 'applianceSessionTimeout' -Value '180'
Sets the appliance session timeout to 180 minutes. Example 2: Update a setting via pipeline 
Get-OVApplianceGlobalSetting -Name 'applianceSessionTimeout' | Set-OVApplianceGlobalSetting -Value '120'
Retrieves the session timeout setting and updates it to 120 minutes using pipeline input. Example 3: Update a setting on a specific appliance 
Set-OVApplianceGlobalSetting \
    -Name 'loginBannerMessage' \
    -Value 'Authorized users only.' \
    -ApplianceConnection $MyConnection
Sets the login banner message on the specified appliance.

​
Output

HPEOneView.Appliance.GlobalSetting Returns the updated HPEOneView.Appliance.GlobalSetting object reflecting the new value.

Build docs developers (and LLMs) love

Get started for freeTalk to us