Description

The editPTP operation handles configuration related to PTP model. 
This API call is not allowed on the standby unit in an HA pair.

This feature is supported only on hyperlite platform - Cisco ISA-3000-4C-X Threat Defense, Cisco ISA-3000-2C2F-X Threat Defense, Cisco 1783-SAD4T0S-X Threat Defense, Cisco 1783-SAD2T2S-X Threat Defense

HTTP request

PUT /api/fdm/v6/devicesettings/default/ptp/{objId}

Data Parameters

Parameter Required Type Description
version False string Current version of the object
name False string PTP
domainNumber False integer An integer that specifies the domain number that is configured on the PTP devices in your network, from 0-255. Packets received on a different domain are treated like regular multicast packets and will not undergo any PTP processing
Field level constraints: must be between 0 and 255 (inclusive). (Note: Additional constraints might exist)
clockMode False string Currently 2 modes supported 1. End-to-End Transparent mode and 2. Forward on all PTP-enabled interfaces
interfaces False [object] The list of all physical interfaces through which the system can connect to the PTP clock in your network. PTP is enabled on these interfaces only by using interface hardware name
Allowed types are: [PhysicalInterface]
id False string Unique ID of the object
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string PTP

Path Parameters

Parameter Required Type Description
objId True string

Example

curl -X PUT \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "clockMode": "ENDTOENDTRANSPARENT",
        "domainNumber": 0,
        "id": "string",
        "interfaces": [],
        "name": "string",
        "type": "ptp",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devicesettings/default/ptp/{objId}"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def edit_ptp(client, obj_id, body):
    return client.PTP.editPTP(
        objId=obj_id,
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    obj_id = "string"
    body = {'clockMode': 'ENDTOENDTRANSPARENT',
 'domainNumber': 0,
 'id': 'string',
 'interfaces': [],
 'name': 'string',
 'type': 'ptp',
 'version': 'string'}

    edit_ptp(client, obj_id, body)