protocol/cfm/y1731

Configures, modifies, or retrieves test-profile and action-profile to facilitate Y.1731 performance monitoring of point-to-point links.

Resource URIs

URI Description
<base_URI>/config/running/protocol/cfm/y1731 Configures, modifies, or retrieves test-profile and action-profile.
GET URIs Description
<base_URI>/config/running/protocol/cfm/y1731 Displays Y.1731 configuration.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} Displays configurable-test-profile information.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/type Displays whether measurements are ETH-SLM or ETH-DM.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/tx-interval Displays transmission interval between 2 successive frames, in seconds.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/measurement-interval Displays time period (in minutes) of the measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/cos Displays Class of Service priority value for the frames.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/tx-frame-count Displays the number of packets to be sent for measurements.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/timeout Displays the time interval within which the reply messages are expected.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start Displays whether measurement session starts at a fixed time, or after a specified time.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start/start-time Displays start time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start/start-periodic Displays start time for daily measurement setting.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/stop Displays whether measurement session stops at a fixed time, or after a specified time.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/stop/stop-time Displays stop time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold Displays configured threshold settings.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward Displays forward direction threshold.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/average Displays average threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/maximum Displays configured maximum threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward Displays backward direction threshold.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/average Displays average threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/maximum Displays configured maximum threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold Displays threshold value.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/average Displays average threshold.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/maximum Displays configured maximum threshold value.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name} Displays action profile configuration.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event Displays actions for a specified event.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-up Displays CCM-up event configuration.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-up/actions Displays actions on CCM-up event.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-down Displays CCM-down event configuration.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-down/actions Displays actions on CCM-down event.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/avg-threshold Displays average threshold event configuration.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/avg-threshold/actions Displays actions on average threshold event.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/max-threshold Displays maximum threshold event configuration.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/max-threshold/actions Displays actions on maximum threshold event.
PUT URIs Payload Description
<base_URI>/config/running/protocol/cfm/y1731 <y1731 /> Configures Y.1731.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/type <type>{y1731-profile-type}</type> Configures measurement type.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/tx-interval <tx-interval>{y1731-profile-tx-interval}</tx-interval> Configures transmission interval between 2 successive frames, in seconds.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/measurement-interval <measurement-interval>{uint32}</measurement-interval> Sets time period (in minutes) of the measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/cos <cos>{uint8}</cos> Configures Class of Service priority value for the frames.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/tx-frame-count <tx-frame-count>{uint32}</tx-frame-count> Sets the number of packets to be sent for measurements.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/timeout <timeout>{uint8}</timeout> Configures the time interval within which the reply messages are expected.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start <start><start-type>{schedule-type}</start-type><start-time>{time-in-hhmmss}</start-time></start> Configures start time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start/start-periodic <start-periodic>{y1731-start-periodic}</start-periodic> Configures daily measurement setting.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/stop <stop><stop-type>{schedule-type}</stop-type><stop-time>{time-in-hhmmss}</stop-time></stop> Configures stop time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/average <average>{uint32}</average> Configures average threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/maximum <maximum>{uint32}</maximum> Configures maximum threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/average <average>{uint32}</average> Configures average threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/maximum <maximum>{uint32}</maximum> Configures maximum threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/average <average>{uint32}</average> Configures average threshold value.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/maximum <maximum>{uint32}</maximum> Configures maximum threshold value.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-up/actions <actions>{action-profile-bitmap}</actions> Configures CCM-up event action.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-down/actions <actions>{action-profile-bitmap}</actions> Configures CCM-down event action.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/avg-threshold/actions <actions>{action-profile-bitmap}</actions> Configures average threshold event actions.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/max-threshold/actions <actions>{action-profile-bitmap}</actions> Configures maximum threshold event actions.
POST URIs Payload Description
<base_URI>/config/running/protocol/cfm <y1731 /> Creates Y.1731 instance.
<base_URI>/config/running/protocol/cfm/y1731 <test-profile><test-profile>{string}</test-profile></test-profile> Configures test profile.
<base_URI>/config/running/protocol/cfm/y1731 <action-profile><action-profile-name>{string}</action-profile-name></action-profile> Configures action profile.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}/remote-mep/{remote-mep} <test-profile><rmep-test-profile>{string}</rmep-test-profile><mode>{y1731-profile-mode}</mode></test-profile> Configures mep-test profile.
PATCH URIs Payload Description
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><type>{y1731-profile-type}</type></test-profile> Configures test profile.
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><tx-interval>{y1731-profile-tx-interval}</tx-interval></test-profile> Configures transmission interval between 2 successive frames, in seconds.
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><measurement-interval>{uint32}</measurement-interval></test-profile> Sets time period (in minutes) of the measurement session.
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><cos>{uint8}</cos></test-profile> Configures Class of Service priority value for the frames.
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><tx-frame-count>{uint32}</tx-frame-count></test-profile> Sets the number of packets to be sent for measurements.
base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile} <test-profile><timeout>{uint8}</timeout></test-profile> Configures the time interval within which the reply messages are expected.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start <start><start-type>{schedule-type}</start-type><start-time>{time-in-hhmmss}</start-time></start> Configures start time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start <start><start-periodic>{y1731-start-periodic}</start-periodic></start> Configures daily measurement setting.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/stop <stop><stop-type>{schedule-type}</stop-type><stop-time>{time-in-hhmmss}</stop-time></stop> Configures stop time of measurement session.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward <forward><average>{uint32}</average></forward> Configures average threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward <forward><maximum>{uint32}</maximum></forward> Configures maximum threshold value in the forward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward <backward><average>{uint32}</average></backward> Configures average threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward <backward><maximum>{uint32}</maximum></backward> Configures maximum threshold value in the backward direction.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold <threshold><average>{uint32}</average></threshold> Configures average threshold value.
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold <threshold><maximum>{uint32}</maximum></threshold> Configures maximum threshold value.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-up <ccm-up><actions>{action-profile-bitmap}</actions></ccm-up> Configures CCM-up event action.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/ccm-down <ccm-down><actions>{action-profile-bitmap}</actions></ccm-down> Configures CCM-down event action.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/avg-threshold <avg-threshold><actions>{action-profile-bitmap}</actions></avg-threshold> Configures average threshold event actions.
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}/event/max-threshold <max-threshold><actions>{action-profile-bitmap}</actions></max-threshold> Configures maximum threshold event actions.
DELETE URIs
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/measurement-interval
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/cos
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/tx-frame-count
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/timeout
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/start
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/stop
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/average
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/forward/maximum
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/average
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/backward/maximum
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/average
<base_URI>/config/running/protocol/cfm/y1731/test-profile/{test-profile}/threshold/maximum
<base_URI>/config/running/protocol/cfm/y1731/action-profile/{action-profile-name}

