Representation of an SVC Relay MCU device. Content-Type: application/vnd.plcm.plcm-svc-mcu+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| mcuAlerts | PlcmAlertList | ||
| mcuSystemConfig | PlcmSvcMcuSystemConfig | ||
| plcmMcuServicingStatus | PlcmMcuServicingStatus | See Definition of PlcmMcuServicingStatus | |
| plcmMcuConnectionStatusList | Array of PlcmMcuConnectionStatus | See Definition of PlcmMcuConnectionStatus | |
| plcmServiceClassV2 | PlcmServiceClassV2 | See Definition of PlcmServiceClassV2 | |
| mcuIdentifier | string | Unique identifier of the MCU. | |
| name | string | Name of the MCU. | Mandatory |
| localRunning | boolean | True if the MCU is running on the same local server, false/missing if it is a remote MCU. Read-Only. | |
| managementHost | string | Command/management IP or FQDN of the MCU. Required for a POST operation. | Mandatory |
| managementPort | unsignedShort | Command/management port of the MCU. 8443 is the only acceptable value. | |
| managementUsername | string | Username used to login to the MCU. Required for a POST operation. | |
| managementPassword | ManagementPassword | Password used to login to the MCU. Required for a POST operation. | |
| model | string | MCU model name. Read-Only. | |
| version | string | MCU version. Read-Only. | |
| site | string | Site associated with MCU. Read-Only. | |
| territory | string | Territory associated with MCU. Read-Only. | |
| overrideDefaultServiceClass | boolean | When true, plcm-service-class-v2 must be specified in the request. When false, plcm-service-class-v2 value will be determined by the system default. | |
| activeConfsCount | unsignedShort | The number of running conferences on this MCU. Note that these are conferences that were created by this DMA supercluster; conferences created by DMAs unknown to this supercluster are not included in this count. Read-Only. | |
| totalPorts | unsignedShort | The total number of ports on the MCU. Read-Only. | |
| usedPorts | unsignedShort | The number of ports used on the MCU. Read-Only. | |
| reservedPortsPerMcu | unsignedShort | The number of reserved ports on the MCU (for cascading, etc.). | |
| reservedPortsPerConf | unsignedShort | The number of reserved ports per conf (for cascading, etc.). | |
| maxPercentToStart | MaxPercentToStart | The percent utilization of the MCU after which new conferences will be, if possible, directed to other MCUs. | |
| disconnectsLast24Hours | DisconnectsLast24Hours | Number of MCU disconnects in past 24 hours. Read-Only. | |
| failureRate | FailureRate | MCU call failure rate. Read-Only. | |
| systemConfigAction | SystemConfigAction | Defines the action to be taken with the provided mcu-system-config during a PUT operation. This field is required if mcu-system-config is specified. If SAVE is selected, modified fields are saved in DMA only; for any field that needs to be applied on the SVC MCU (i.e., fields in mcu-system-config), those changes will be sent when DMA reconnects to the MCU. If SAVE_AND_APPLY is selected, DMA sends the system config to SVC MCU to be applied. If the changes can be applied without rebooting the SVC MCU (a 204 response), no further action is required. If DMA responds to the PUT request indicating that a reboot is required (a 202 response), the API client needs to resend the exact same PUT request with the system-config-action field set to REBOOT; the SVC MCU will not apply any changes until it receives a REBOOT request. If there is no mcu-system-config specified, any value provided for this field will be interpreted as SAVE as there is no need to apply any changes to the SVC MCU. | |
| systemConfigSynced | boolean | Is the current system config in sync with the MCU. Read-Only. | |
| mcuPools | McuPools | List of MCU pool name with which MCU is associated. Read-Only. | |
| mcuAlertsCount | unsignedShort | Number of alerts on this mcu. Read-Only. | |
| packetCaptureRunning | boolean | True if packet capture currently running. False otherwise. Read-Only. | |
| packetCaptureErrorCount | unsignedShort | Number of packet capture error on this mcu. Read-Only. | |
| entityTag | EntityTag | 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. |
| Name | Type | Description | Attributes |
|---|---|---|---|
| mcuPool | Array of string | MCU pool name with which MCU is associated. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| SystemConfigAction | string | Value must be one of:
|
| FailureRate | decimal | |
| DisconnectsLast24Hours | decimal | |
| MaxPercentToStart | decimal | |
| ManagementPassword | string | Length of value must be >=1 Length of value must be <=128 |