Test-HcsStorageAccountCredential

Windows Server 2012 R2 and Windows 8.1

Test-HcsStorageAccountCredential

Validates settings and connection for a cloud storage provider.

Syntax

Parameter Set: BeforeCreate
Test-HcsStorageAccountCredential -CloudType <CloudType> {Azure | S3 | S3_RRS | OpenStack | HP} -Hostname <String> -Login <String> -Password <String> -UseSSL <Boolean> [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: Id
Test-HcsStorageAccountCredential [-InstanceId] <Guid> [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: Name
Test-HcsStorageAccountCredential -Name <String> [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]




Detailed Description

The Test-HcsStorageAccountCredential cmdlet validates settings and connection for a cloud storage provider. Specify an instance ID or the name of a data container to test a connection that you previously configured. You must create the data containers by using the StorSimple Manager Service. Supply cloud connection information to perform on demand testing.

Parameters

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CloudType<CloudType>

Specifies the cloud type. The acceptable values for this parameter are:

-- Azure


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Hostname<String>

Specifies the URL of the cloud service.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InstanceId<Guid>

Specifies the ID of an existing MSFT_HCSStorageAccountCredential object.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Login<String>

Specifies your account login.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name. The cmdlet test the connection for the data container that you specify by name.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Password<String>

Specifies a password. The password that you specify corresponds to the account that you specify in the Login parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseSSL<Boolean>

Indicates whether to use Secure Sockets Layer (SSL).


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_HCSStorageAccountCredential_TestResult

    The CimInstance#MSFT_HCSStorageAccountCredential_TestResult object has the following properties:

    -- MI_Instance __instance
    -- MI_ConstSint32Field StatusCode
    -- MI_ConstSint32Field HttpCode
    -- MI_ConstStringField HttpMessage
    -- MI_ConstStringField HcsErrorMessage


Examples

Example 1: Test a connection

This command tests the connection to a Storage account. The command specifies a host name, and the Login and Password parameters.


PS C:\> Test-HcsStorageAccountCredential -CloudType Azure -Hostname "http://storagelocal.blob.core.contoso.azure.net/storsimple-1b549506-2db7-4134-93c5-94edfd22894b/owner_details/owner_details" -Login "StorageAccount" -Password 'P/1XepJYuT78s8LoomDRgNp6LNnngbw22eMG6Raop2LzDrh2rbIimzYO7m+6bK0d9CU8RqfDOG+lMSwDje0zuz==' -UseSSL $True

Related topics

Community Additions

ADD
Show: