3.1.5.27 networkControllerBackup

The networkControllerBackup resource SHOULD<13> be used to persist to disk all the applicable configuration data for a network controller. The backed-up data can be used to restore the configuration of the network controller. For more details, see networkControllerRestore section 3.1.5.28. The format of the backed-up data is implementation-specific and is treated as opaque data.

It is invoked through the following URI.

 https://<url>/networking/v1/networkControllerBackup/{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.27.1.1

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

GET

3.1.5.27.1.2

Get a networkControllerBackup 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.

backupPath

Required

A path to a location where the backup operation persists files.

credential

Optional

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 backupPath.

errorMessage

Read-only

A string that describes an error, such as, backupPath is not accessible. An empty string can be returned.

failedResourcesList

Read-only

An array of strings that are references (resourceRef in section 2.2.2) to resources that could not be backed up. An empty array can be returned.<14>

successfulResourcesList

Read-only

An array of strings that are references (resourceRef in section 2.2.2) to resources that were successfully backed up. An empty array can be returned.<15>

inProgressResourcesList

Read-only

An array of strings that are references (resourceRef in section 2.2.2) to resources that are in progress of being backed up. An empty array can be returned.<16>