Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 2

changes.mady.by.user Ribbon Communications

Saved on

Key

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

About this Resource

Availability: Since 3.1.0

Excerpt

The SBA Action Status allows the user to query the status of an action performed on the SBA. Many of the actions on the SBA take some time, so this resource helps to query the status of the action performed while it is going on till it is completed or fails.

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Possible Values Description
rt_SuccessPossible values:
  • 0 - rmBool_False
  • 1 - rmBool_True
Identifies whether the action was successfully performed or not.
rt_ActionTypePossible values:
  • 0 - barNop
  • 1 - barEnableSvc
  • 2 - barDisableSvc
  • 3 - barChangeAdminPassword
  • 4 - barJoinDomain
  • 5 - barViewReplicationStatus
  • 6 - barForceReplicationDoNotUse
  • 7 - barActivateCS
  • 8 - barUnjoinDomain
  • 9 - barFactoryReset
  • 10 - barRebootCard
  • 11 - barResetCard
  • 12 - barInstallCertificate
  • 13 - barListCertificates
  • 14 - barExportCSR
  • 15 - barInstallUpdate
  • 16 - barSetTime
  • 17 - barTestCall
  • 18 - barExportConfig
  • 19 - barImportConfig
  • 20 - barEnableReplica
  • 21 - barApplySecurity
  • 22 - barDeploySystem
  • 23 - barGetInstalledPackages
  • 24 - barActionStatus
  • 25 - barSetHostName
  • 26 - barGetHostName
  • 27 - barShutdownASM
  • 28 - barReloadFromUSB
  • 29 - barSBALicense
  • 30 - barPowerOnASM
  • 31 - barSetIPAddress
  • 32 - barGetEventLog
  • 33 - barClearEventLog
  • 34 - barExportEventLog
  • 35 - barInstallBackgroundUpdates
  • 36 - barQueryFactoryImages
  • 37 - barAsmAclListAllRule
  • 38 - barAclReset
  • 39 - barRunDebugCommand
  • 40 - barUpdateCACProfile
  • 41 - barExportCertP12
  • 42 - barUpdateQoEInfos
  • 43 - barQoECountersReset
  • 44 - barMaximum
Identifies the current action or the last action that was performed
rt_PercentCompleteIdentifies the percentage of the action that is completed. A value of -1, indicates that no action is currently running.
Tip

This must be used to identify if the action is complete or not before performing another action. It must be used in conjunction with the Success attribute.

rt_StatusTextIndicates any additional information about the status of the action. This usually contains error strings in case the action is not successful.
rt_AllActionsBitmapIdentifies a bitmask of the status of all the actions needed to setup the SBA. The value will indicate which actions have already been performed. If a step is complete, then all steps prior to it is assumed complete. The bitmask with the value is as follows:

Join domain Complete ==> Value is 1

Deploy SBA Complete ==> Value is 3

Replication Started ==> Value is 7

Activation with Lync Server Complete ==> Value is 15

Certificate action Complete ==> Value is 31

Start Services Complete ==> Value is 63

Security Template Applied ==> Value is 127