You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

About this Resource

Availability: Since 3.1.0

Defines SBA Singleton Managed Object.

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 Length Specifies a manually configured IPv4 address for this ethernet port, when DHCP is not enabled.
ipv4NetmaskNoYesstringnone16 - Max Length Specifies the netmask for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
ipv4GatewayNoYesstringnone16 - Max Length Specifies 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 Length Specifies 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 Length Specifies 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 Description Data Type Possible Values
rt_NumEthPorts Displays the number of physical ethernet ports on the ASM module. int
rt_RDPEnabled This specifies if RDP is enabled on the ASM. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_AsmReachable Displays true/false if the ASM module is reachable through the Sonus SBC 1000/2000 management communication. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_MediationSvcState Displays the current status of the Mediation Service on the ASM. EnumPossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
rt_RegistrarSvcState Displays the current status of the Registrar Service on the ASM. EnumPossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
rt_SQLSvcState Displays the current status of the SQL Service on the ASM. EnumPossible values:
  • 0 - bssRunning
  • 1 - bssStopped
  • 2 - bssStarting
  • 3 - bssStopping
  • 4 - bssNotAvailable
rt_Domain Displays the Windows domain name (if joined) that the ASM belongs to. string
rt_HostName Displays the Windows host name of the ASM. string
rt_Licensed Displays whether the SBA or RBA has acquired a valid license. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_UpTime Displays the amount of time the ASM has been running. This value may differ from the Sonus SBC system up time. long
rt_UXComVersion Displays the version of the Sonus SBC 1000/2000 Communications Service running on the ASM string
rt_MediationVersion Displays the version of the Mediation Service running on the ASM string
rt_RegistrarVersion Displays the version of the Registrar Service running on the ASM string
rt_SQLVersion Displays the version of the SQL Service running on the ASM string
rt_WindowsVersion Displays the internal version number of the ASM Operating System. string
rt_WinCpuUsage Displays the current snapshot of the Windows overall CPU usage int
rt_MediationCpuTime Displays the number of seconds of CPU runtime that the Mediation Service on the ASM has used long
rt_RegistrarCpuTime Displays the number of seconds of CPU runtime that the Registrar Service on the ASM has used long
rt_SQLCpuTime Displays the number of seconds of CPU runtime that the SQL Service on the ASM has used long
rt_UXSBACpuTime Displays the number of seconds of CPU runtime that the Sonus SBC 1000/2000 Communications Service on the ASM has used. long
rt_WinMemFree Displays the amount of free memory that Windows currently reports long
rt_MediationMemUsage Displays the number of bytes of memory consumed by the Mediation Service on the ASM long
rt_RegistrarMemUsage Displays the number of bytes of memory consumed by the Registrar Service on the ASM long
rt_SQLMemUsage Displays the number of bytes of memory consumed by the SQL Service on the ASM long
rt_UXSBAMemUsage Displays the number of bytes of memory consumed by the Sonus SBC 1000/2000 Communications Service on the ASM long
rt_LoginNames Displays a list of users current logged onto the ASM. string
rt_DHCPEnabled Displays the Dynamip Host Configuration Protocol (DHCP) for network configuration setting. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_IPv4Address Displays the manually configured IPv4 address for this ethernet port, when DHCP is not enabled. string
rt_IPv4Netmask Displays the manually configured IPv4 address on this ethernet port, when DHCP is not enabled. string
rt_IPv4Gateway Displays the manually configured IPv4 address on this ethernet port, when DHCP is not enabled. string
rt_ReplicationUpToDate Displays whether the Lync Server Replica is up to date. EnumPossible values:
  • 0 - tsbUnknown
  • 1 - tsbTrue
  • 2 - tsbFalse
rt_ReplicationFQDN Displays the fully-qualified domain name of the Lync Server Replica. string
rt_ReplicationLastStatusReport Displays the date and time of the last status report from the Lync Server Replica. long
rt_ReplicationLastUpdateCreation Displays the date of the last update of the Lync Server Replica. long
rt_ReplicationProductVersion Displays the Service Version of the Lync Server Replica. string
rt_ImageDescription Displays the type of the ASM image running on the ASM. string
rt_UpdateState Displays the status of the Windows Update service. EnumPossible values:
  • 0 - ausUnknown
  • 1 - ausUpToDate
  • 2 - ausAvailable
  • 3 - ausInstalling
  • 4 - ausQuerying
  • 5 - ausErrorState
rt_PendingRestartNeeded Displays the need of a reboot for Windows Update. EnumPossible values:
  • 0 - tsbUnknown
  • 1 - tsbTrue
  • 2 - tsbFalse
rt_StatusText Displays the need of a reboot for Windows Update. string
rt_ReplicationErrors Displays additional information in case of failure during Replication . string
rt_QoEReportSuccess Displays the number of QoE reports successfully stored int
rt_QoEReportFailure Displays the number of QoE reports failed to be stored int
rt_ASM_ComputerManufacturer If the device has an ASM, this contains the ASM manufacturer. string
rt_ASM_ComputerModel Indicates the model of the ASM hardware. string
rt_ASM_ProcessorName Indicates the CPU name of the ASM. string
rt_ASM_ProcessorCPUs Indicates the number of CPUs present on the ASM. string
rt_ASM_ProcessorClockSpeed Indicates the clock speed of the ASM's CPU. string
rt_ASM_PhysicalMemory Indicates the amount of RAM present on the ASM. string
rt_ASM_BIOSManufacturer Indicates the manufacturer of the ASM's BIOS. string
rt_ASM_BIOSVersion Indicates the BIOS version of the ASM. string
rt_ASM_HDDSize Indicates the hard drive size on the ASM. string
rt_ASM_ImageType Indicates the software image type (SBA, RBA) running on the ASM. string
rt_PowerLED Indication of state of the chassis POWER LED - On or Off. EnumPossible values:
  • 0 - eLEDState_on
  • 1 - eLEDState_off
  • 2 - eLEDState_blink
rt_ReadyLED Indication of the state of the chassis READY LED - On or Off. EnumPossible values:
  • 0 - eLEDState_on
  • 1 - eLEDState_off
  • 2 - eLEDState_blink
  • No labels