vOLT_OPL_API_endpoints
POST
IBN-CreateIntentOnt
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-service-profile": "{{DEFAULT_ONT_SERVICE_PROFILE}}",
"uni-service-configuration": [{
"uni-id": "LANx",
"service-profile": "{{100M_UNI_PROFILE}}"
}],
"pon-type": "gpon",
"ont-type": "G-010G-Q",
"expected-serial-number": "{{ONT_SN_NOKIA}}",
"fiber-name": "{{FIBER_INTENT}}",
"auto": ""
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
{
"ibn:intent": {
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-service-profile": "{{DEFAULT_ONT_SERVICE_PROFILE}}",
"uni-service-configuration": [{
"uni-id": "LANx",
"service-profile": "{{100M_UNI_PROFILE}}"
}],
"pon-type": "gpon",
"ont-type": "G-010G-Q",
"expected-serial-number": "{{ONT_SN_NOKIA}}",
"fiber-name": "{{FIBER_INTENT}}",
"auto": ""
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
POST
IBN-OntIntentSync
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont/synchronize
PATCH
IntentNetworkStateDelete
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-type-version": "x",
"required-network-state": "delete"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-type-version": "x",
"required-network-state": "delete"
}
}
POST
IntentSync
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont/synchronize
DELETE
IntentDelete
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
Example Request
DELETE {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
POST
IBN-CreateL2User
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
HEADERS
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "{{ONT_INTENT}}",
"uni-id": "LANx",
"q-vlan-id": "xxx",
"service-profile": "{{DEFAULT_L2_USER_SERVICE_PROFILE}}",
"customer-id": "testoption82"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "{{ONT_INTENT}}",
"uni-id": "LANx",
"q-vlan-id": "xxx",
"service-profile": "{{DEFAULT_L2_USER_SERVICE_PROFILE}}",
"customer-id": "testoption82"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
POST
IBN-l2UserIntentSync
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user/synchronize
PATCH
IntentNetworkStateDelete
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-type-version": "x",
"required-network-state": "delete"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent":{
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-type-version": "x",
"required-network-state": "delete"
}
}
POST
IntentSync
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user/synchronize
DELETE
IntentDelete
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
Example Request
DELETE {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
POST
IBN-CreateL2User
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
HEADERS
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_MCAST_NAME}}#{{L2_USER_MCAST_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "{{ONT_INTENT}}",
"uni-id": "LANx",
"q-vlan-id": "xxx",
"service-profile": "{{DEFAULT_L2_USER_SERVICE_PROFILE}}"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
{
"ibn:intent": {
"target": "{{L2_INFRA_MCAST_NAME}}#{{L2_USER_MCAST_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "{{ONT_INTENT}}",
"uni-id": "LANx",
"q-vlan-id": "xxx",
"service-profile": "{{DEFAULT_L2_USER_SERVICE_PROFILE}}"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
POST
IBN-l2UserIntentSync
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_MCAST_NAME}}%23{{L2_USER_MCAST_NAME}},l2-user/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_MCAST_NAME}}%23{{L2_USER_MCAST_NAME}},l2-user/synchronize
POST
IBN-CreateMcastUser
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
HEADERS
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_MCAST_NAME}}#{{L2_USER_MCAST_NAME}}",
"intent-type": "mcast-user",
"intent-specific-data": {
"mcast-user:mcast-user": {
"mcast-infra-name": "{{MCAST_INFRA_NAME}}",
"permitted-packages": [ "default" ],
"allowed-preview-packages": [ "default" ],
"service-profile": "{{MCAST_DEFAULT_SERVICE_PROFILE}}"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn
{
"ibn:intent": {
"target": "{{L2_INFRA_MCAST_NAME}}#{{L2_USER_MCAST_NAME}}",
"intent-type": "mcast-user",
"intent-specific-data": {
"mcast-user:mcast-user": {
"mcast-infra-name": "{{MCAST_INFRA_NAME}}",
"permitted-packages": [ "default" ],
"allowed-preview-packages": [ "default" ],
"service-profile": "{{MCAST_DEFAULT_SERVICE_PROFILE}}"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
POST
IBN-McastUserIntentSync
{{protocol}}://{{server}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_MCAST_NAME}}%23{{L2_USER_MCAST_NAME}},mcast-user/synchronize
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
Example Request
POST {{protocol}}://{{server}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_MCAST_NAME}}%23{{L2_USER_MCAST_NAME}},mcast-user/synchronize
PATCH
IBN modify ONT intent fiber reassign
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"fiber-name": "00a00b00c00d_0101"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"fiber-name": "00a00b00c00d_0101"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
IBN modify ONT intent UNI profile
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"uni-service-configuration": [{
"uni-id": "LAN1",
"service-profile": "VNOx_name_xxxM"
}]
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"uni-service-configuration": [{
"uni-id": "LAN1",
"service-profile": "VNOx_name_xxxM"
}]
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
IBN modify ONT intent SN change
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"expected-serial-number": "ALCLxxxxxxxx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"expected-serial-number": "ALCLxxxxxxxx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
IBN modify ONT intent ONT profile
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-service-profile": "VNOx_name_xx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-service-profile": "VNOx_name_xx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
IBN modify ONT intent ONT ID assign
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-id": "x"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{ONT_INTENT}},ont
{
"ibn:intent":{
"target": "{{ONT_INTENT}}",
"intent-type": "ont",
"intent-specific-data": {
"ont:ont": {
"onu-id": "x"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
patch l2-user option 82
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"customer-id": "changed_#option/82"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"customer-id": "changed_#option/82"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
patch l2-user ont
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "VNOx_NBI_ONTx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"user-device-name": "VNOx_NBI_ONTx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
patch l2-user q-vlan
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"q-vlan-id": "xxx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"q-vlan-id": "xxx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
patch l2-user service profile
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"service-profile": "VNOx_SERVICEx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"service-profile": "VNOx_SERVICEx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
PATCH
patch l2-user uni-id
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
HEADERS
Accept
application/yang-data+json
None
Content-Type
application/yang-data+json
None
BODY raw
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"uni-id": "LANx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
Example Request
PATCH {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/restconf/data/ibn:ibn/intent={{L2_INFRA_NAME}}%23{{L2_USER_NAME}},l2-user
{
"ibn:intent": {
"target": "{{L2_INFRA_NAME}}#{{L2_USER_NAME}}",
"intent-type": "l2-user",
"intent-specific-data": {
"l2-user:l2-user": {
"uni-id": "LANx"
}
},
"intent-type-version": "x",
"required-network-state": "active"
}
}
GET
OpenTSDB GET metrics
{{protocol}}://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/suggest?type=metrics&max=5000
PARAMS
type
metrics
None
max
5000
None
Example Request
GET {{protocol}}://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/suggest?type=metrics&max=5000
GET
OpenTSDB GET UP fwd frame
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalDnFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET UP fwd byte
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalUpFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET UP disc frame
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalUpDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET UP disc byte
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalUpDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET DN fwd frame
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalUpFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalUpFwdFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET DN fwd byte
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalDnFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnFwdByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET DN disc frame
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalDnDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnDiscFrameCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET DN disc byte
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:extendPortTotalDnDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:extendPortTotalDnDiscByteCounter.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET ONT Rx optical
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntOltsideOpInfoRxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
PARAMS
start
{{period}}
None
m
none:gponOntOltsideOpInfoRxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntOltsideOpInfoRxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
GET
OpenTSDB GET PON side Rx for ONT
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
PARAMS
start
{{period}}
None
m
none:gponOntAniOpInfoOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
GET
OpenTSDB GET PON TX optical
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponPonOltsideOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
PARAMS
start
{{period}}
None
m
none:gponPonOltsideOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponPonOltsideOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
GET
OpenTSDB GET ONT Tx optical
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
PARAMS
start
{{period}}
None
m
none:gponOntAniOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoTxOpticalSignalLevel.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
GET
OpenTSDB GET DN PON BER
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:bponPonStatsBerDownstream.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
PARAMS
start
{{period}}
None
m
none:bponPonStatsBerDownstream.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:bponPonStatsBerDownstream.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
GET
OpenTSDB GET operState PON port
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
PARAMS
start
{{period}}
None
m
none:operState.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_PON__s_Port__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}}
GET
OpenTSDB GET operState ONT
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
PARAMS
start
{{period}}
None
m
none:operState.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_ONT__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}}
GET
OpenTSDB GET operState UNI
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
PARAMS
start
{{period}}
None
m
none:operState.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:operState.{{device}}{relativeObjectID=ams__c_UNI__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.{{ONT}}.C1.P1}
GET
OpenTSDB GET tempONT
https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoTemperature.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.ONTx}
PARAMS
start
{{period}}
None
m
none:gponOntAniOpInfoTemperature.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.ONTx}
None
Example Request
GET https://{{server}}:{{DRportTSDB}}/altiplano-opentsdb/api/query?start={{period}}&m=none:gponOntAniOpInfoTemperature.{{device}}{relativeObjectID=ams__c_Optical__s_Measurements__c_IACM__c_Rx.Sx.{{LT}}.{{PON}}.ONTx}
GET
ES-GetAccessToken
{{protocol}}://{{server}}:{{es-port}}/auth/realms/master/protocol/openid-connect/token?username={{username}}&password={{passwordURLen}}
HEADERS
username
{{username}}
None
password
xxxxxxxxxxxxxxxxxx
None
PARAMS
username
{{username}}
None
password
{{passwordURLen}}
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/auth/realms/master/protocol/openid-connect/token?username={{username}}&password={{passwordURLen}}
GET
ES get alarms active
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-active/_search?alarmResourceUiName=ONT:{{device}}:IACM:Rx.Sx.LTx.PONx.ONTx
PARAMS
alarmResourceUiName
ONT:{{device}}:IACM:Rx.Sx.LTx.PONx.ONTx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-active/_search?alarmResourceUiName=ONT:{{device-name}}:IACM:Rx.Sx.LTx.PONx.ONTx
GET
ES get alarms active new ONT
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-active/_search?tl1Cause=NEWONT
PARAMS
tl1Cause
NEWONT
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-active/_search?tl1Cause=NEWONT
GET
ES get alarms active new ONT bad index
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?tl1Cause=NEWONT
PARAMS
tl1Cause
NEWONT
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?tl1Cause=NEWONT
GET
ES get alarms history
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-history-*/_search?alarmResourceUiName=ONT:{{device_name}}:IACM:Rx.Sx.LTx.PONx.ONTx&size=2
PARAMS
alarmResourceUiName
ONT:Device_name:IACM:Rx.Sx.LTx.PONx.ONTx
None
size
2
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-history-*/_search?alarmResourceUiName=ONT:{{device_name}}:IACM:Rx.Sx.LTx.PONx.ONTx&size=2
GET
ES get all alarms
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?alarmResourceUiName=ONT:{{device_name}}:IACM:Rx.Sx.LTx.PONx.ONTx&size=4
PARAMS
alarmResourceUiName
ONT:Device_name:IACM:Rx.Sx.LTx.PONx.ONTx
None
size
4
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?alarmResourceUiName=ONT:{{device-name}}:IACM:Rx.Sx.LTx.PONx.ONTx&size=4
GET
ES get PON alarms
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?alarmResourceUiName=PON%20Port:{{device-name}}:IACM:Rx.Sx.LTx.PONx
PARAMS
alarmResourceUiName
PON%20Port:Device_name:IACM:Rx.Sx.LTx.PONx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/alarms-*/_search?alarmResourceUiName=PON%20Port:{{device-name}}:IACM:Rx.Sx.LTx.PONx
GET
ES get all intents
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?size=100
PARAMS
size
100
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?size=100
GET
ES get all ONT intnents
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?targetOntName=VNOx
PARAMS
targetOntName
VNOx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?targetOntName=VNOx
GET
ES get ONT intnent based on SN
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?expectedSerialNumber=ALCLxxxxxxxx
PARAMS
expectedSerialNumber
ALCLxxxxxxxx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?expectedSerialNumber=ALCLxxxxxxxx
GET
ES get Fiber intent
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?oltName={{device}}&relativeObjectId=ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
PARAMS
oltName
{{device}}
None
relativeObjectId
ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?oltName={{device}}&relativeObjectId=ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
GET
ES get Fiber intent PON6
{{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?oltName={{device}}&relativeObjectId=ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
PARAMS
oltName
{{device}}
None
relativeObjectId
ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
None
Example Request
GET {{protocol}}://{{server}}:{{es-port}}/altiplano-elasticsearch/intents-*/_search?oltName={{device}}&relativeObjectId=ams%3APON%20Port%3AIACM%3ARx.Sx.LTx.PONx
POST
IBN-GetAccessToken- for collection
{{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/auth/login
Get Access Token and Refresh Token by Login method before executing any other RESTCONF request.
HEADERS
Authorization
Basic Basic YWRtaW51c2VyOnBhc3N3b3Jk
None
Example Request
POST {{protocol}}://{{server}}:{{DRportIBN}}/{{base-url}}/rest/auth/login