upsertPTP

The upsertPTP operation handles configuration related to PTP model. 

Description

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

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

Query Parameters

Parameter Required Type Description
filter False string The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertPTP' operation
  ftd_configuration:
    operation: "upsertPTP"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        domainNumber: "{{ domain_number }}"
        clockMode: "{{ clock_mode }}"
        interfaces: "{{ interfaces }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"