Get HPOVIloSso - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVIloSso

Generate iLO SSO Token.

SYNTAX

Get-HPOVIloSso [-InputObject] <Object>[ [-RemoteConsoleOnly] <SwitchParameter>][ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVIloSso [-InputObject] <Object>[ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]

Detailed Description

Obtain an iLO SSO Token URL to authenticate to an iLO. If the server hardware is unsupported, the resulting URL will not use SSO and the iLO web interface will prompt for credentials. Note, this is not supported on G7 or earlier servers.

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-IloRestSession <SwitchParameter>

Generate an HPRESTCmdlets compliant IloSession object.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-InputObject <Object>

The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.

Aliases Server
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-RemoteConsoleOnly <SwitchParameter>

Generate an SSO URL Token for accessing the Remote Console.

Aliases None
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]

Server Hardware resource object.

HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]

Server Profile resource object.

Return Values

System.Management.Automation.PSCustomObject

SSO Url Object

System.Array

Multiple SSO URL objects.

Examples

 -------------------------- EXAMPLE 1 --------------------------

$SSOObjects = Get-HPOVServer | Get-HPOVIloSso

Generate iLO SSO Objects for all managed server resources.

 -------------------------- EXAMPLE 2 --------------------------

$SSOObject = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso

Generate iLO SSO Object for the specified managed server resource.

 -------------------------- EXAMPLE 3 --------------------------

$SSOObject = Get-HPOVServerProfile -Name "My Server Profile" | Get-HPOVIloSso

Generate iLO SSO Object for the specified managed server resource.

 -------------------------- EXAMPLE 4 --------------------------

$IloSession = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso -IloRestSession

Generate iLO SSO Object that can then be used with the HPRESTCmdlets.

Related Links


Top

HPE OneView 4.00 Library

Get-HPOVIloSso

Generate iLO SSO Token.

SYNTAX

Get-HPOVIloSso [-InputObject] <Object>[ [-RemoteConsoleOnly] <SwitchParameter>][ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVIloSso [-InputObject] <Object>[ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]

Detailed Description

Obtain an iLO SSO Token URL to authenticate to an iLO. If the server hardware is unsupported, the resulting URL will not use SSO and the iLO web interface will prompt for credentials. Note, this is not supported on G7 or earlier servers.

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-IloRestSession <SwitchParameter>

Generate an HPRESTCmdlets compliant IloSession object.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-InputObject <Object>

The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.

Aliases Server
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-RemoteConsoleOnly <SwitchParameter>

Generate an SSO URL Token for accessing the Remote Console.

Aliases None
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]

Server Hardware resource object.

HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]

Server Profile resource object.

Return Values

System.Management.Automation.PSCustomObject

SSO Url Object

System.Array

Multiple SSO URL objects.

Examples

 -------------------------- EXAMPLE 1 --------------------------

$SSOObjects = Get-HPOVServer | Get-HPOVIloSso

Generate iLO SSO Objects for all managed server resources.

 -------------------------- EXAMPLE 2 --------------------------

$SSOObject = Get-HPOVServer -Name 'Enc1, bay 1' | Get-HPOVIloSso

Generate iLO SSO Object for the specified managed server resource.

 -------------------------- EXAMPLE 3 --------------------------

$SSOObject = Get-HPOVServerProfile -Name 'My Server Profile' | Get-HPOVIloSso

Generate iLO SSO Object for the specified managed server resource.

 -------------------------- EXAMPLE 4 --------------------------

$IloSession = Get-HPOVServer -Name 'Enc1, bay 1' | Get-HPOVIloSso -IloRestSession

Generate iLO SSO Object that can then be used with the HPRESTCmdlets.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️