GetAdapterConnectionSpec

A partially complete connection spec that will have its address and opaque keys, for the key value pairs, pre-entered. Refer your SRA vendor specific documentation about what each key represents.

Synopsis

AdapterConnectionSpec[] getAdapterConnectionSpec();

This method returns array of AdapterConnectionSpec objects for the available SRAs. Part of the data is pre-entered, as shown in the example below:

Example of returned partially-complete spec

connectionSpec.name.key = "primary"
connectionSpec.name.name = "Primary SAN"
connectionSpec.name.hint = "Primary SAN connection parameters"
connectionSpec.adress[0].key = "spA"
connectionSpec.adress[0].name = "IP Address of SP-A"
connectionSpec.adress[0].hint = "Enter IP address of the Storage Processor A"
connectionSpec.adress[0].value = empty (expected user input)
connectionSpec.opaque[0].key = "volumeNameFilter"
connectionSpec.opaque[0].name = "Volume name prefix limiting discovery"
connectionSpec.opaque[0].hint = "Leave empty for full discovery"
connectionSpec.opaque[0].optional = "true"
connectionSpec.adress[0].value = empty (expected user input)

AdapterConnectionSpec has the following fields:


Field	Description
DataPrompt key	Identifier of a SRA-defined group of connection parameters. Refer your SRA vendor specific documentation for more information about this value. This will be automatically entered by the `StorageAdapter#getAdapterConnectionSpec`.
@optional DataPrompt[] address	List of address-type parameters. Refer your SRA vendor specific documentation about the keys and their corresponding values. Keys will be automatically entered by the `StorageAdapter#getAdapterConnectionSpec`.
username	Username.
password	Password if required.
@optional OpaquePrompt[] opaque	Opaque parameters if required. Refer your SRA vendor specific documentation about the keys and their corresponding values. Keys will be automatically entered by the `StorageAdapter#getAdapterConnectionSpec`.

DataPrompt contains key-value pairs with additional information about the key and what value it expects. It has the following fields:


Field	Description
key	SRA Specific key, this can be either for the address or the opaque.
@optional LocalizableString name	Prompt string.
LocalizableString hint	Sample or more verbose description of the requested data for
value	Value corresponding to the key.

LocalizableString describes localizable string returned from the SRA. Localization support is optional for SRA. If supported, then each string is returned with a key which could be used to lookup a translation in non-default locale.

Example of localizable string returned from SRA: <Xxx stringId="Foo">Foo</Xxx>

Example of non-localizable string returned from SRA: <Xxx>Foo</Xxx>

LocalizableString has the following fields:


Field	Description
key	Key to look up translation for the string. This key is made optional to accommodate SRAs which do not support localization. These SRAs will just return strings in default locale (English).
text	String text in default locale

OpaquePrompt extends DataPrompt. It contains additional information about the opaque parameters. It has the following fields:


Field	Description
optional	Boolean indicating whether or not this parameter is optional.

Faults

RuntimeFault

For information about the faults that Site Recovery Manager throws, see Faults in Site Recovery Manager API.