Powered by Redocly

/config/net/ptp/interface/{if}

The configuration to use for the named interface.

Get /config/net/ptp/interface/{if}

SecurityApiKey
Request
path Parameters
if
required
string

The name of a network interface to use for PTP.

Example: eth0
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/net/ptp/interface/{if}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/net/ptp/interface/{if}
SecurityApiKey 
Request 
path Parameters
if
required
string
The name of a network interface to use for PTP.


 
 Example:  eth0
Request Body schema: application/json
transport
string (configNetPtpInterfaceIfTransport) 
The network transport to use for the interface. Possible values are:


    

  • UDPv4: UDP over IPv4.
    • 

  • UDPv6: UDP over IPv6.
    • 

  • L2: Layer-2 transport (e.g., Ethernet).
    • 



 Enum: "L2" "UDPv4" "UDPv6"  
udp_ttl
integer (configNetPtpInterfaceIfUdpTtl)   [ 1 .. 255 ] 
The Time-to-live (TTL) value for IPv4 multicast messages and the
hop limit for IPv6 multicast messages.  This value is ignored
unless transport is either UDPv4 or UDPv6.  The default
is 1, which restricts the messages to the same subnet.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/net/ptp/interface/{if}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/net/ptp/interface/{if}
SecurityApiKey 
Request 
path Parameters
if
required
string
The name of a network interface to use for PTP.


 
 Example:  eth0
Request Body schema: application/json
transport
string (configNetPtpInterfaceIfTransport) 
The network transport to use for the interface. Possible values are:


    

  • UDPv4: UDP over IPv4.
    • 

  • UDPv6: UDP over IPv6.
    • 

  • L2: Layer-2 transport (e.g., Ethernet).
    • 



 Enum: "L2" "UDPv4" "UDPv6"  
udp_ttl
integer (configNetPtpInterfaceIfUdpTtl)   [ 1 .. 255 ] 
The Time-to-live (TTL) value for IPv4 multicast messages and the
hop limit for IPv6 multicast messages.  This value is ignored
unless transport is either UDPv4 or UDPv6.  The default
is 1, which restricts the messages to the same subnet.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/net/ptp/interface/{if}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/net/ptp/interface/{if}
Remove this interface.


SecurityApiKey 
Request 
path Parameters
if
required
string
The name of a network interface to use for PTP.


 
 Example:  eth0
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/net/ptp/interface/{if}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/net/ptp/interface/{if}/transport