Versions Compared

Old Version 12

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/system?action=importconfig

This action imports a configuration file into a SBC Edge Portfolio system.

Info

The file being imported must be from a node of the same model, running the same release and having same hardware configuration as the target node. Failure to do so will result in an invalid configuration.

Info

If the action fails, a set of Application Status Error Codes will be returned representing all configuration validation errors found in the file and detected by the SBC. If the action succeeds, the SBC will automatically reboot.

Note

If the ConfigMaskUsage parameter is 0 (cmuKeepMaskedItems), then if the MaskedItems parameter is empty, all configuration data will be imported using the following default masked resources:

These default masked resources above ensure an imported configuration file (originating from another SBC Edge Portfolio system) do not overwrite the target system's vital information, namely the Ethernet Port's configuration, Static IP Routes, etc...

Warning

If the MaskedItems parameter is sent with resource values, then the default masked resources listed above will not be applied in addition to what you have specified.

URL:

https://192.168.0.111/rest/system?action=importconfig

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[system - REST API Methods|Resource - system]

Page Tree
root@parent



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
FilenameYesYesstringnone128 - Max LengthIdentifies the name of the configuration file being uploaded to the SBC. It needs to be from a node of a similar release.
PassphraseNoYesstringnone128 - Max LengthIdentifies the passphrase to be used for the password decryption operation. If the password decryption fails, all the passwords in the configuraion will be set to NULL, user should reset all the passwords manually. The password decryption fails in two circumstances 1) when the wrong passphrase used for the import operation. 2) When the configuration was exported with the passphrase and the configuration is imported without the passphrase.
ConfigMaskUsageNoYesEnum0Possible values:
  • 0 - cmuKeepMaskedItems
  • 1 - cmuMergeMaskedItems
  • 2 - cmuReplaceMaskedItems
This attribute defines the usage of the MaskedItems attribute. 0: resources given in MaskedItems are excluded from the configuration import, 1: resources given in MaskedItems are merged from the imported configuration into the current configuration, and 2: imported resources given in MaskedItems replace those in the current configuration.
MaskedItemsNoYesstringnone20000 - Max LengthIdentifies a comma separated string of the resource URIs of the resources, to be applied as indicated by the 'MaskUsage' attribute: 0: the masked resources are excluded from the configuration import, 1: the masked resources from the imported configuration are merged into the current configuration, and 2: the masked resources from the imported configuration replace those in the current configuration. Individual resources or wildcards can be provided in the resource URI. (e.g. URI without an ID: /rest/resource, URI with an ID: /rest/resource/ID, and URI with a wildcard: /rest/parent-resource/*/child-resource). If this is empty, a default MaskedItems will be applied based on the MaskUsage setting: 0: a default set of node-specific resources will be masked from the import, 1 and 2: no default will be applied, an error will be returned.