3.1.5.28 networkControllerRestore

The networkControllerRestore resource SHOULD<17> be used to restore from disk all the applicable configuration data for a network controller. The configuration of the network controller MUST first be backed up via a PUT operation on a networkControllerBackup resource. For more details, see networkControllerBackup section 3.1.5.27.

It is invoked through the following URI.

 https://<url>/networking/v1/networkControllerRestore/{resourceId}

url: The address or name of the REST server of the Network Controller.

resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.28.1.1

Create a new networkControllerRestore resource or update an existing networkControllerRestore resource.

GET

3.1.5.28.1.2

Get a networkControllerRestore resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

instanceId

Read-only

Specified in Common JSON Elements, section 2.2.2.

restorePath

Required

Location from which to pick up the backup data. The location MUST contain data previously created by a PUT operation on a networkControllerBackup resource.

credential

Required

A reference (resourceRef in section 2.2.2) to a credentials resource. The credential MUST be of type usernamePassword. The credential is used to access the restorePath.

statusMessages

Read-only

An array of strings that describe the current progress of the restore. The messages are implementation-specific. They can provide time stamps or the time that was spent restoring resources. An empty array can be returned.

successfulResourceList

Read-only

Array of strings that represent references (resourceRef in section 2.2.2) for resources that were restored successfully. An empty array can be returned.

failedResourceList

Read-only

Array of strings that represent references (resourceRef in section 2.2.2) for resources that were not restored successfully. An empty array can be returned.