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:
The CCE 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:
Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
---|---|---|---|---|---|---|
DHCPEnabled | No | Yes | Enum | 1 | Possible values:
| Enables Dynamic Host Configuration Protocol (DHCP) for network configuration. If DHCP is enabled, it overrides the IP address and DNS settings. |
ipv4Address | No | Yes | string | none | 16 - Max Length | Specifies a manually configured IPv4 address for this ethernet port, when DHCP is not enabled. |
ipv4Netmask | No | Yes | string | none | 16 - Max Length | Specifies the netmask for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled. |
ipv4Gateway | No | Yes | string | none | 16 - Max Length | Specifies the default gateway for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled. |
RemoteDesktopEnabled | No | No | Enum | 0 | Possible values:
| Enables Remote Desktop for direct console login. This function is intended for administrator use only. |
DNSServer1 | No | Yes | string | none | 64 - 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. |
DNSServer2 | No | Yes | string | none | 64 - 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. |
AclEnable | No | Yes | Enum | 1 | Possible values:
| Enables the ASM Windows firewall. |
ipv6Address | No | Yes | string | none | 45 - Max Length | Specifies a manually configured IPv6 address for this ethernet port. |
ipv6PrefixLen | No | Yes | int | 64 | Possible values:
| Specifies the netmask prefix length for a manually configured IPv6 address on this ethernet port. |
ipv6Gateway | No | Yes | string | none | 45 - Max Length | Specifies the default gateway for a manually configured IPv6 address on this ethernet port. |
Eth2ipv4DHCPEnabled | No | Yes | Enum | 1 | Possible values:
| Enables Dynamic Host Configuration Protocol (DHCP) for ASM Port 2 network configuration. If DHCP is enabled, it overrides the IP address and DNS settings. |
Eth2ipv4Address | No | Yes | string | none | 16 - Max Length | Specifies a manually configured IPv4 address for the ASM Port 2, when DHCP is not enabled. |
Eth2ipv4Netmask | No | Yes | string | none | 16 - Max Length | Specifies the netmask for a manually configured IPv4 address on the ASM Port 2, when DHCP is not enabled. |
Eth2DNSServer1 | No | Yes | string | none | 64 - 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. |
Eth2DNSServer2 | No | Yes | string | none | 64 - 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. |
Eth2ipv6Address | No | Yes | string | none | 45 - Max Length | Specifies a manually configured IPv6 address on the ASM Port 2. |
Eth2ipv6PrefixLen | No | Yes | int | 64 | Possible values:
| Specifies the netmask prefix length for a manually configured IPv6 address on the ASM Port 2. |
Eth2ipv4Gateway | No | Yes | string | none | 16 - Max Length | Specifies the default gateway for a manually configured IPv4 address on the ASM Port 2, when DHCP is not enabled. |
Eth2ipv6Gateway | No | Yes | string | none | 45 - Max Length | Specifies the default gateway for a manually configured IPv6 address on the ASM Port 2. |
ProxyEnabled | No | Yes | Enum | 0 | Possible values:
| Enables Proxy for network configuration. |
ProxyAddress | No | Yes | string | none | 45 - Max Length | Specifies a proxy address. |
ProxyPort | No | No | int | 1 | Specifies a proxy port. |
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. | Enum | Possible values:
|
rt_AsmReachable | Displays true/false if the ASM module is reachable through the SBC's management communication. | Enum | Possible values:
|
rt_MediationSvcState | Displays the current status of the Mediation Service on the ASM. | Enum | Possible values:
|
rt_RegistrarSvcState | Displays the current status of the Registrar Service on the ASM. | Enum | Possible values:
|
rt_SQLSvcState | Displays the current status of the SQL Service on the ASM. | Enum | Possible values:
|
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. | Enum | Possible values:
|
rt_UpTime | Displays the amount of time the ASM has been running. This value may differ from the SBC's system up time. | long | |
rt_UXComVersion | Displays the version of the SBC Edge Portfolio 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 SBC Edge Portfolio 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 SBC Edge Portfolio 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. | Enum | Possible values:
|
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. | Enum | Possible values:
|
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. | Enum | Possible values:
|
rt_PendingRestartNeeded | Displays the need of a reboot for Windows Update. | Enum | Possible values:
|
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_AsmSupportMode | Displays the current support mode of the ASM. | Enum | Possible values:
|
rt_GpoDetected | Display the number of GPO currently applied on the ASM | int | |
rt_QoEReportPending | Displays the number of QoE reports pending to be stored | int | |
rt_AsmLicensedFeature | Displays the features licensed on the ASM using a binary word. The first bit reprensent the SBA license, the second bit represent the RBA license and the third bit represent the QOE license. | int | |
rt_AsmNewestRollUp | Displays the newest Ribbon Communications roll-up applied on the ASM. | string | |
rt_VMMSSvcState | Displays the current status of the Hyper-V Service on the ASM. | Enum | Possible values:
|
rt_CCEVersion | Displays the version of the CCE running on the ASM. | string | |
rt_CCEVersionInstalled | Displays the version of the CCE installed on the ASM. | string | |
rt_CCEAutoMaintenance | Displays the state of the CCE Maintenance Mode. | Enum | Possible values:
|
rt_TlsVersion | Displays the current TLS version enabled | Enum | Possible values:
|
rt_Eth2DHCPEnabled | Displays the Dynamic Host Configuration Protocol (DHCP) for network configuration setting ASM port 2. | Enum | Possible values:
|
rt_Eth2IPAddress | Displays the ASM Port 2 IP address. | string | |
rt_TeamsSvcState | Displays the current status of the Teams Service on the ASM. | Enum | Possible values:
|
rt_TeamsVersion | Displays the version of the Teams Service running on the ASM | string | |
rt_TeamsCpuTime | Displays the number of seconds of CPU runtime that the Teams Service on the ASM has used | long | |
rt_TeamsMemUsage | Displays the number of bytes of memory consumed by the Teams Service on the ASM | long | |
rt_TeamsStatus | Displays the status of the Teams Service running on the ASM. | string | |
rt_TeamsClientConnected | Display the number of Teams client on the SBA | int | |
rt_Chassis_Hardware_ID2 | Indicates the secondary SWe Edge ID. This applies only to SWe Edge. | string | |
rt_License_version_present | Indicates which license version is active. This applies only to SWe Edge. | string | |
rt_Chassis_Version | Indicates the SBC1000 chassis version.
This is applicable only for SBC 1000. |
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. | Enum | Possible values:
|
rt_ReadyLED | Indication of the state of the chassis READY LED - On or Off. | Enum | Possible values:
|
rt_ASM_OsVersion | Indicates the Windows version running on the ASM. | string | |
rt_ASM_NumberEthernetPort | Indicates the number of Ethernet ports activated on the ASM. | string | |
rt_ASM_ImageOriginalCommsVersion | Indicates the SbcComms version that was included on the current ASM Image. | string | |
rt_ASM_WindowsEthernetMainMac | Indicates the MAC Address of the ASM port 1. | string | |
rt_ASM_WindowsEthernetSecMac | Indicates the MAC Address of the ASM port 2. | string |
Parameter Name | Description | Data Type | Possible Values |
---|---|---|---|
Location | The hardware module's location within the SBC. | Enum | Possible values:
|
CardType | The type of hardware module. | Enum | Possible values:
|
Vendor | The vendor who provided the hardware module. | string | |
PartNumber | The hardware module's part number. | string | |
VersionNumber | The hardware module's version number. | string | |
MfgWeek | The week that the hardware module was manufactured, as a two-digit string between 01 and 52. | string | |
MfgYear | The year that the hardware module was manufactured, as a two-digit string (e.g.: 2013 is returned as "13") | string | |
SerialNumber | The hardware module's serial number. | string | |
LineCardLicenseType | The type of line card license - Non-Licensed card will not require TDM port licenses, Licensed card will require TDM port licenses for additional ports to be activated. This is applicable only for the SBC 1000/2000 platforms. | Enum | Possible values:
|
LineCardNumLicensedPorts | The number of ports licensed for the TDM line card type. This is dependent on LineCardLicenseType. If the card is Licensed, the number of ports is equal to number of licenses, otherwise it is the maximum for that card type. This is applicable only for the SBC 1000/2000 platforms. | int | |
AsmOsLicenseType | The version of ASM Operating System that is licensed by the factory. Additional license can be purchased, activated and reviewed through Ribbon licensing and license resource. This is applicable only for the SBC 1000/2000 platforms. | Enum | Possible values:
|
Status | Indicates the hardware initialization state for this card. | Enum | Possible values:
|
TotalSystemMemory | Indicates the amount of RAM available in the system in MB. | string |