The System Class
The System Class
The System class is a singleton, meaning there is only one instance of it. It provides general status information about anynode through several properties, all of which are read-only. The Manufacturer property is the key qualifier. Additionally, the System class includes a method for resetting the statistics.
System Class Properties
The table below lists the properties of the System class in alphabetical order. All properties are read-only.
Some WMI queries are only available starting from anynode version 4.14.(Check out available WMI queries with the PowerShell command below).
To display all available contents of the System class locally without credentials, you can use the following command:
Get-WmiObject -Namespace "root\TESYSTEMS\anynode" -Class "System"
-Namespace "root\TESYSTEMS\anynode" : Specifies the WMI namespace
for anynode.
-Class "System" : Selects the "System" class to retrieve its contents.
Property: AnynodeFrontendVersion
Type: String
Description: The version of the anynode frontend as a text string in the format: <major
version>.<minor version>.<build number>.
Property: AnynodeMonitorVersion
Type: String
Description: The version of the anynode monitor as a text string in the format: <major
version>.<minor version>.<build number>.
Property: AnynodeOpenSslVersion
Type: String
Description: The version of OpenSSL used by anynode as a text string in the format: <major
version>.<minor version>.<build number>.
Property: AnynodeRunning
Type: Boolean
Description: The state of the anynode service. If true, the anynode service is running. If false, all other values may contain the state of the last running period or default values.
Property: AnynodeSystemIdentifier
Type: String
Description: The system identifier of anynode.
Property: AnynodeSystemName
Type: String
Description: The symbolic name assigned by the anynode frontend.
Property: AnynodeUpTime
Type: uint32
Description: The time in milliseconds since the UTC start time of the anynode service.
Property: AnynodeVersion
Type: String
Description: The version of the anynode service as a text string in the format: <major
version>.<minor version>.<build number>.
Property: CertificateState
Type: uint32
Description: The overall state of all certificates. Valid values:
-
No certificate installed
-
Certificates not yet valid
-
All certificates valid
-
At least one certificate expires within the configured warning time
-
At least one certificate expires within the configured critical warning time
-
At least one certificate is expired
-
All certificates are expired
Property: Description
Type: String
Description: A description of the anynode product. Currently set to: 'anynode The software SBC'.
Property: LicenseState
Type: uint32
Description: The overall state of all installed licenses. Valid values:
-
No license installed
-
The demo license is used (future use)
-
All licenses are valid and will not expire
-
At least one license is time-limited
-
At least one license expires within the configured warning time
-
At least one license expires within the configured critical warning time
-
At least one license is expired All licenses are expired (no calls possible)
Property: MaintenanceModeActive
Type: Boolean
Description: Indicates if the maintenance mode is active.
Property: Manufacturer
Type: String
Description: The manufacturer 'TE-SYSTEMS GmbH'.
Property: MediaRecordingActive
Type: Boolean
Description: Indicates if recording is configured for anynode.
Property: NetworkOk
Type: Boolean
Description: The overall network interface state. Returns true if all network interfaces are working, otherwise false.
Property: NodeCount
Type: uint32
Description: The amount of configured nodes.
Property: OperatingSystem
Type: String
Description: The operating system where the anynode service is running (e.g., ‘Microsoft Windows Server 2008 R2’).
Property: OperatingSystemVersion
Type: String
Description: The operating system version of the system running the anynode service (e.g., ‘6.1.7601 Service Pack 1’).
Property: RegistrationOk
Type: Boolean
Description: Indicates if all registrations are successfully registered. Returns true if successful.
Property: RouteCount
Type: uint32
Description: The amount of configured routes.
Property: StatisticUpTime
Type: uint32
Description: The time in milliseconds since the last reset of the statistics.
Property: SystemCpuUsage
Type: uint32
Description: The CPU usage of the system.
Property: SystemDiskUsage
Type: uint32
Description: The disk usage of the system.
Property: SystemRamUsage
Type: uint32
Description: The RAM usage of the system.
Property: TotalActiveSessions
Type: uint32
Description: The amount of currently active sessions.
Property: TotalCancelledSessions
Type: uint32
Description: The amount of cancelled sessions. Cancelled sessions occur when an incoming call is disconnected before the outgoing call connects.
Property: TotalFailedSessions
Type: uint32
Description: The amount of failed sessions for any reasons.
Property: TotalFailedSessionsBusy
Type: uint32
Description: The amount of sessions that failed because the called party was busy.
Property: TotalFailedSessionsMedia
Type: uint32
Description: The amount of sessions that failed because of a media failure.
Property: TotalFailedSessionsNoAnswer
Type: uint32
Description: The amount of sessions that failed because the called party did not answer.
Property: TotalFailedSessionsNoLicense
Type: uint32
Description: The amount of sessions that could not be served because of a ‘No More License’ condition.
Property: TotalFailedSessionsNoRoute
Type: uint32
Description: The amount of sessions that failed because no route could be assigned to the incoming call information.
Property: TotalLicensedG722Decoder
Type: uint32
Description: The amount of G.722 decoders granted by all licenses.
Property: TotalLicensedG722Encoder
Type: uint32
Description: The amount of G.722 encoders granted by all licenses.
Property: TotalLicensedG729Decoder
Type: uint32
Description: The amount of G.729 decoders granted by all licenses.
Property: TotalLicensedG729Encoder
Type: uint32
Description: The amount of G.729 encoders granted by all licenses.
Property: TotalLicensedOpusDecoder
Type: uint32
Description: The amount of OPUS decoders granted by all licenses.
Property: TotalLicensedOpusEncoder
Type: uint32
Description: The amount of OPUS encoders granted by all licenses.
Property: TotalLicensedRecording
Type: uint32
Description: The amount of recording sessions granted by all licenses.
Property: TotalLicensedSessions
Type: uint32
Description: The amount of sessions granted by all licenses.
Property: TotalLicensedWebrtcClient
Type: uint32
Description: The amount of WebRTC clients granted by all licenses.
Property: TotalSuccessfulSessions
Type: uint32
Description: The amount of successful sessions.
Property: TotalUsedG722Decoder
Type: uint32
Description: The amount of currently used G.722 decoders.
Property: TotalUsedG722Encoder
Type: uint32
Description: The amount of currently used G.722 encoders.
Property: TotalUsedG729Decoder
Type: uint32
Description: The amount of currently used G.729 decoders.
Property: TotalUsedG729Encoder
Type: uint32
Description: The amount of currently used G.729 encoders.
Property: TotalUsedOpusDecoder
Type: uint32
Description: The amount of currently used Opus decoders.
Property: TotalUsedOpusEncoder
Type: uint32
Description: The amount of currently used Opus encoders.
Property: TotalUsedRecording
Type: uint32
Description: The amount of currently used recording sessions.
Property: TotalUsedSessions
Type: uint32
Description: The amount of currently used sessions.
Property: TotalUsedWebrtcClient
Type: uint32
Description: The amount of currently used WebRTC clients.
Property: TraceModeActive
Type: Boolean
Description: Indicates if trace mode is enabled for anynode.
System Class Methods
The system class provides the method to reset the statistics. Note that this implicitly resets the specific statistics in the classes ‘Node’ and ‘Route’.
Method:StatisticReset
Parameter:None
Return type:Unsigned integer (VT_I4)
Return values:0 on success 1 on failure.