Troubleshooting Utilities



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/conntest/client

Summary


Resources Methods
https://localhost:8443/api/rest/conntest/client

DELETE  Stop any connection testing currently running.

POST  Starts a client testing session if one is not already running.

GET  Gets the last completed connection test report list if available (previous test has completed running and results waiting".

https://localhost:8443/api/rest/conntest/server

POST .

https://localhost:8443/api/rest/conntest/server/{session-id}

DELETE  End a specific server test session, if one exists.

https://localhost:8443/api/rest/troubleshooting-utilities

https://localhost:8443/api/rest/troubleshooting-utilities/ping/{ip-address}

GET  ping|arping to verify that the Polycom RealPresence DMA system’s servers can communicate with another device in the network.

https://localhost:8443/api/rest/troubleshooting-utilities/top

GET  Shows overview of each server’s current status, including CPU and memory usage, number of tasks, and list of running processes.

https://localhost:8443/api/rest/troubleshooting-utilities/traceroute/{ip-address}

GET  Use Traceroute to see the route that the servers use to reach the address you specify and the latency (round trip) for each hop.

https://localhost:8443/api/rest/troubleshooting-utilities/dto-consistency-check

POST  Start a dto consistency check.

https://localhost:8443/api/rest/troubleshooting-utilities/ntp-status

GET  It gives NTP status of the server.

https://localhost:8443/api/rest/troubleshooting-utilities/io-stats

GET  I/O Stats to see CPU resource allocation and read/write statistics for each server.

https://localhost:8443/api/rest/troubleshooting-utilities/sar

GET  SAR to see a complete system activity report (from the preceding midnight to the current time) for each server.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture

DELETE .

GET  Get information of the last successful network packet capture.

GET  Provide network packet captured data to download as GZIP file containing pcap and pcap-filter text files.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture/start

POST  Start a network packet capture.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture/stop

POST  Stop the network packet capture.

https://localhost:8443/api/rest/troubleshooting-utilities/reset-to-defaults

POST  Resets the DMA back to its factory defaults configuration.

Resources


https://localhost:8443/api/rest/conntest/client


Methods

DELETE


Stop any connection testing currently running.
[tags: DMA]

Request

Response

Status Representation Description
202
Any tests that may be running will be shutdown ASAP.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

POST


Starts a client testing session if one is not already running.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conntest-client-request-list+xml
application/vnd.plcm.plcm-conntest-client-request-list+json

Response

Status Representation Description
202
Test configuration has been accepted and the test will start. Get the reports for the results.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A test is already running and a new one cannot be started until that one is complete.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Test parameters are invalid.

GET


Gets the last completed connection test report list if available (previous test has completed running
and results waiting".
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-conntest-client-report-list+xml
application/vnd.plcm.plcm-conntest-client-report-list+json
Return the report list results of the last run connection test.
204 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A connection test is currently running but has not generated results yet.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No connection test data avalible, re-run tests to generate.

https://localhost:8443/api/rest/conntest/server


Methods

POST

Request

Representations

application/vnd.plcm.plcm-conntest-server-request+xml
application/vnd.plcm.plcm-conntest-server-request+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-conntest-server-response+xml
application/vnd.plcm.plcm-conntest-server-response+json
Server test session created for some period of time.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Test session request parameters are not vaild.
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Test session could not be created at this time.

https://localhost:8443/api/rest/conntest/server/{session-id}


Template Parameters

Name Type Description
session-id xs:string server session ID

Methods

DELETE


End a specific server test session, if one exists.

Request

Response

Status Representation Description
202 The only response is this, even if no matching session exists

https://localhost:8443/api/rest/troubleshooting-utilities


https://localhost:8443/api/rest/troubleshooting-utilities/ping/{ip-address}


Template Parameters

Name Type Description
ip-address xs:string IP address for ping.

Methods

GET


ping|arping to verify that the Polycom RealPresence DMA system’s servers can communicate with another device in the network.
In addition to the command output, the arping command returns an exit code: 0 indicates that no other device responded to
the IP address inquiry while "> 0" indicates that a device did respond to the IP address inquiry.
[tags: DMA]

Request

Query Parameters

Name Type Description
device-name xs:string Interface device name to be used for the ping|arping.
ping-type xs:string ping(default)|arping.

Response

Status Representation Description
200 application/vnd.plcm.plcm-troubleshooting-utilities+xml
application/vnd.plcm.plcm-troubleshooting-utilities+json
return the response output of ping command.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid hostname or IP address.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/top


Methods

GET


Shows overview of each server’s current status, including CPU and memory usage, number of tasks,
and list of running processes.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-troubleshooting-utilities+xml
application/vnd.plcm.plcm-troubleshooting-utilities+json
return the response output of top command.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/traceroute/{ip-address}


Template Parameters

Name Type Description
ip-address xs:string IP address for traceroute.

Methods

GET


Use Traceroute to see the route that the servers use to reach the address you specify and the latency
(round trip) for each hop.
[tags: DMA]

Request

Response

Status Representation Description
202 The request has been accepted for output of traceroute command.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid hostname or IP address.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/dto-consistency-check


Methods

POST


Start a dto consistency check.
[tags: DMA]

Response

Status Representation Description
202 The consistency check had started.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A manual consistency check is already running.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/ntp-status


Methods

GET


It gives NTP status of the server.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-troubleshooting-utilities+xml
application/vnd.plcm.plcm-troubleshooting-utilities+json
return the response output of ntp status .
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid hostname or IP address.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/io-stats


Methods

GET


I/O Stats to see CPU resource allocation and read/write statistics for each server.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-troubleshooting-utilities+xml
application/vnd.plcm.plcm-troubleshooting-utilities+json
return the response output of io stats command.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/sar


Methods

GET


SAR to see a complete system activity report (from the preceding midnight to the current time) for each server.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-troubleshooting-utilities+xml
application/vnd.plcm.plcm-troubleshooting-utilities+json
return the response output of sar command.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture


Methods

DELETE

Request

Representations

application/application/vnd.plcm.plcm-network-packet-capture-request+xml
application/application/vnd.plcm.plcm-network-packet-capture-request+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-network-packet-capture+xml
application/vnd.plcm.plcm-network-packet-capture+json
Successful delete of the packet capture associated with the interface.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to Delete permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to delete the associated network packet capture.

GET


Get information of the last successful network packet capture.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-network-packet-capture+xml
application/vnd.plcm.plcm-network-packet-capture+json
Information of the last successful network packet capture.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Last successful network packet capture does not exist.

GET


Provide network packet captured data to download as GZIP file containing pcap and pcap-filter text files. [tags: DMA]

Request

Response

Status Representation Description
200 application/gzip
Network packet capture file downloaded successfully.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture/start


Methods

POST


Start a network packet capture.
[tags: DMA]

Request

Representations

application/application/vnd.plcm.plcm-network-packet-capture-request+xml
application/application/vnd.plcm.plcm-network-packet-capture-request+json

Response

Status Representation Description
204 The network packet capture was started successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A network packet capture is already running.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Failed to start network packet capture with the filter provided.

https://localhost:8443/api/rest/troubleshooting-utilities/network-packet-capture/stop


Methods

POST


Stop the network packet capture.
[tags: DMA]

Response

Status Representation Description
204 The network packet capture was stopped successfully or already stopped.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/troubleshooting-utilities/reset-to-defaults


Methods

POST


Resets the DMA back to its factory defaults configuration. The system must
not be in a supercluster nor have high availability enabled. The configuration
including the admin password will be reset to its initial installation state.
[tags: DMA]

Response

Status Representation Description
200 The reset request has been accepted and is being processed. The system
will restart after the configuration has been reset for the changes to take effect
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 The system cannot be reset due to either currently being part of a supercluster or
having high availabilty enabled.