Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

PTP Services Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Precision Time Protocol (PTP) Services Management RESTful Web Services.

Get a PTP Service By Service ID

This request is used to retrieve the details of a particular PTP service, based on the service ID.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service+xml

Produces

Collects the details of a specific PTP service.

Output

Sample XML Output

Get All PTP Services

This request is used to retrieve all the configured PTP services.

URI

/api/space/nsas/timing-ptp/service-management/services/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml

Produces

Collects all the configured PTP services.

Output

Sample XML Output

Modify a PTP Service

This request is used to modify a PTP service for addition of parameters.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Modifies a PTP service for addition of parameters.

Input

Sample XML Input

Add Devices to a PTP Service

This request is used to add local devices to a PTP service.

URI

api/space/nsas/timing-ptp/service-management/services/

<serviceId>/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds local devices to PTP services.

Input

Sample XML Input

Delete Devices from a PTP Service

This request is used to delete local devices from a PTP service.

URI

api/space/nsas/timing-ptp/service-management/

services/<serviceId>/delete-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Deletes local devices from PTP services.

Input

Sample XML Input

Delete Devices in Frequency Settings Only from a PTP Service with Hybrid Mode

This request is used to delete local devices only in frequency settings from a PTP service.

URI

api/space/nsas/timing-ptp/service-

management/services/{service-id}/

hybrid-frequency-settings/delete-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Deletes local devices from PTP services.

Input

Sample XML Input

Output

Sample XML Output

Decommission a PTP Service

This request is used to decommission a previously created PTP service.

URI

api/space/timing-ptp/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.service-management.service+xml

Produces

Decommissions a previously created PTP service.

Output

Sample XML Output

Run a Functional Audit of a PTP Service

This request is run a functional audit of a PTP service.

URI

api/space/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.service+xml

The options for AuditNow and AuditLater can be provided in the Action element within the ?OperationSpecificData?.

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Performs a functional audit of a PTP service.

Input

Sample XML Input

Output

Sample XML Output

Run a Configuration Audit of a PTP Service

This request is run a configuration audit of a PTP service.

URI

api/space/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.service+xml

The options for AuditNow and AuditLater can be provided in the Action element within the ?OperationSpecificData?.

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Performs a configuration audit of a PTP service.

Input

Sample XML Input

Output

Sample XML Output

View the Functional Audit Results of a PTP Service

This request is display the functional audit results of a PTP service.

URI

api/space/timing-ptp/service-management/

services/view-functional-audit/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.functional-audit+xml

Produces

Displays the functional audit results of a PTP service.

Output

Sample XML Output

View the Configuration Audit Results of a PTP Service

This request is display the configuration audit results of a PTP service.

URI

api/space/timing-ptp/service-management/

services/view-configuration-audit/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

configuration-audit+xml

Produces

Displays the configuration audit results of a PTP service.

Output

Sample XML Output

View the Service Configuration Change Results of a PTP Service

This request is display the service configuration changes of a PTP service.

URI

api/space/timing-ptp/service-management/

services/view-serviceconfiguration-change/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.config-change+xml

Produces

Displays the service configuration change results of a PTP service.

Output

Sample XML Output

Get a PTP Service with Boundary Clock By Service ID

This request is used to retrieve the details of a particular PTP service, based on the service ID.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service+xml

Produces

Collects the details of a specific PTP service.

Output

Sample XML Output

Modify a PTP Service with Boundary Clock

This request is used to modify a PTP service for addition of parameters.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Modifies a PTP service for addition of parameters.

Input

Sample XML Input

Output

Sample XML Output

Add Devices to a PTP Service with Boundary Clock

This request is used to add local devices to a PTP service.

URI

api/space/nsas/timing-ptp/service-management/

services/<serviceId>/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds local devices to PTP services.

Input

Sample XML Input

Output

Sample XML Output

Delete Devices from a PTP Service with Boundary Clock

This request is used to delete local devices from a PTP service.

URI

api/space/nsas/timing-ptp/service-management/

services/<serviceId>/delete-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Deletes local devices from PTP services.

Input

Sample XML Input

Output

Sample XML Output

Get a PTP Service with Hybrid Mode By Service ID

This request is used to retrieve the details of a particular PTP service, based on the service ID.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service+xml

Produces

Collects the details of a specific PTP service.

Output

Sample XML Output

Modify a PTP Service with Hybrid Mode

This request is used to modify a PTP service for addition of parameters.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Modifies a PTP service for addition of parameters.

Input

Sample XML Input

Output

Sample XML Output

Add Devices to a PTP Service with Hybrid Mode

This request is used to add local devices to a PTP service. This request is used only when adding the Device in Frequency settings along with Master device/Boundary device/Slave device for hybrid mode.

URI

api/space/nsas/timing-ptp/service-management/

services/<serviceId>/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-

management.modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds local devices to PTP services.

Input

Sample XML Input

Output

Sample XML Output

Add Devices in Frequency Settings Only to a PTP Service with Hybrid Mode

This request is used to add local devices in frequency settings only to a PTP service.

URI

api/space/nsas/timing-ptp/service-management/services/

{service-id}/hybrid-frequency-settings/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds local devices to PTP services.

Input

Sample XML Input

Output

Sample XML Output

Get a PTP over Ethernet Service By Service ID

This request is used to retrieve the details of a particular PTPoE service, based on the service ID.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service+xml

Produces

Collects the details of a specific PTPoE service.

Output

Sample XML Output

Modify a PTP over Ethernet Service

This request is used to modify a PTPoE service for addition of parameters.

URI

/api/space/nsas/timing-ptp/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Modifies a PTPoE service for addition of parameters.

Input

Sample XML Input

Output

Sample XML Output