Parameters

test-profile
Name of test profile which contains configured parameters. Name is case sensitive and is 32 characters long.
type
Specifies if the type of measurement to be done is ETH-SLM or ETH-DM.
tx-interval
Transmission interval between two successive frames. Allowed values: to 1sec, 10sec, 60sec or 600sec. The default is 1sec.
measurement-interval
The interval in minutes in which the measurement is performed. Range 1 - 1440 mins. The default is 15 minutes.
cos
The Class of Service priority value. Range 0 - 8 for the frames. The default is 7. The value 8 signifies random CoS value to be used for measurement between 0 and 7.
tx-frame-count
The number of packets to be sent in a burst once for on-demand measurement, and for every Tx-interval for scheduled (or periodic) two-way ETH-SLM measurements. For an on-demand Two-way ETH-DM, it specifies the total number of packets sent sequentially after every reply message received. The default is 10. The default is 1 second.
timeout
The time interval within which the reply messages are expected for entire burst of frames sent for on-demand ETH-SLM, and for every frame sent for on-demand ETH-DM.
start-type
Specifies whether to start the session either at a fixed specified time or after a specified time
start-time
Specifies whether to start the session either at a fixed specified time or after a specified time
start-periodic
stop-type
specifies stop the session either at a fixed specified time or after a specified time in hh:mm:ss format.
average
The average-threshold value in the applied profile; when this is exceeded, actions as configured in the action profile occur.
maximum
actions
The profile name used for creating an action profile. The action profile bitmap attribute is case sensitive.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

9036681-01 Rev AA