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

Defines SBA Singleton Managed Object.

Tip

The SBA is setup by performing a set of actions in a specified order. Failing to follow the order can result in undersirable behavior. The setup steps are as follows:

Repeating any of the above actions once the setup is performed, might result in undesirable behavior. It is recommended that the SBA is re-initialized if the step has to be performed and the setup done again in the above order.

Any other action can be performed at any time once the SBA is setup without any implications.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DHCPEnabledNoYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Dynamic Host Configuration Protocol (DHCP) for network configuration. If DHCP is enabled, it overrides the IP address and DNS settings.
ipv4AddressNoYesstringnone16 - Max LengthSpecifies a manually configured IPv4 address for this ethernet port, when DHCP is not enabled.
ipv4NetmaskNoYesstringnone16 - Max LengthSpecifies the netmask for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
ipv4GatewayNoYesstringnone16 - Max LengthSpecifies the default gateway for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
RemoteDesktopEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Remote Desktop for direct console login. This function is intended for administrator use only.
DNSServer1NoYesstringnone64 - Max LengthSpecifies a manually configured Domain Name Server address for IP name resolution. This server is used first for DNS requests. Applicable when DHCP is not enabled.
DNSServer2NoYesstringnone64 - Max LengthSpecifies a manually configured Domain Name Server address for IP name resolution. This server is used when the Preferred DNS server is slow or unreachable. Applicable when DHCP is not enabled.
AclEnableNoYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables the ASM Windows firewall.

Runtime

Parameter Name Possible Values Description
rt_NumEthPortsDisplays the number of physical ethernet ports on the ASM module.
rt_RDPEnabledPossible values:
  • 0 - btFalse
  • 1 - btTrue
This specifies if RDP is enabled on the ASM.
rt_AsmReachablePossible values:
  • 0 - btFalse
  • 1 - btTrue
Displays true/false if the ASM module is reachable through the Sonus SBC 1000/2000 management communication.
rt_MediationSvcStatePossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
Displays the current status of the Mediation Service on the ASM.
rt_RegistrarSvcStatePossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
Displays the current status of the Registrar Service on the ASM.
rt_SQLSvcStatePossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
Displays the current status of the SQL Service on the ASM.
rt_DomainDisplays the Windows domain name (if joined) that the ASM belongs to.
rt_HostNameDisplays the Windows host name of the ASM.
rt_LicensedPossible values:
  • 0 - btFalse
  • 1 - btTrue
Displays whether the SBA or RBA has acquired a valid license.
rt_UpTimeDisplays the amount of time the ASM has been running. This value may differ from the Sonus SBC system up time.
rt_UXComVersionDisplays the version of the Sonus SBC 1000/2000 Communications Service running on the ASM
rt_MediationVersionDisplays the version of the Mediation Service running on the ASM
rt_RegistrarVersionDisplays the version of the Registrar Service running on the ASM
rt_SQLVersionDisplays the version of the SQL Service running on the ASM
rt_WindowsVersionDisplays the internal version number of the ASM Operating System.
rt_WinCpuUsageDisplays the current snapshot of the Windows overall CPU usage
rt_MediationCpuTimeDisplays the number of seconds of CPU runtime that the Mediation Service on the ASM has used
rt_RegistrarCpuTimeDisplays the number of seconds of CPU runtime that the Registrar Service on the ASM has used
rt_SQLCpuTimeDisplays the number of seconds of CPU runtime that the SQL Service on the ASM has used
rt_UXSBACpuTimeDisplays the number of seconds of CPU runtime that the Sonus SBC 1000/2000 Communications Service on the ASM has used.
rt_WinMemFreeDisplays the amount of free memory that Windows currently reports
rt_MediationMemUsageDisplays the number of bytes of memory consumed by the Mediation Service on the ASM
rt_RegistrarMemUsageDisplays the number of bytes of memory consumed by the Registrar Service on the ASM
rt_SQLMemUsageDisplays the number of bytes of memory consumed by the SQL Service on the ASM
rt_UXSBAMemUsageDisplays the number of bytes of memory consumed by the Sonus SBC 1000/2000 Communications Service on the ASM
rt_LoginNamesDisplays a list of users current logged onto the ASM.
rt_DHCPEnabledPossible values:
  • 0 - btFalse
  • 1 - btTrue
Displays the Dynamip Host Configuration Protocol (DHCP) for network configuration setting.
rt_IPv4AddressDisplays the manually configured IPv4 address for this ethernet port, when DHCP is not enabled.
rt_IPv4NetmaskDisplays the manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
rt_IPv4GatewayDisplays the manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
rt_ReplicationUpToDatePossible values:
  • 0 - tsbUnknown
  • 1 - tsbTrue
  • 2 - tsbFalse
Displays whether the Lync Server Replica is up to date.
rt_ReplicationFQDNDisplays the fully-qualified domain name of the Lync Server Replica.
rt_ReplicationLastStatusReportDisplays the date and time of the last status report from the Lync Server Replica.
rt_ReplicationLastUpdateCreationDisplays the date of the last update of the Lync Server Replica.
rt_ReplicationProductVersionDisplays the Service Version of the Lync Server Replica.
rt_ImageDescriptionDisplays the type of the ASM image running on the ASM.
rt_UpdateStatePossible values:
  • 0 - ausUnknown
  • 1 - ausUpToDate
  • 2 - ausAvailable
  • 3 - ausInstalling
  • 4 - ausQuerying
  • 5 - ausErrorState
Displays the status of the Windows Update service.
rt_PendingRestartNeededPossible values:
  • 0 - tsbUnknown
  • 1 - tsbTrue
  • 2 - tsbFalse
Displays the need of a reboot for Windows Update.
rt_StatusTextDisplays the need of a reboot for Windows Update.
rt_ReplicationErrorsDisplays additional information in case of failure during Replication .
rt_QoEReportSuccessDisplays the number of QoE reports successfully stored
rt_QoEReportFailureDisplays the number of QoE reports failed to be stored
rt_ASM_ComputerManufacturerIf the device has an ASM, this contains the ASM manufacturer.
rt_ASM_ComputerModelIndicates the model of the ASM hardware.
rt_ASM_ProcessorNameIndicates the CPU name of the ASM.
rt_ASM_ProcessorCPUsIndicates the number of CPUs present on the ASM.
rt_ASM_ProcessorClockSpeedIndicates the clock speed of the ASM's CPU.
rt_ASM_PhysicalMemoryIndicates the amount of RAM present on the ASM.
rt_ASM_BIOSManufacturerIndicates the manufacturer of the ASM's BIOS.
rt_ASM_BIOSVersionIndicates the BIOS version of the ASM.
rt_ASM_HDDSizeIndicates the hard drive size on the ASM.
rt_ASM_ImageTypeIndicates the software image type (SBA, RBA) running on the ASM.
rt_PowerLEDPossible values:
  • 0 - eLEDState_on
  • 1 - eLEDState_off
  • 2 - eLEDState_blink
Indication of state of the chassis POWER LED - On or Off.
rt_ReadyLEDPossible values:
  • 0 - eLEDState_on
  • 1 - eLEDState_off
  • 2 - eLEDState_blink
Indication of the state of the chassis READY LED - On or Off.