NAME

Connect-HPOVMgmt

SYNOPSIS

Initiate a connection to an HP OneView appliance.

SYNTAX

Connect-HPOVMgmt [-appliance] <String> [[-authProvider] <String>] [-User] <String> [[-password] <String>] [<CommonParameters>]

DESCRIPTION

Establish a connection with the specified HP OneView appliance. Logs the user into the appliance and establishes a session for use with subsequent requests. Prompts will be displayed for any omitted values. Appliance hostname or IP can include an alternate TCP port number. While the appliance does not allow the default TCP port 443 to be changed, the appliance could reside behind a firewall, which is redirecting an alternate TCP port number.

PARAMETERS

-appliance <String>
The hostname or IP address of the appliance.
Aliases None
Required? true
Position? 1
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-authProvider [<String>]
The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts. Default is LOCAL.
Aliases None
Required? false
Position? 4
Default value LOCAL
Accept pipeline input? false
Accept wildcard characters?    false
-User <String>
Alias [-u] User name to authenticate.
Aliases None
Required? true
Position? 2
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-password [<String>]
Alias [-p] Password to log into the appliance.
Aliases None
Required? false
Position? 3
Default value <none>
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).

INPUTS

None. You cannot pipe objects to this cmdlet.

OUTPUTS

None.

On successful auth, command prompt will display [username]@[appliance]. If console prompt is disabled via the Set-HPOVPrompt cmdlet, Show-HPOVAppliance can be used.

System.Management.Automation.PSCustomObject

On error, appliance response is returned.

RELATED LINKS

EXAMPLES

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

PS C:\> Connect-HPOVMgmt -appliance myappliance.acme.com
Connect to a specific appliance FQDN. The user will be prompted for authentication provider, user name and password.
-------------------------- EXAMPLE 2 -------------------------- 

PS C:\> Connect-HPOVMgmt -appliance myappliance.acme.com:11223
Connect to a specific appliance, where the target TCP port isn't the default. The user will be prompted for authentication provider, user name and password.

Last edited Aug 17, 2014 at 6:25 AM by ChrisLynchHP, version 6