Skip to end of metadata
Go to start of metadata

About this Resource

The Auto Configuration Task allows the user to configure settings for provisioning SBC Edge system from a BroadSoft Server.

Auto Configuration Task updates the firmware, boot image and configuration from a BroadSoft Server . The node is first registered with the BroadSoft Server. The BroadSoft Server triggers the updates by sending SIP NOTIFY message. On the node, the SG configured for Auto Configuration receives this NOTIFY message. The system then downloads the required files from the BroadSoft Server and performs the updates. The updates are performed sequentially in the following order - Boot Image, Configuration and Firmware. The system will reboot if the updates are successful.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Enables or disables Auto Configuration.
DeviceAccessURLYesNostringnone512 - Max Length Specifies the base URL for accessing files on the BroadSoft Server.
EnableConfigUpdateYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables the configuration update when SIP NOTIFY message is received from BroadSoft Server.
EnableFirmwareUpdateYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables the firmware update when SIP NOTIFY message is received from BroadSoft Server.
EnableBootUpdateYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables the firmware update when SIP NOTIFY message is received from BroadSoft Server.
UserNameYesYesstringnone128 - Max Length User name to use for the BroadSoft server authentication.
PasswordYesYesstringnone128 - Max Length Password to use for the BroadSoft server authentication.
autoConfigSGYesYesint0 Specifies the SIP Signaling Group ID used for receiving SIP NOTIFY messages from the BroadSoft Server. SIP Signaling Group ID can be obtained by performing a lookup on sipsg resource using GET sipsg