PlcmSiteTopologyQosStatistics

PlcmSiteTopologyQosStatistics

Site topology quality of service statistics. This object provides quality of service related statistics for a single site topology entity, either site or a site link. Content-Type: application/vnd.plcm.plcm-site-topology-qos-statistics+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmSiteTopologyQosStatistics Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
siteTopologyIdentifierSiteTopologyIdentifier Unique identifier of the site topology entity the statistics are being reported for. Mandatory
typeType Type of the site topology entity the statistics are for. SITE - A private network composed of subnets SUBNET - A subnet of a private network (site) DIRECT_LINK - A network link between two sites Mandatory
nameName Name of the site topology entity the statistics are being reported for. If the type of the site topology is SUBNET, the name will consist of the network address and subnet mask in CIDR (Classless InterDomain Routing) notation. For example A subnet with a network address of 192.168.0.0 and a subnet mask of 255.255.0.0 would be represented as 192.168.0.0/16
territoryNameTerritoryName Name of the site topology territory the site topology entity belongs to.
superclusterNodeNameSuperclusterNodeName Name of the supercluster node the site topology territory is being managed by.
managedboolean Flag indicating if the site topology entity is managed by the Call Server. If it is not being managed, then current statistics will not be available. Mandatory
currentCallCountint The number of calls currently using this entity.
usedBandwidthTotallong The total amount of bandwidth for all calls currently using this entity. This value is in bits per second (bps).
usedBandwidthPercentageunsignedShort The percentage of used bandwidth for all calls currently using this entity. This field is only valid if the entity has an associated bandwidth limit.
averageBitRatelong The average bit rate being used for all calls currently using this entity.
maximumDelayint The maximum amount of network delay (latency) for all calls currently using this entity. This is the maximum delay across all media streams (audio, and content).
averageDelayint The average amount of network delay (latency) for each call currently using this entity. This is the average delay across all media streams(audio, video, and content).
cumulativePacketLossint The total packet loss for all calls currently using this entity. This is across all media streams (audio, video, and content).
averagePacketLossint The average packet loss for all calls currently using this entity. This is across all media streams (audio, video, and content).
maximumJitterint The maximum amount of jitter for all calls currently using this entity. This is the maximum jitter across all media streams (audio, video, and content).
averageJitterint The average amount of jitter for all calls currently using this entity This is the average jitter across all media streams (audio, video, and content).
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
SuperclusterNodeNamestring
Length of value must be >=1
Length of value must be <=128
TerritoryNamestring
Length of value must be >=1
Length of value must be <=128
Namestring
Length of value must be >=1
Length of value must be <=128
Typestring
Value must be one of:
  • SITE
  • SUBNET
  • DIRECT_LINK
SiteTopologyIdentifierstring
Length of value must be >=1
Length of value must be <=36