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

Retrieves one or more global configuration settings from the HPE OneView appliance.

​
Syntax

Get-OVApplianceGlobalSetting
    [-Name <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Get-OVApplianceGlobalSetting queries the appliance global settings store and returns all settings, or filters by name when -Name is provided. The -Name parameter supports wildcard matching. Global settings control appliance-wide behavior such as login banner text, session timeout durations, and other administrative options. Settings are read-only with this cmdlet; use Set-OVApplianceGlobalSetting to modify a setting value. The cmdlet returns HPEOneView.Appliance.GlobalSetting typed objects.

​
Parameters

​
Name
String
Filters the returned settings to those whose name matches the provided value. Supports wildcard characters (e.g. *session*). When omitted, all global settings are returned.
​
ApplianceConnection
Object
Specifies the HPE OneView appliance connection(s) to query. Defaults to the default connection from ${Global:ConnectedSessions}. Alias: Appliance.

​
Examples

Example 1: Retrieve all global settings 
Get-OVApplianceGlobalSetting
Returns all global configuration settings for the default connected appliance. Example 2: Retrieve a specific setting by name 
Get-OVApplianceGlobalSetting -Name 'applianceSessionTimeout'
Returns the applianceSessionTimeout global setting. Example 3: Filter settings using a wildcard 
Get-OVApplianceGlobalSetting -Name '*session*'
Returns all global settings whose name contains the word “session”. Example 4: Query a specific appliance 
Get-OVApplianceGlobalSetting -ApplianceConnection $MyConnection
Retrieves all global settings from the specified appliance connection.

​
Output

HPEOneView.Appliance.GlobalSetting An object per setting containing the following properties:
PropertyDescription
NameThe setting identifier
ValueThe current setting value
GroupThe settings group category
SettingCategoryA finer-grained category within the group
CreatedTimestamp when the setting was created
ModifiedTimestamp of the last modification
UriThe REST API URI for this setting

Build docs developers (and LLMs) love

Get started for freeTalk to us