Monitoring

The Node Class

The Node class provides configuration information of a node as well as status information and statistics via several properties. All properties are read only. For each configured node, one class instance exists. The property ‘Name’ has the key qualifier and uniquely identifies a node instance.

Node Class Properties

The table below lists the properties of the ‘Node’ class in alphabetical order. All properties are read only.

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 "Node" : Selects the "Node" class to retrieve its contents.

Property: ActiveCalls

Type: uint32

Description: The property provides the currently active incoming and outgoing call on the node.

Property: ActiveIncomingCalls

Type: uint32

Description: The property provides the currently active incoming call on the node.

Property: ActiveOutgoingCalls

Type: uint32

Description: The property provides the currently active outgoing call on the node.

Property: CancelledIncomingCalls

Type: uint32

Description: The property provides the amount of cancelled incoming calls. Cancelled calls occur when the incoming call is disconnected before the outgoing call reaches the connected state. The value includes all calls since the last reset of the statistics.

Property: Enabled

Type: boolean

Description: The property provides the state of the node. If true the node is active and can service calls. A node can be enabled or disabled in the anynode configuration.

Property: FailedCalls

Type: uint32

Description: The property provides the amount of failed calls for any reasons. This counter includes all specific failures listed below. The value includes all calls since the last reset of the statistics.

Property: FailedIncomingCalls

Type: uint32

Description: The property provides the amount of failed incoming calls for any reasons. This counter includes all specific incoming call failures listed below. The value includes all calls since the last reset of the statistics.

Property: FailedIncomingCallsMedia

Type: uint32

Description: The property provides the amount of incoming calls that failed because of a media error. The value includes all calls since the last reset of the statistics.

Property: FailedIncomingCallsNoLicense

Type: uint32

Description: The property provides the amount of incoming calls that failed because no more licenses are available. The value includes all calls since the last reset of the statistics.

Property: FailedIncomingCallsNoRoute

Type: uint32

Description: The property provides the amount of incoming calls that failed because no route matches the properties of the call. The value includes all calls since the last reset of the statistics.

Property: FailedOutgoingCalls

Type: uint32

Description: The property provides the amount of failed outgoing calls for any reasons. This counter includes all specific outgoing failures listed below. The value includes all calls since the last reset of the statistics.

Property: FailedOutgoingCallsBusy

Type: uint32

Description: The property provides the amount of outgoing calls that failed because the called party was busy. The value includes all calls since the last reset of the statistics.

Property: FailedOutgoingCallsMedia

Type: uint32

Description: The property provides the amount of outgoing calls that failed because of a media error. The value includes all calls since the last reset of the statistics.

Property: FailedOutgoingCallsNoAnswer

Type: uint32

Description: The property provides the amount of outgoing calls that failed because the called party did not answer the call. The value includes all calls since the last reset of the statistics.

Property: IPAddress

Type: string

Description: The property provides the IP address used by this node. The IP address is provided as a string, and the format depends on the property IpAddressType.

Property: IPAddressType

Type: uint32

Description: The property provides the IP address type. Valid values are:

• 0: The IP address type is unknown

• 1: The IP address is a V4 address

• 2: The IP address is a V6 address

• 16: The IP address is a DNS type

Property: Name

Type: String

Description: The property provides the name of the node. The name is unique, has the key attribute, and identifies a node instance.

Property: NatTraversalEnabled

Type: boolean

Description: The property is true if NAT traversal is enabled.

Property: NetworkInterface

Type: string

Description: The property provides the symbolic name of the network interface used by the node.

Property: NetworkUp

Type: boolean

Description: The property is true if the network interface state is ‘Up’, otherwise false.

Property: Operational

Type: Boolean

Description: The property is true if the node is operational. For node type UCMA, the property is false as long as the application is starting.

Property: RegistrationState

Type: uint32

Description: The property provides the state of the registration used by this node. Valid values are:

• Not used: The node does not use registration

• Registering: Trying to register

• Registered: Successfully registered

• Unregistering: Shutting down registration

• Unregistered: Error registering

Property: RegistrationDomain

Type: string

Description: The property provides the name of the SIP registrar domain if SIP registration is used.

Property: SipSrvEnabled

Type: boolean

Description: The property is true if the service resource records are enabled.

Property: SipTcpEnabled

Type: boolean

Description: The property is true if TCP is enabled as transport protocol for SIP.

Property: SipTcpPort

Type: uint32

Description: The property provides the port number used for SIP over TCP.

Property: SipTlsEnabled

Type: boolean

Description: The property is true if TLS is enabled as transport protocol for SIP.

Property: SipTlsPort

Type: uint32

Description: The property provides the port number used for SIP/TLS over TCP.

Property: SipUdpEnabled

Type: boolean

Description: The property is true if UDP is enabled as transport protocol for SIP.

Property: SipUdpPort

Type: uint32

Description: The property provides the port number used for SIP over UDP.

Property: SuccessfulCalls

Type: uint32

Description: The property provides the amount of successful incoming and outgoing calls. The value includes all sessions since the last reset of the statistics.

Property: SuccessfulIncomingCalls

Type: uint32

Description: The property provides the amount of successful incoming calls. The value includes all sessions since the last reset of the statistics.

Property: SuccessfulOutgoingCalls

Type: uint32

Description: The property provides the amount of successful outgoing calls. The value includes all sessions since the last reset of the statistics.

Property: Type

Type: uint32

Description: The property provides the type of the node. Valid values are:

• SIP

• UCMA

• CAPI