Netgate TNSR Logo
API docs by Redocly

ietf-ipfix-psamp API (24.06)

IPFIX/PSAMP Configuration Data Model

Copyright (c) 2012 IETF Trust and the persons identified as the document authors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).

ipfix

returns ietf.ipfix.psamp.Ipfix

Top-level node of the IPFIX/PSAMP configuration data model.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:ipfix": {
    }
}

creates ietf.ipfix.psamp.Ipfix

Top-level node of the IPFIX/PSAMP configuration data model.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.Ipfix to be added to list

Array of objects (ietf.ipfix.psamp.ipfix.ObservationPoint)

Observation Point of the Monitoring Device.

Array of objects (ietf.ipfix.psamp.ipfix.ExportingProcess)

Exporting Process of the Monitoring Device.

Array of objects (ietf.ipfix.psamp.ipfix.Cache)

Cache of the Monitoring Device.

Array of objects (ietf.ipfix.psamp.ipfix.CollectingProcess)

Collecting Process of the Monitoring Device.

Array of objects (ietf.ipfix.psamp.ipfix.SelectionProcess)

Selection Process of the Monitoring Device.

Responses

Request samples

Content type
application/yang-data+json
{
  • "observationPoint": [
    ],
  • "exportingProcess": [
    ],
  • "cache": [
    ],
  • "collectingProcess": [
    ],
  • "selectionProcess": [
    ]
}

creates or updates ietf.ipfix.psamp.Ipfix

Top-level node of the IPFIX/PSAMP configuration data model.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.Ipfix to be added or updated

object (ietf.ipfix.psamp.Ipfix)

Top-level node of the IPFIX/PSAMP configuration data model.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:ipfix": {
    }
}

removes ietf.ipfix.psamp.Ipfix

Top-level node of the IPFIX/PSAMP configuration data model.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.ipfix.Cache

Cache of the Monitoring Device.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.Cache to be added to list

ietf-ipfix-psamp:exportingProcess
Array of strings

Records are exported by all Exporting Processes in the list.

ietf-ipfix-psamp:cacheDiscontinuityTime
string

Timestamp of the most recent occasion at which the counter dataRecords suffered a discontinuity. Note that this parameter functionally corresponds to ipfixMeteringProcessDiscontinuityTime in the IPFIX MIB module. In contrast to ipfixMeteringProcessDiscontinuityTime, the time is absolute and not relative to sysUpTime. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessDiscontinuityTime).]

object (ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

ietf-ipfix-psamp:meteringProcessId
integer <int64>

The identifier of the Metering Process this Cache belongs to. This parameter corresponds to the Information Element meteringProcessId. Its occurrence helps to associate Cache parameters with Metering Process statistics exported by the Monitoring Device using the Metering Process (Reliability) Statistics Template as defined by the IPFIX protocol specification. REF:Optional[RFC 5101, Sections 4.1 and 4.2; IANA registry for IPFIX Entities, http://www.iana.org/assignments/ipfix.]

ietf-ipfix-psamp:dataRecords
integer <int32>

The number of Data Records generated by this Cache. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of cacheDiscontinuityTime. Note that this parameter corresponds to ipfixMeteringProcessDataRecords in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessDataRecords).]

ietf-ipfix-psamp:name
string

Key of this list.

object (ietf.ipfix.psamp.CacheLayoutParameters)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

object (ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

object (ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:exportingProcess": [
    ],
  • "ietf-ipfix-psamp:cacheDiscontinuityTime": "string",
  • "ietf-ipfix-psamp:permanentCache": {
    },
  • "ietf-ipfix-psamp:meteringProcessId": 0,
  • "ietf-ipfix-psamp:dataRecords": 0,
  • "ietf-ipfix-psamp:name": "string",
  • "ietf-ipfix-psamp:immediateCache": {
    },
  • "ietf-ipfix-psamp:timeoutCache": {
    },
  • "ietf-ipfix-psamp:naturalCache": {
    }
}

returns ietf.ipfix.psamp.ipfix.Cache

Cache of the Monitoring Device.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cache": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.Cache

Cache of the Monitoring Device.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.Cache to be added or updated

object (ietf.ipfix.psamp.ipfix.Cache)

Cache of the Monitoring Device.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cache": {
    }
}

removes ietf.ipfix.psamp.ipfix.Cache

Cache of the Monitoring Device.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.CacheLayoutParameters

Flow expiration after the first packet; generation of Packet Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:immediateCache": {
    }
}

creates ietf.ipfix.psamp.CacheLayoutParameters

Flow expiration after the first packet; generation of Packet Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.CacheLayoutParameters to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates or updates ietf.ipfix.psamp.CacheLayoutParameters

Flow expiration after the first packet; generation of Packet Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.CacheLayoutParameters to be added or updated

object (ietf.ipfix.psamp.CacheLayoutParameters)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:immediateCache": {
    }
}

removes ietf.ipfix.psamp.CacheLayoutParameters

Flow expiration after the first packet; generation of Packet Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache/cacheLayout"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache/cacheLayout"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

returns ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/immediateCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache

Flow expiration after active and idle timeout, or on natural termination (e.g., TCP FIN or TCP RST) of the Flow; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:naturalCache": {
    }
}

creates ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache

Flow expiration after active and idle timeout, or on natural termination (e.g., TCP FIN or TCP RST) of the Flow; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

ietf-ipfix-psamp:activeTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired even though packets matching this Flow are still received by the Cache. The parameter value zero indicates infinity, meaning that there is no active timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveTimeout).]

ietf-ipfix-psamp:unusedCacheEntries
integer <int64>

The number of unused Cache entries in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheUnusedCacheEntries).]

ietf-ipfix-psamp:activeFlows
integer <int64>

The number of Flows currently active in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveFlows).]

ietf-ipfix-psamp:maxFlows
integer <int64>

This parameter configures the maximum number of Flows in the Cache, which is the maximum number of Flows that can be measured simultaneously. The Monitoring Device MUST ensure that sufficient resources are available to store the configured maximum number of Flows. If the maximum number of Flows is measured, an additional Flow can be measured only if an existing entry is removed. However, traffic that pertains to existing Flows can continue to be measured.

ietf-ipfix-psamp:exportInterval
integer <int64>

This parameter configures the interval (in seconds) for periodical export of Flow Records. If not configured by the user, the Monitoring Device sets this parameter.

ietf-ipfix-psamp:idleTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired if no more packets matching this Flow are received by the Cache. The parameter value zero indicates infinity, meaning that there is no idle timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheIdleTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheIdleTimeout).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    },
  • "ietf-ipfix-psamp:activeTimeout": 0,
  • "ietf-ipfix-psamp:unusedCacheEntries": 0,
  • "ietf-ipfix-psamp:activeFlows": 0,
  • "ietf-ipfix-psamp:maxFlows": 0,
  • "ietf-ipfix-psamp:exportInterval": 0,
  • "ietf-ipfix-psamp:idleTimeout": 0
}

creates or updates ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache

Flow expiration after active and idle timeout, or on natural termination (e.g., TCP FIN or TCP RST) of the Flow; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache to be added or updated

object (ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:naturalCache": {
    }
}

removes ietf.ipfix.psamp.ipfix.cache.cachetype.naturalcache.NaturalCache

Flow expiration after active and idle timeout, or on natural termination (e.g., TCP FIN or TCP RST) of the Flow; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache/cacheLayout"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache/cacheLayout"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

returns ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/naturalCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache

No flow expiration, periodical export with time interval exportInterval; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:permanentCache": {
    }
}

creates ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache

No flow expiration, periodical export with time interval exportInterval; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

ietf-ipfix-psamp:activeTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired even though packets matching this Flow are still received by the Cache. The parameter value zero indicates infinity, meaning that there is no active timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveTimeout).]

ietf-ipfix-psamp:unusedCacheEntries
integer <int64>

The number of unused Cache entries in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheUnusedCacheEntries).]

ietf-ipfix-psamp:activeFlows
integer <int64>

The number of Flows currently active in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveFlows).]

ietf-ipfix-psamp:maxFlows
integer <int64>

This parameter configures the maximum number of Flows in the Cache, which is the maximum number of Flows that can be measured simultaneously. The Monitoring Device MUST ensure that sufficient resources are available to store the configured maximum number of Flows. If the maximum number of Flows is measured, an additional Flow can be measured only if an existing entry is removed. However, traffic that pertains to existing Flows can continue to be measured.

ietf-ipfix-psamp:exportInterval
integer <int64>

This parameter configures the interval (in seconds) for periodical export of Flow Records. If not configured by the user, the Monitoring Device sets this parameter.

ietf-ipfix-psamp:idleTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired if no more packets matching this Flow are received by the Cache. The parameter value zero indicates infinity, meaning that there is no idle timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheIdleTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheIdleTimeout).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    },
  • "ietf-ipfix-psamp:activeTimeout": 0,
  • "ietf-ipfix-psamp:unusedCacheEntries": 0,
  • "ietf-ipfix-psamp:activeFlows": 0,
  • "ietf-ipfix-psamp:maxFlows": 0,
  • "ietf-ipfix-psamp:exportInterval": 0,
  • "ietf-ipfix-psamp:idleTimeout": 0
}

creates or updates ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache

No flow expiration, periodical export with time interval exportInterval; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache to be added or updated

object (ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:permanentCache": {
    }
}

removes ietf.ipfix.psamp.ipfix.cache.cachetype.permanentcache.PermanentCache

No flow expiration, periodical export with time interval exportInterval; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache/cacheLayout"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache/cacheLayout"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

returns ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/permanentCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache

Flow expiration after active and idle timeout; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:timeoutCache": {
    }
}

creates ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache

Flow expiration after active and idle timeout; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

ietf-ipfix-psamp:activeTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired even though packets matching this Flow are still received by the Cache. The parameter value zero indicates infinity, meaning that there is no active timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveTimeout).]

ietf-ipfix-psamp:unusedCacheEntries
integer <int64>

The number of unused Cache entries in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheUnusedCacheEntries).]

ietf-ipfix-psamp:activeFlows
integer <int64>

The number of Flows currently active in this Cache. Note that this parameter corresponds to ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheActiveFlows).]

ietf-ipfix-psamp:maxFlows
integer <int64>

This parameter configures the maximum number of Flows in the Cache, which is the maximum number of Flows that can be measured simultaneously. The Monitoring Device MUST ensure that sufficient resources are available to store the configured maximum number of Flows. If the maximum number of Flows is measured, an additional Flow can be measured only if an existing entry is removed. However, traffic that pertains to existing Flows can continue to be measured.

ietf-ipfix-psamp:exportInterval
integer <int64>

This parameter configures the interval (in seconds) for periodical export of Flow Records. If not configured by the user, the Monitoring Device sets this parameter.

ietf-ipfix-psamp:idleTimeout
integer <int64>

This parameter configures the time in seconds after which a Flow is expired if no more packets matching this Flow are received by the Cache. The parameter value zero indicates infinity, meaning that there is no idle timeout. If not configured by the user, the Monitoring Device sets this parameter. Note that this parameter corresponds to ipfixMeteringProcessCacheIdleTimeout in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixMeteringProcessCacheIdleTimeout).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    },
  • "ietf-ipfix-psamp:activeTimeout": 0,
  • "ietf-ipfix-psamp:unusedCacheEntries": 0,
  • "ietf-ipfix-psamp:activeFlows": 0,
  • "ietf-ipfix-psamp:maxFlows": 0,
  • "ietf-ipfix-psamp:exportInterval": 0,
  • "ietf-ipfix-psamp:idleTimeout": 0
}

creates or updates ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache

Flow expiration after active and idle timeout; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache to be added or updated

object (ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache)

Cache Layout parameters used by immediateCache, timeoutCache, naturalCache, and permanentCache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:timeoutCache": {
    }
}

removes ietf.ipfix.psamp.ipfix.cache.cachetype.timeoutcache.TimeoutCache

Flow expiration after active and idle timeout; generation of Flow Records.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache/cacheLayout"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.CacheLayout to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.CacheLayout)

Cache Layout parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheLayout": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.CacheLayout

Cache Layout parameters.

path Parameters
name
required
string

Id of cache

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache/cacheLayout"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added to list

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

returns ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

creates or updates ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField to be added or updated

object (ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField)

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:cacheField": {
    }
}

removes ietf.ipfix.psamp.cachelayoutparameters.cachelayout.CacheField

Superset of fields that are included in the Packet Reports or Flow Records generated by the Cache.

path Parameters
name
required
string

Id of cache

cacheField-name
required
string

Id of cacheField

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/cache=%7Bname%7D/timeoutCache/cacheLayout/cacheField=%7BcacheField-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.ipfix.CollectingProcess

Collecting Process of the Monitoring Device.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.CollectingProcess to be added to list

Array of objects (ietf.ipfix.psamp.collectingprocessparameters.UdpCollector)

List of UDP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

Array of objects (ietf.ipfix.psamp.collectingprocessparameters.TcpCollector)

List of TCP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

Array of objects (ietf.ipfix.psamp.collectingprocessparameters.FileReader)

List of File Readers from which the Collecting Process reads IPFIX Messages.

Array of objects (ietf.ipfix.psamp.collectingprocessparameters.SctpCollector)

List of SCTP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

name
string

Key of this list.

exportingProcess
Array of strings

Export of received records without any modifications. Records are processed by all Exporting Processes in the list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:udpCollector": [
    ],
  • "ietf-ipfix-psamp:tcpCollector": [
    ],
  • "ietf-ipfix-psamp:fileReader": [
    ],
  • "ietf-ipfix-psamp:sctpCollector": [
    ],
  • "name": "string",
  • "exportingProcess": [
    ]
}

returns ietf.ipfix.psamp.ipfix.CollectingProcess

Collecting Process of the Monitoring Device.

path Parameters
name
required
string

Id of collectingProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:collectingProcess": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.CollectingProcess

Collecting Process of the Monitoring Device.

path Parameters
name
required
string

Id of collectingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.CollectingProcess to be added or updated

object (ietf.ipfix.psamp.ipfix.CollectingProcess)

Parameters of a Collecting Process.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:collectingProcess": {
    }
}

removes ietf.ipfix.psamp.ipfix.CollectingProcess

Collecting Process of the Monitoring Device.

path Parameters
name
required
string

Id of collectingProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.collectingprocessparameters.FileReader

List of File Readers from which the Collecting Process reads IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.FileReader to be added to list

Array of objects (ietf.ipfix.psamp.TemplateParameters)

This list contains the Templates and Options Templates that have been read by the File Reader. Withdrawn or invalidated (Options) Template MUST be removed from this list.

ietf-ipfix-psamp:fileReaderDiscontinuityTime
string

Timestamp of the most recent occasion at which one or more File Reader counters suffered a discontinuity. In contrast to discontinuity times in the IPFIX MIB module, the time is absolute and not relative to sysUpTime.

ietf-ipfix-psamp:file
string

URI specifying the location of the file.

ietf-ipfix-psamp:records
integer <int32>

The number of Data Records read by the File Reader. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.

ietf-ipfix-psamp:bytes
integer <int32>

The number of bytes read by the File Reader. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.

ietf-ipfix-psamp:templates
integer <int64>

The number of Template Records (excluding Options Template Records) read by the File Reader. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.

ietf-ipfix-psamp:messages
integer <int32>

The number of IPFIX Messages read by the File Reader. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.

ietf-ipfix-psamp:optionsTemplates
integer <int64>

The number of Options Template Records read by the File Reader. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": [
    ],
  • "ietf-ipfix-psamp:fileReaderDiscontinuityTime": "string",
  • "ietf-ipfix-psamp:file": "string",
  • "ietf-ipfix-psamp:records": 0,
  • "ietf-ipfix-psamp:bytes": 0,
  • "ietf-ipfix-psamp:templates": 0,
  • "ietf-ipfix-psamp:messages": 0,
  • "ietf-ipfix-psamp:optionsTemplates": 0,
  • "name": "string"
}

returns ietf.ipfix.psamp.collectingprocessparameters.FileReader

List of File Readers from which the Collecting Process reads IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

fileReader-name
required
string

Id of fileReader

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/fileReader=%7BfileReader-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:fileReader": {
    }
}

creates or updates ietf.ipfix.psamp.collectingprocessparameters.FileReader

List of File Readers from which the Collecting Process reads IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

fileReader-name
required
string

Id of fileReader

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.FileReader to be added or updated

object (ietf.ipfix.psamp.collectingprocessparameters.FileReader)

File Reader parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:fileReader": {
    }
}

removes ietf.ipfix.psamp.collectingprocessparameters.FileReader

List of File Readers from which the Collecting Process reads IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

fileReader-name
required
string

Id of fileReader

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/fileReader=%7BfileReader-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that have been read by the File Reader. Withdrawn or invalidated (Options) Template MUST be removed from this list.

path Parameters
name
required
string

Id of collectingProcess

fileReader-name
required
string

Id of fileReader

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/fileReader=%7BfileReader-name%7D/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of collectingProcess

fileReader-name
required
string

Id of fileReader

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/fileReader=%7BfileReader-name%7D/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

creates ietf.ipfix.psamp.collectingprocessparameters.SctpCollector

List of SCTP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.SctpCollector to be added to list

ietf-ipfix-psamp:localPort
integer <int32>

If not configured, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Array of objects (ietf.ipfix.psamp.TransportSessionParameters)

This list contains the currently established Transport Sessions terminating at the given socket.

localIPAddress
Array of strings

List of local IP addresses on which the Collecting Process listens for IPFIX Messages. The IP addresses are used as eligible local IP addresses of the multihomed SCTP endpoint. REF:Optional[RFC 4960, Section 6.4.]

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:localPort": 0,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:transportSession": [
    ],
  • "localIPAddress": [
    ],
  • "name": "string"
}

returns ietf.ipfix.psamp.collectingprocessparameters.SctpCollector

List of SCTP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sctpCollector": {
    }
}

creates or updates ietf.ipfix.psamp.collectingprocessparameters.SctpCollector

List of SCTP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.SctpCollector to be added or updated

object (ietf.ipfix.psamp.collectingprocessparameters.SctpCollector)

Parameters of a Collecting Process that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sctpCollector": {
    }
}

removes ietf.ipfix.psamp.collectingprocessparameters.SctpCollector

List of SCTP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

This list contains the currently established Transport Sessions terminating at the given socket.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of collectingProcess

sctpCollector-name
required
string

Id of sctpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/sctpCollector=%7BsctpCollector-name%7D/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

creates ietf.ipfix.psamp.collectingprocessparameters.TcpCollector

List of TCP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.TcpCollector to be added to list

ietf-ipfix-psamp:localPort
integer <int32>

If not configured, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Array of objects (ietf.ipfix.psamp.TransportSessionParameters)

This list contains the currently established Transport Sessions terminating at the given socket.

localIPAddress
Array of strings

List of local IP addresses on which the Collecting Process listens for IPFIX Messages.

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:localPort": 0,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:transportSession": [
    ],
  • "localIPAddress": [
    ],
  • "name": "string"
}

returns ietf.ipfix.psamp.collectingprocessparameters.TcpCollector

List of TCP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:tcpCollector": {
    }
}

creates or updates ietf.ipfix.psamp.collectingprocessparameters.TcpCollector

List of TCP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.TcpCollector to be added or updated

object (ietf.ipfix.psamp.collectingprocessparameters.TcpCollector)

Parameters of a Collecting Process that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:tcpCollector": {
    }
}

removes ietf.ipfix.psamp.collectingprocessparameters.TcpCollector

List of TCP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

This list contains the currently established Transport Sessions terminating at the given socket.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of collectingProcess

tcpCollector-name
required
string

Id of tcpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/tcpCollector=%7BtcpCollector-name%7D/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

creates ietf.ipfix.psamp.collectingprocessparameters.UdpCollector

List of UDP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.UdpCollector to be added to list

ietf-ipfix-psamp:localPort
integer <int32>

If not configured, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Array of objects (ietf.ipfix.psamp.TransportSessionParameters)

This list contains the currently established Transport Sessions terminating at the given socket.

templateLifePacket
integer <int64>

If this parameter is configured, Templates defined in a UDP Transport Session become invalid if they are neither included in a sequence of more than this number of IPFIX Messages nor received again within the period of time specified by templateLifeTime. Note that this parameter corresponds to ipfixTransportSessionTemplateRefreshPacket in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.7; RFC 6615, Section 8 (ipfixTransportSessionTemplateRefreshPacket).]

templateLifeTime
integer <int64>
Default: 1800

Sets the lifetime of Templates for all UDP Transport Sessions terminating at this UDP socket. Templates that are not received again within the configured lifetime become invalid at the Collecting Process. As specified in RFC 5101, the Template lifetime MUST be at least three times higher than the templateRefreshTimeout parameter value configured on the corresponding Exporting Processes. Note that this parameter corresponds to ipfixTransportSessionTemplateRefreshTimeout in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.7; RFC 6615, Section 8 (ipfixTransportSessionTemplateRefreshTimeout).]

localIPAddress
Array of strings

List of local IP addresses on which the Collecting Process listens for IPFIX Messages.

optionsTemplateLifePacket
integer <int64>

If this parameter is configured, Options Templates defined in a UDP Transport Session become invalid if they are neither included in a sequence of more than this number of IPFIX Messages nor received again within the period of time specified by optionsTemplateLifeTime. Note that this parameter corresponds to ipfixTransportSessionOptionsTemplateRefreshPacket in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.7; RFC 6615, Section 8 (ipfixTransportSessionOptionsTemplateRefreshPacket).]

optionsTemplateLifeTime
integer <int64>
Default: 1800

Sets the lifetime of Options Templates for all UDP Transport Sessions terminating at this UDP socket. Options Templates that are not received again within the configured lifetime become invalid at the Collecting Process. As specified in RFC 5101, the Options Template lifetime MUST be at least three times higher than the optionsTemplateRefreshTimeout parameter value configured on the corresponding Exporting Processes. Note that this parameter corresponds to ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.7; RFC 6615, Section 8 (ipfixTransportSessionOptionsTemplateRefreshTimeout).]

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:localPort": 0,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:transportSession": [
    ],
  • "templateLifePacket": 0,
  • "templateLifeTime": 1800,
  • "localIPAddress": [
    ],
  • "optionsTemplateLifePacket": 0,
  • "optionsTemplateLifeTime": 1800,
  • "name": "string"
}

returns ietf.ipfix.psamp.collectingprocessparameters.UdpCollector

List of UDP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:udpCollector": {
    }
}

creates or updates ietf.ipfix.psamp.collectingprocessparameters.UdpCollector

List of UDP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.collectingprocessparameters.UdpCollector to be added or updated

object (ietf.ipfix.psamp.collectingprocessparameters.UdpCollector)

Parameters of a Collecting Process that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:udpCollector": {
    }
}

removes ietf.ipfix.psamp.collectingprocessparameters.UdpCollector

List of UDP receivers (sockets) on which the Collecting Process receives IPFIX Messages.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

This list contains the currently established Transport Sessions terminating at the given socket.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of collectingProcess

udpCollector-name
required
string

Id of udpCollector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/collectingProcess=%7Bname%7D/udpCollector=%7BudpCollector-name%7D/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

creates ietf.ipfix.psamp.ipfix.ExportingProcess

Exporting Process of the Monitoring Device.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.ExportingProcess to be added to list

Array of objects (ietf.ipfix.psamp.exportingprocessparameters.Options)

List of options reported by the Exporting Process.

Array of objects (ietf.ipfix.psamp.exportingprocessparameters.Destination)

List of export destinations.

ietf-ipfix-psamp:exportingProcessId
integer <int64>

The identifier of the Exporting Process. This parameter corresponds to the Information Element exportingProcessId. Its occurrence helps to associate Exporting Process parameters with Exporing Process statistics exported by the Monitoring Device using the Exporting Process Reliability Statistics Template as defined by the IPFIX protocol specification. REF:Optional[RFC 5101, Section 4.3; IANA registry for IPFIX Entities, http://www.iana.org/assignments/ipfix.]

ietf-ipfix-psamp:exportMode
string
Default: "parallel"

This parameter determines to which configured destination(s) the incoming Data Records are exported.

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:options": [
    ],
  • "ietf-ipfix-psamp:destination": [
    ],
  • "ietf-ipfix-psamp:exportingProcessId": 0,
  • "ietf-ipfix-psamp:exportMode": "parallel",
  • "name": "string"
}

returns ietf.ipfix.psamp.ipfix.ExportingProcess

Exporting Process of the Monitoring Device.

path Parameters
name
required
string

Id of exportingProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:exportingProcess": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.ExportingProcess

Exporting Process of the Monitoring Device.

path Parameters
name
required
string

Id of exportingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.ExportingProcess to be added or updated

object (ietf.ipfix.psamp.ipfix.ExportingProcess)

Parameters of an Exporting Process.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:exportingProcess": {
    }
}

removes ietf.ipfix.psamp.ipfix.ExportingProcess

Exporting Process of the Monitoring Device.

path Parameters
name
required
string

Id of exportingProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.exportingprocessparameters.Destination

List of export destinations.

path Parameters
name
required
string

Id of exportingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.exportingprocessparameters.Destination to be added to list

ietf-ipfix-psamp:name
string

Key of this list.

object (ietf.ipfix.psamp.UdpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

object (ietf.ipfix.psamp.FileWriterParameters)

File Writer parameters.

object (ietf.ipfix.psamp.SctpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

object (ietf.ipfix.psamp.TcpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:name": "string",
  • "ietf-ipfix-psamp:udpExporter": {
    },
  • "ietf-ipfix-psamp:fileWriter": {
    },
  • "ietf-ipfix-psamp:sctpExporter": {
    },
  • "ietf-ipfix-psamp:tcpExporter": {
    }
}

returns ietf.ipfix.psamp.exportingprocessparameters.Destination

List of export destinations.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:destination": {
    }
}

creates or updates ietf.ipfix.psamp.exportingprocessparameters.Destination

List of export destinations.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.exportingprocessparameters.Destination to be added or updated

object (ietf.ipfix.psamp.exportingprocessparameters.Destination)

List of export destinations.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:destination": {
    }
}

removes ietf.ipfix.psamp.exportingprocessparameters.Destination

List of export destinations.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.FileWriterParameters

File Writer parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/fileWriter"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:fileWriter": {
    }
}

creates ietf.ipfix.psamp.FileWriterParameters

File Writer parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FileWriterParameters to be added to list

Array of objects (ietf.ipfix.psamp.TemplateParameters)

This list contains the Templates and Options Templates that have been written by the File Reader. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

ietf-ipfix-psamp:ipfixVersion
integer <int32>
Default: 10

IPFIX version number. REF:Optional[RFC 5101.]

ietf-ipfix-psamp:file
string

URI specifying the location of the file.

ietf-ipfix-psamp:records
integer <int32>

The number of Data Records written by the File Writer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

ietf-ipfix-psamp:discardedMessages
integer <int32>

The number of IPFIX Messages that could not be written by the File Writer due to internal buffer overflows, limited storage capacity, etc. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

ietf-ipfix-psamp:bytes
integer <int32>

The number of bytes written by the File Writer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

ietf-ipfix-psamp:templates
integer <int64>

The number of Template Records (excluding Options Template Records) written by the File Writer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

ietf-ipfix-psamp:messages
integer <int32>

The number of IPFIX Messages written by the File Writer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

ietf-ipfix-psamp:fileWriterDiscontinuityTime
string

Timestamp of the most recent occasion at which one or more File Writer counters suffered a discontinuity. In contrast to discontinuity times in the IPFIX MIB module, the time is absolute and not relative to sysUpTime.

ietf-ipfix-psamp:optionsTemplates
integer <int64>

The number of Options Template Records written by the File Writer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": [
    ],
  • "ietf-ipfix-psamp:ipfixVersion": 10,
  • "ietf-ipfix-psamp:file": "string",
  • "ietf-ipfix-psamp:records": 0,
  • "ietf-ipfix-psamp:discardedMessages": 0,
  • "ietf-ipfix-psamp:bytes": 0,
  • "ietf-ipfix-psamp:templates": 0,
  • "ietf-ipfix-psamp:messages": 0,
  • "ietf-ipfix-psamp:fileWriterDiscontinuityTime": "string",
  • "ietf-ipfix-psamp:optionsTemplates": 0
}

creates or updates ietf.ipfix.psamp.FileWriterParameters

File Writer parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FileWriterParameters to be added or updated

object (ietf.ipfix.psamp.FileWriterParameters)

File Writer parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:fileWriter": {
    }
}

removes ietf.ipfix.psamp.FileWriterParameters

File Writer parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/fileWriter"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that have been written by the File Reader. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/fileWriter/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/fileWriter/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

returns ietf.ipfix.psamp.SctpExporterParameters

SCTP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sctpExporter": {
    }
}

creates ietf.ipfix.psamp.SctpExporterParameters

SCTP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SctpExporterParameters to be added to list

ietf-ipfix-psamp:destinationPort
integer <int32>

If not configured by the user, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

ietf-ipfix-psamp:ipfixVersion
integer <int32>
Default: 10

IPFIX version number. REF:Optional[RFC 5101.]

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

ietf-ipfix-psamp:ifIndex
integer <int64>

Index of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

ietf-ipfix-psamp:rateLimit
integer <int64>

Maximum number of bytes per second the Exporting Process may export to the given destination. The number of bytes is calculated from the lengths of the IPFIX Messages exported. If not configured, no rate limiting is performed. REF:Optional[RFC 5476, Section 6.3.]

ietf-ipfix-psamp:sendBufferSize
integer <int64>

Size of the socket send buffer. If not configured by the user, this parameter is set by the Monitoring Device.

ietf-ipfix-psamp:ifName
string

Name of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

object (ietf.ipfix.psamp.TransportSessionParameters)

State parameters of a Transport Session originating from an Exporting Process or terminating at a Collecting Process. Parameter names and semantics correspond to the managed objects in IPFIX-MIB. REF:Optional[RFC 5101; RFC 6615, Section 8 (ipfixTransportSessionEntry, ipfixTransportSessionStatsEntry).]

timedReliability
integer <int64>
Default: 0

Lifetime in milliseconds until an IPFIX Message containing Data Sets only is 'abandoned' due to the timed reliability mechanism of PR-SCTP. If this parameter is set to zero, reliable SCTP transport is used for all Data Records. Regardless of the value of this parameter, the Exporting Process MAY use reliable SCTP transport for Data Sets associated with Options Templates. REF:Optional[RFC 3758; RFC 4960.]

destinationIPAddress
Array of strings

One or more IP addresses of the Collecting Process to which IPFIX Messages are sent. The user MUST ensure that all configured IP addresses belong to the same Collecting Process. The Exporting Process tries to establish an SCTP association to any of the configured destination IP addresses. REF:Optional[RFC 4960, Section 6.4.]

sourceIPAddress
Array of strings

List of source IP addresses used by the Exporting Process. If configured, the specified addresses are eligible local IP addresses of the multihomed SCTP endpoint. If not configured, all locally assigned IP addresses are eligible local IP addresses. REF:Optional[RFC 4960, Section 6.4.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:destinationPort": 0,
  • "ietf-ipfix-psamp:ipfixVersion": 10,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:ifIndex": 0,
  • "ietf-ipfix-psamp:rateLimit": 0,
  • "ietf-ipfix-psamp:sendBufferSize": 0,
  • "ietf-ipfix-psamp:ifName": "string",
  • "ietf-ipfix-psamp:transportSession": {
    },
  • "timedReliability": 0,
  • "destinationIPAddress": [
    ],
  • "sourceIPAddress": [
    ]
}

creates or updates ietf.ipfix.psamp.SctpExporterParameters

SCTP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SctpExporterParameters to be added or updated

object (ietf.ipfix.psamp.SctpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sctpExporter": {
    }
}

removes ietf.ipfix.psamp.SctpExporterParameters

SCTP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

State parameters of the Transport Session directed to the given destination.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/sctpExporter/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

returns ietf.ipfix.psamp.TcpExporterParameters

TCP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:tcpExporter": {
    }
}

creates ietf.ipfix.psamp.TcpExporterParameters

TCP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TcpExporterParameters to be added to list

ietf-ipfix-psamp:destinationPort
integer <int32>

If not configured by the user, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

ietf-ipfix-psamp:ipfixVersion
integer <int32>
Default: 10

IPFIX version number. REF:Optional[RFC 5101.]

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

ietf-ipfix-psamp:ifIndex
integer <int64>

Index of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

ietf-ipfix-psamp:rateLimit
integer <int64>

Maximum number of bytes per second the Exporting Process may export to the given destination. The number of bytes is calculated from the lengths of the IPFIX Messages exported. If not configured, no rate limiting is performed. REF:Optional[RFC 5476, Section 6.3.]

ietf-ipfix-psamp:sendBufferSize
integer <int64>

Size of the socket send buffer. If not configured by the user, this parameter is set by the Monitoring Device.

ietf-ipfix-psamp:ifName
string

Name of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

object (ietf.ipfix.psamp.TransportSessionParameters)

State parameters of a Transport Session originating from an Exporting Process or terminating at a Collecting Process. Parameter names and semantics correspond to the managed objects in IPFIX-MIB. REF:Optional[RFC 5101; RFC 6615, Section 8 (ipfixTransportSessionEntry, ipfixTransportSessionStatsEntry).]

destinationIPAddress
string

IP address of the Collection Process to which IPFIX Messages are sent.

sourceIPAddress
string

Source IP address used by the Exporting Process. If not configured by the user, this parameter is set by the Monitoring Device to an IP address assigned to the outgoing interface.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:destinationPort": 0,
  • "ietf-ipfix-psamp:ipfixVersion": 10,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:ifIndex": 0,
  • "ietf-ipfix-psamp:rateLimit": 0,
  • "ietf-ipfix-psamp:sendBufferSize": 0,
  • "ietf-ipfix-psamp:ifName": "string",
  • "ietf-ipfix-psamp:transportSession": {
    },
  • "destinationIPAddress": "string",
  • "sourceIPAddress": "string"
}

creates or updates ietf.ipfix.psamp.TcpExporterParameters

TCP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TcpExporterParameters to be added or updated

object (ietf.ipfix.psamp.TcpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:tcpExporter": {
    }
}

removes ietf.ipfix.psamp.TcpExporterParameters

TCP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

State parameters of the Transport Session directed to the given destination.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/tcpExporter/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

returns ietf.ipfix.psamp.UdpExporterParameters

UDP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:udpExporter": {
    }
}

creates ietf.ipfix.psamp.UdpExporterParameters

UDP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.UdpExporterParameters to be added to list

ietf-ipfix-psamp:destinationPort
integer <int32>

If not configured by the user, the Monitoring Device uses the default port number for IPFIX, which is 4739 without TLS or DTLS and 4740 if TLS or DTLS is activated.

ietf-ipfix-psamp:ipfixVersion
integer <int32>
Default: 10

IPFIX version number. REF:Optional[RFC 5101.]

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

ietf-ipfix-psamp:ifIndex
integer <int64>

Index of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

ietf-ipfix-psamp:rateLimit
integer <int64>

Maximum number of bytes per second the Exporting Process may export to the given destination. The number of bytes is calculated from the lengths of the IPFIX Messages exported. If not configured, no rate limiting is performed. REF:Optional[RFC 5476, Section 6.3.]

ietf-ipfix-psamp:sendBufferSize
integer <int64>

Size of the socket send buffer. If not configured by the user, this parameter is set by the Monitoring Device.

ietf-ipfix-psamp:ifName
string

Name of an interface as stored in the ifTable of IF-MIB. REF:Optional[RFC 2863.]

object (ietf.ipfix.psamp.TransportSessionParameters)

State parameters of a Transport Session originating from an Exporting Process or terminating at a Collecting Process. Parameter names and semantics correspond to the managed objects in IPFIX-MIB. REF:Optional[RFC 5101; RFC 6615, Section 8 (ipfixTransportSessionEntry, ipfixTransportSessionStatsEntry).]

optionsTemplateRefreshTimeout
integer <int64>
Default: 600

Sets time after which Options Templates are resent in the UDP Transport Session. Note that the configured lifetime MUST be adapted to the optionsTemplateLifeTime parameter value at the receiving Collecting Process. Note that this parameter corresponds to ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.6; RFC 6615, Section 8 (ipfixTransportSessionOptionsTemplateRefreshTimeout).]

destinationIPAddress
string

IP address of the Collection Process to which IPFIX Messages are sent.

templateRefreshPacket
integer <int64>

Sets number of IPFIX Messages after which Templates are resent in the UDP Transport Session. Note that this parameter corresponds to ipfixTransportSessionTemplateRefreshPacket in the IPFIX MIB module. If omitted, Templates are only resent after timeout. REF:Optional[RFC 5101, Section 10.3.6; RFC 6615, Section 8 (ipfixTransportSessionTemplateRefreshPacket).]

sourceIPAddress
string

Source IP address used by the Exporting Process. If not configured, the IP address assigned to the outgoing interface is used as source IP address.

optionsTemplateRefreshPacket
integer <int64>

Sets number of IPFIX Messages after which Options Templates are resent in the UDP Transport Session protocol. Note that this parameter corresponds to ipfixTransportSessionOptionsTemplateRefreshPacket in the IPFIX MIB module. If omitted, Templates are only resent after timeout. REF:Optional[RFC 5101, Section 10.3.6; RFC 6615, Section 8 (ipfixTransportSessionOptionsTemplateRefreshPacket).]

templateRefreshTimeout
integer <int64>
Default: 600

Sets time after which Templates are resent in the UDP Transport Session. Note that the configured lifetime MUST be adapted to the templateLifeTime parameter value at the receiving Collecting Process. Note that this parameter corresponds to ipfixTransportSessionTemplateRefreshTimeout in the IPFIX MIB module. REF:Optional[RFC 5101, Section 10.3.6; RFC 6615, Section 8 (ipfixTransportSessionTemplateRefreshTimeout).]

maxPacketSize
integer <int32>

This parameter specifies the maximum size of IP packets sent to the Collector. If set to zero, the Exporting Device MUST derive the maximum packet size from path MTU discovery mechanisms. If not configured by the user, this parameter is set by the Monitoring Device.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:destinationPort": 0,
  • "ietf-ipfix-psamp:ipfixVersion": 10,
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    },
  • "ietf-ipfix-psamp:ifIndex": 0,
  • "ietf-ipfix-psamp:rateLimit": 0,
  • "ietf-ipfix-psamp:sendBufferSize": 0,
  • "ietf-ipfix-psamp:ifName": "string",
  • "ietf-ipfix-psamp:transportSession": {
    },
  • "optionsTemplateRefreshTimeout": 600,
  • "destinationIPAddress": "string",
  • "templateRefreshPacket": 0,
  • "sourceIPAddress": "string",
  • "optionsTemplateRefreshPacket": 0,
  • "templateRefreshTimeout": 600,
  • "maxPacketSize": 0
}

creates or updates ietf.ipfix.psamp.UdpExporterParameters

UDP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.UdpExporterParameters to be added or updated

object (ietf.ipfix.psamp.UdpExporterParameters)

Parameters of en export destination that are common to all transport protocols.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:udpExporter": {
    }
}

removes ietf.ipfix.psamp.UdpExporterParameters

UDP parameters.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added to list

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

creates or updates ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.TransportLayerSecurityParameters to be added or updated

object (ietf.ipfix.psamp.TransportLayerSecurityParameters)

TLS or DTLS parameters.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportLayerSecurity": {
    }
}

removes ietf.ipfix.psamp.TransportLayerSecurityParameters

TLS or DTLS configuration.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter/transportLayerSecurity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.TransportSessionParameters

State parameters of the Transport Session directed to the given destination.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter/transportSession"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:transportSession": {
    }
}

returns ietf.ipfix.psamp.TemplateParameters

This list contains the Templates and Options Templates that are transmitted by the Exporting Process or received by the Collecting Process. Withdrawn or invalidated (Options) Templates MUST be removed from this list.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter/transportSession/template"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:template": {
    }
}

returns ietf.ipfix.psamp.templateparameters.Field

This list contains the (Options) Template fields of which the (Options) Template is defined. The order of the list corresponds to the order of the fields in the (Option) Template Record.

path Parameters
name
required
string

Id of exportingProcess

destination-name
required
string

Id of destination

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/destination=%7Bdestination-name%7D/udpExporter/transportSession/template/field"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:field": {
    }
}

creates ietf.ipfix.psamp.exportingprocessparameters.Options

List of options reported by the Exporting Process.

path Parameters
name
required
string

Id of exportingProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.exportingprocessparameters.Options to be added to list

ietf-ipfix-psamp:optionsType
string

Type of the exported options data.

ietf-ipfix-psamp:optionsTimeout
integer <int64>

Time interval for periodic export of the options data. If set to zero, the export is triggered when the options data has changed. If not configured by the user, this parameter is set by the Monitoring Device.

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:optionsType": "string",
  • "ietf-ipfix-psamp:optionsTimeout": 0,
  • "name": "string"
}

returns ietf.ipfix.psamp.exportingprocessparameters.Options

List of options reported by the Exporting Process.

path Parameters
name
required
string

Id of exportingProcess

options-name
required
string

Id of options

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/options=%7Boptions-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:options": {
    }
}

creates or updates ietf.ipfix.psamp.exportingprocessparameters.Options

List of options reported by the Exporting Process.

path Parameters
name
required
string

Id of exportingProcess

options-name
required
string

Id of options

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.exportingprocessparameters.Options to be added or updated

object (ietf.ipfix.psamp.exportingprocessparameters.Options)

Parameters specifying the data export using an Options Template.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:options": {
    }
}

removes ietf.ipfix.psamp.exportingprocessparameters.Options

List of options reported by the Exporting Process.

path Parameters
name
required
string

Id of exportingProcess

options-name
required
string

Id of options

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/exportingProcess=%7Bname%7D/options=%7Boptions-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.ipfix.ObservationPoint

Observation Point of the Monitoring Device.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.ObservationPoint to be added to list

ietf-ipfix-psamp:ifIndex
Array of integers <int64> [ items <int64 > ]

List of ifIndex values pointing to entries in the ifTable of the IF-MIB module maintained by the Monitoring Device. The Observation Point observes packets at the specified interfaces. This parameter SHOULD only be used if an SNMP agent enables access to the ifTable. Note that this parameter corresponds to ipfixObservationPointPhysicalInterface in the IPFIX MIB module. REF:Optional[RFC 2863; RFC 6615, Section 8 (ipfixObservationPointPhysicalInterface).]

ietf-ipfix-psamp:observationPointId
integer <int64>

Observation Point ID (i.e., the value of the Information Element observationPointId) assigned by the Monitoring Device. REF:Optional[IANA registry for IPFIX Entities, http://www.iana.org/assignments/ipfix.]

ietf-ipfix-psamp:entPhysicalName
Array of strings

List of names identifying physical entities of the Monitoring Device. The Observation Point observes packets at the specified entities.

ietf-ipfix-psamp:ifName
Array of strings

List of names identifying interfaces of the Monitoring Device. The Observation Point observes packets at the specified interfaces.

ietf-ipfix-psamp:observationDomainId
integer <int64>

The Observation Domain ID associates the Observation Point to an Observation Domain. Observation Points with identical Observation Domain IDs belong to the same Observation Domain. Note that this parameter corresponds to ipfixObservationPointObservationDomainId in the IPFIX MIB module. REF:Optional[RFC 5101; RFC 6615, Section 8 (ipfixObservationPointObservationDomainId).]

ietf-ipfix-psamp:entPhysicalIndex
Array of integers <int64> [ items <int64 > ]

List of entPhysicalIndex values pointing to entries in the entPhysicalTable of the ENTITY-MIB module maintained by the Monitoring Device. The Observation Point observes packets at the specified entities. This parameter SHOULD only be used if an SNMP agent enables access to the entPhysicalTable. Note that this parameter corresponds to ipfixObservationPointPhysicalEntity in the IPFIX MIB module. REF:Optional[RFC 4133; RFC 6615, Section 8 (ipfixObservationPointPhysicalInterface).]

ietf-ipfix-psamp:direction
string (ietf.ipfix.psamp.Direction)
Enum: "ingress" "egress" "both"
name
string

Key of this list.

selectionProcess
Array of strings

Selection Processes in this list process packets in parallel.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:ifIndex": [
    ],
  • "ietf-ipfix-psamp:observationPointId": 0,
  • "ietf-ipfix-psamp:entPhysicalName": [
    ],
  • "ietf-ipfix-psamp:ifName": [
    ],
  • "ietf-ipfix-psamp:observationDomainId": 0,
  • "ietf-ipfix-psamp:entPhysicalIndex": [
    ],
  • "ietf-ipfix-psamp:direction": "ingress",
  • "name": "string",
  • "selectionProcess": [
    ]
}

returns ietf.ipfix.psamp.ipfix.ObservationPoint

Observation Point of the Monitoring Device.

path Parameters
name
required
string

Id of observationPoint

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/observationPoint=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:observationPoint": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.ObservationPoint

Observation Point of the Monitoring Device.

path Parameters
name
required
string

Id of observationPoint

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.ObservationPoint to be added or updated

object (ietf.ipfix.psamp.ipfix.ObservationPoint)

Interface as input to Observation Point.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:observationPoint": {
    }
}

removes ietf.ipfix.psamp.ipfix.ObservationPoint

Observation Point of the Monitoring Device.

path Parameters
name
required
string

Id of observationPoint

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/observationPoint=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.ipfix.SelectionProcess

Selection Process of the Monitoring Device.

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.SelectionProcess to be added to list

name
string

Key of this list.

cache
string

Cache that receives the output of the Selection Process.

Array of objects (ietf.ipfix.psamp.ipfix.selectionprocess.SelectionSequence)

This list contains the Selection Sequence IDs that are assigned by the Monitoring Device to distinguish different Selection Sequences passing through the Selection Process. As Selection Sequence IDs are unique per Observation Domain, the corresponding Observation Domain IDs are included as well. With this information, it is possible to associate Selection Sequence (Statistics) Report Interpretations exported according to the PSAMP protocol with a Selection Process in the configuration data. REF:Optional[RFC 5476.]

Array of objects (ietf.ipfix.psamp.ipfix.selectionprocess.Selector)

List of Selectors that define the action of the Selection Process on a single packet. The Selectors are serially invoked in the same order as they appear in this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "name": "string",
  • "cache": "string",
  • "selectionSequence": [
    ],
  • "selector": [
    ]
}

returns ietf.ipfix.psamp.ipfix.SelectionProcess

Selection Process of the Monitoring Device.

path Parameters
name
required
string

Id of selectionProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectionProcess": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.SelectionProcess

Selection Process of the Monitoring Device.

path Parameters
name
required
string

Id of selectionProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.SelectionProcess to be added or updated

object (ietf.ipfix.psamp.ipfix.SelectionProcess)

Selection Process of the Monitoring Device.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectionProcess": {
    }
}

removes ietf.ipfix.psamp.ipfix.SelectionProcess

Selection Process of the Monitoring Device.

path Parameters
name
required
string

Id of selectionProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.ipfix.selectionprocess.SelectionSequence

This list contains the Selection Sequence IDs that are assigned by the Monitoring Device to distinguish different Selection Sequences passing through the Selection Process. As Selection Sequence IDs are unique per Observation Domain, the corresponding Observation Domain IDs are included as well. With this information, it is possible to associate Selection Sequence (Statistics) Report Interpretations exported according to the PSAMP protocol with a Selection Process in the configuration data.

path Parameters
name
required
string

Id of selectionProcess

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selectionSequence"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectionSequence": {
    }
}

creates ietf.ipfix.psamp.ipfix.selectionprocess.Selector

List of Selectors that define the action of the Selection Process on a single packet. The Selectors are serially invoked in the same order as they appear in this list.

path Parameters
name
required
string

Id of selectionProcess

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.selectionprocess.Selector to be added to list

ietf-ipfix-psamp:selectAll
string

Method that selects all packets.

object (ietf.ipfix.psamp.FilterMatchParameters)

Configuration parameters of a Selector applying property match Filtering to the packet stream. The field to be matched is specified as an Information Element. REF:Optional[RFC 5475, Section 6.1; RFC 5476, Section 6.5.2.5.]

object (ietf.ipfix.psamp.SampCountBasedParameters)

Configuration parameters of a Selector applying systematic count-based packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.1.]

ietf-ipfix-psamp:packetsObserved
integer <int32>

The number of packets observed at the input of the Selector. If this is the first Selector in the Selection Process, this counter corresponds to the total number of packets in all Observed Packet Streams at the input of the Selection Process. Otherwise, the counter corresponds to the total number of packets at the output of the preceding Selector. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of selectorDiscontinuityTime. Note that this parameter corresponds to ipfixSelectorStatsPacketsObserved in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixSelectorStatsPacketsObserved).]

object (ietf.ipfix.psamp.SampTimeBasedParameters)

Configuration parameters of a Selector applying systematic time-based packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.2.]

object (ietf.ipfix.psamp.SampRandOutOfNParameters)

Configuration parameters of a Selector applying n-out-of-N packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.2.1; RFC 5476, Section 6.5.2.3.]

ietf-ipfix-psamp:selectorDiscontinuityTime
string

Timestamp of the most recent occasion at which one or more of the Selector counters suffered a discontinuity. Note that this parameter functionally corresponds to ipfixSelectionProcessStatsDiscontinuityTime in the IPFIX MIB module. In contrast to ipfixSelectionProcessStatsDiscontinuityTime, the time is absolute and not relative to sysUpTime. REF:Optional[RFC 6615, Section 8 (ipfixSelectionProcessStatsDiscontinuityTime).]

ietf-ipfix-psamp:packetsDropped
integer <int32>

The total number of packets discarded by the Selector. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of selectorDiscontinuityTime. Note that this parameter corresponds to ipfixSelectorStatsPacketsDropped in the IPFIX MIB module. REF:Optional[RFC 6615, Section 8 (ipfixSelectorStatsPacketsDropped).]

object (ietf.ipfix.psamp.FilterHashParameters)

Configuration parameters of a Selector applying hash-based Filtering to the packet stream. REF:Optional[RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.]

object (ietf.ipfix.psamp.SampUniProbParameters)

Configuration parameters of a Selector applying uniform probabilistic packet Sampling (with equal probability per packet) to the packet stream. REF:Optional[RFC 5475, Section 5.2.2.1; RFC 5476, Section 6.5.2.4.]

name
string

Key of this list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectAll": "string",
  • "ietf-ipfix-psamp:filterMatch": {
    },
  • "ietf-ipfix-psamp:sampCountBased": {
    },
  • "ietf-ipfix-psamp:packetsObserved": 0,
  • "ietf-ipfix-psamp:sampTimeBased": {
    },
  • "ietf-ipfix-psamp:sampRandOutOfN": {
    },
  • "ietf-ipfix-psamp:selectorDiscontinuityTime": "string",
  • "ietf-ipfix-psamp:packetsDropped": 0,
  • "ietf-ipfix-psamp:filterHash": {
    },
  • "ietf-ipfix-psamp:sampUniProb": {
    },
  • "name": "string"
}

returns ietf.ipfix.psamp.ipfix.selectionprocess.Selector

List of Selectors that define the action of the Selection Process on a single packet. The Selectors are serially invoked in the same order as they appear in this list.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selector": {
    }
}

creates or updates ietf.ipfix.psamp.ipfix.selectionprocess.Selector

List of Selectors that define the action of the Selection Process on a single packet. The Selectors are serially invoked in the same order as they appear in this list.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.ipfix.selectionprocess.Selector to be added or updated

object (ietf.ipfix.psamp.ipfix.selectionprocess.Selector)

Configuration and state parameters of a Selector.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selector": {
    }
}

removes ietf.ipfix.psamp.ipfix.selectionprocess.Selector

List of Selectors that define the action of the Selection Process on a single packet. The Selectors are serially invoked in the same order as they appear in this list.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.FilterHashParameters

Hash-based Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterHash"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:filterHash": {
    }
}

creates ietf.ipfix.psamp.FilterHashParameters

Hash-based Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FilterHashParameters to be added to list

ietf-ipfix-psamp:outputRangeMax
integer <int32>

End of the hash function's potential range. This parameter corresponds to the Information Element hashOutputRangeMax and to psampFiltHashOutputRangeMax in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.5; RFC 6727, Section 6 (psampFiltHashOutputRangeMax).]

ietf-ipfix-psamp:hashFunction
string
Default: "BOB"

Hash function to be applied. According to RFC 5475, Section 6.2.4.1, 'BOB' must be used in order to be compliant with PSAMP. This parameter functionally corresponds to psampFiltHashFunction in the PSAMP MIB module. REF:Optional[RFC 6727, Section 6 (psampFiltHashFunction)]

Array of objects (ietf.ipfix.psamp.filterhashparameters.SelectedRange)

List of hash function return ranges for which packets are selected.

ietf-ipfix-psamp:ipPayloadSize
integer <int32>
Default: 8

Number of IP payload bytes used as input to the hash function, counted from the payload offset. If the IP payload is shorter than the payload range, all available payload octets are used as input. Default value 8 corresponds to the minimum IP payload size that must be configurable according to RFC 5476, Section 6.5.2.6. This parameter corresponds to the Information Element hashIPPayloadSize and to psampFiltHashIpPayloadSize in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.3; RFC 6727, Section 6 (psampFiltHashIpPayloadSize).]

ietf-ipfix-psamp:initializerValue
integer <int32>

Initializer value to the hash function. If not configured by the user, the Monitoring Device arbitrarily chooses an initializer value. This parameter corresponds to the Information Element hashInitialiserValue and to psampFiltHashInitializerValue in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.9; RFC 6727, Section 6 (psampFiltHashInitializerValue).]

ietf-ipfix-psamp:digestOutput
boolean
Default: false

If true, the output from this Selector is included in the Packet Report as a packet digest. Therefore, the configured Cache Layout needs to contain a digestHashValue field. This parameter corresponds to the Information Element hashDigestOutput. REF:Optional[RFC 5477, Section 8.3.8.]

ietf-ipfix-psamp:ipPayloadOffset
integer <int32>
Default: 0

IP payload offset indicating the position of the first payload byte considered as input to the hash function. Default value 0 corresponds to the minimum offset that must be configurable according to RFC 5476, Section 6.5.2.6. This parameter corresponds to the Information Element hashIPPayloadOffset and to psampFiltHashIpPayloadOffset in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.2; RFC 6727, Section 6 (psampFiltHashIpPayloadOffset).]

ietf-ipfix-psamp:outputRangeMin
integer <int32>

Beginning of the hash function's potential range. This parameter corresponds to the Information Element hashOutputRangeMin and to psampFiltHashOutputRangeMin in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.4; RFC 6727, Section 6 (psampFiltHashOutputRangeMin).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:outputRangeMax": 0,
  • "ietf-ipfix-psamp:hashFunction": "BOB",
  • "ietf-ipfix-psamp:selectedRange": [
    ],
  • "ietf-ipfix-psamp:ipPayloadSize": 8,
  • "ietf-ipfix-psamp:initializerValue": 0,
  • "ietf-ipfix-psamp:digestOutput": false,
  • "ietf-ipfix-psamp:ipPayloadOffset": 0,
  • "ietf-ipfix-psamp:outputRangeMin": 0
}

creates or updates ietf.ipfix.psamp.FilterHashParameters

Hash-based Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FilterHashParameters to be added or updated

object (ietf.ipfix.psamp.FilterHashParameters)

Configuration parameters of a Selector applying hash-based Filtering to the packet stream. REF:Optional[RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:filterHash": {
    }
}

removes ietf.ipfix.psamp.FilterHashParameters

Hash-based Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterHash"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates ietf.ipfix.psamp.filterhashparameters.SelectedRange

List of hash function return ranges for which packets are selected.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.filterhashparameters.SelectedRange to be added to list

ietf-ipfix-psamp:name
string

Key of this list.

ietf-ipfix-psamp:max
integer <int32>

End of the hash function's selected range. This parameter corresponds to the Information Element hashSelectedRangeMax and to psampFiltHashSelectedRangeMax in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.7; RFC 6727, Section 6 (psampFiltHashSelectedRangeMax).]

ietf-ipfix-psamp:min
integer <int32>

Beginning of the hash function's selected range. This parameter corresponds to the Information Element hashSelectedRangeMin and to psampFiltHashSelectedRangeMin in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.3.6; RFC 6727, Section 6 (psampFiltHashSelectedRangeMin).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:name": "string",
  • "ietf-ipfix-psamp:max": 0,
  • "ietf-ipfix-psamp:min": 0
}

returns ietf.ipfix.psamp.filterhashparameters.SelectedRange

List of hash function return ranges for which packets are selected.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

selectedRange-name
required
string

Id of selectedRange

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterHash/selectedRange=%7BselectedRange-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectedRange": {
    }
}

creates or updates ietf.ipfix.psamp.filterhashparameters.SelectedRange

List of hash function return ranges for which packets are selected.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

selectedRange-name
required
string

Id of selectedRange

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.filterhashparameters.SelectedRange to be added or updated

object (ietf.ipfix.psamp.filterhashparameters.SelectedRange)

List of hash function return ranges for which packets are selected.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:selectedRange": {
    }
}

removes ietf.ipfix.psamp.filterhashparameters.SelectedRange

List of hash function return ranges for which packets are selected.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

selectedRange-name
required
string

Id of selectedRange

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterHash/selectedRange=%7BselectedRange-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.FilterMatchParameters

Property match Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterMatch"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:filterMatch": {
    }
}

creates ietf.ipfix.psamp.FilterMatchParameters

Property match Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FilterMatchParameters to be added to list

ietf-ipfix-psamp:ieEnterpriseNumber
integer <int64>
Default: 0

If this parameter is zero, the Information Element is registered in the IANA registry of IPFIX Information Elements. If this parameter is configured with a non-zero private enterprise number, the Information Element is enterprise-specific. REF:Optional[IANA registry for Private Enterprise Numbers, http://www.iana.org/assignments/enterprise-numbers; IANA registry for IPFIX Entities, http://www.iana.org/assignments/ipfix.]

ietf-ipfix-psamp:value
string

Matching value of the Information Element.

ietf-ipfix-psamp:ieId
integer <int32>

Identifier of the Information Element.

ietf-ipfix-psamp:ieName
string

Name of the Information Element.

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:ieEnterpriseNumber": 0,
  • "ietf-ipfix-psamp:value": "string",
  • "ietf-ipfix-psamp:ieId": 0,
  • "ietf-ipfix-psamp:ieName": "string"
}

creates or updates ietf.ipfix.psamp.FilterMatchParameters

Property match Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.FilterMatchParameters to be added or updated

object (ietf.ipfix.psamp.FilterMatchParameters)

Configuration parameters of a Selector applying property match Filtering to the packet stream. The field to be matched is specified as an Information Element. REF:Optional[RFC 5475, Section 6.1; RFC 5476, Section 6.5.2.5.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:filterMatch": {
    }
}

removes ietf.ipfix.psamp.FilterMatchParameters

Property match Filtering.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/filterMatch"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.SampCountBasedParameters

Systematic count-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampCountBased"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampCountBased": {
    }
}

creates ietf.ipfix.psamp.SampCountBasedParameters

Systematic count-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampCountBasedParameters to be added to list

ietf-ipfix-psamp:packetInterval
integer <int64>

The number of packets that are consecutively sampled between gaps of length packetSpace. This parameter corresponds to the Information Element samplingPacketInterval and to psampSampCountBasedInterval in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.2; RFC 6727, Section 6 (psampSampCountBasedInterval).]

ietf-ipfix-psamp:packetSpace
integer <int64>

The number of unsampled packets between two Sampling intervals. This parameter corresponds to the Information Element samplingPacketSpace and to psampSampCountBasedSpace in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.3; RFC 6727, Section 6 (psampSampCountBasedSpace).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:packetInterval": 0,
  • "ietf-ipfix-psamp:packetSpace": 0
}

creates or updates ietf.ipfix.psamp.SampCountBasedParameters

Systematic count-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampCountBasedParameters to be added or updated

object (ietf.ipfix.psamp.SampCountBasedParameters)

Configuration parameters of a Selector applying systematic count-based packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.1.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampCountBased": {
    }
}

removes ietf.ipfix.psamp.SampCountBasedParameters

Systematic count-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampCountBased"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.SampRandOutOfNParameters

n-out-of-N packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampRandOutOfN"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampRandOutOfN": {
    }
}

creates ietf.ipfix.psamp.SampRandOutOfNParameters

n-out-of-N packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampRandOutOfNParameters to be added to list

ietf-ipfix-psamp:size
integer <int64>

The number of elements taken from the parent population. This parameter corresponds to the Information Element samplingSize and to psampSampRandOutOfNSize in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.6; RFC 6727, Section 6 (psampSampRandOutOfNSize).]

ietf-ipfix-psamp:population
integer <int64>

The number of elements in the parent population. This parameter corresponds to the Information Element samplingPopulation and to psampSampRandOutOfNPopulation in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.7; RFC 6727, Section 6 (psampSampRandOutOfNPopulation).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:size": 0,
  • "ietf-ipfix-psamp:population": 0
}

creates or updates ietf.ipfix.psamp.SampRandOutOfNParameters

n-out-of-N packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampRandOutOfNParameters to be added or updated

object (ietf.ipfix.psamp.SampRandOutOfNParameters)

Configuration parameters of a Selector applying n-out-of-N packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.2.1; RFC 5476, Section 6.5.2.3.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampRandOutOfN": {
    }
}

removes ietf.ipfix.psamp.SampRandOutOfNParameters

n-out-of-N packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampRandOutOfN"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.SampTimeBasedParameters

Systematic time-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampTimeBased"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampTimeBased": {
    }
}

creates ietf.ipfix.psamp.SampTimeBasedParameters

Systematic time-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampTimeBasedParameters to be added to list

ietf-ipfix-psamp:timeInterval
integer <int64>

The time interval in microseconds during which all arriving packets are sampled between gaps of length timeSpace. This parameter corresponds to the Information Element samplingTimeInterval and to psampSampTimeBasedInterval in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.4; RFC 6727, Section 6 (psampSampTimeBasedInterval).]

ietf-ipfix-psamp:timeSpace
integer <int64>

The time interval in microseconds during which no packets are sampled between two Sampling intervals specified by timeInterval. This parameter corresponds to the Information Element samplingTimeInterval and to psampSampTimeBasedSpace in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.5; RFC 6727, Section 6 (psampSampTimeBasedSpace).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:timeInterval": 0,
  • "ietf-ipfix-psamp:timeSpace": 0
}

creates or updates ietf.ipfix.psamp.SampTimeBasedParameters

Systematic time-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampTimeBasedParameters to be added or updated

object (ietf.ipfix.psamp.SampTimeBasedParameters)

Configuration parameters of a Selector applying systematic time-based packet Sampling to the packet stream. REF:Optional[RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.2.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampTimeBased": {
    }
}

removes ietf.ipfix.psamp.SampTimeBasedParameters

Systematic time-based packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampTimeBased"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns ietf.ipfix.psamp.SampUniProbParameters

Uniform probabilistic packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampUniProb"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampUniProb": {
    }
}

creates ietf.ipfix.psamp.SampUniProbParameters

Uniform probabilistic packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampUniProbParameters to be added to list

ietf-ipfix-psamp:probability
integer <int32>

Probability that a packet is sampled, expressed as a value between 0 and 1. The probability is equal for every packet. This parameter corresponds to the Information Element samplingProbability and to psampSampUniProbProbability in the PSAMP MIB module. REF:Optional[RFC 5477, Section 8.2.8; RFC 6727, Section 6 (psampSampUniProbProbability).]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:probability": 0
}

creates or updates ietf.ipfix.psamp.SampUniProbParameters

Uniform probabilistic packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Request Body schema: application/yang-data+json

ietf.ipfix.psamp.SampUniProbParameters to be added or updated

object (ietf.ipfix.psamp.SampUniProbParameters)

Configuration parameters of a Selector applying uniform probabilistic packet Sampling (with equal probability per packet) to the packet stream. REF:Optional[RFC 5475, Section 5.2.2.1; RFC 5476, Section 6.5.2.4.]

Responses

Request samples

Content type
application/yang-data+json
{
  • "ietf-ipfix-psamp:sampUniProb": {
    }
}

removes ietf.ipfix.psamp.SampUniProbParameters

Uniform probabilistic packet Sampling.

path Parameters
name
required
string

Id of selectionProcess

selector-name
required
string

Id of selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/ietf-ipfix-psamp:ipfix/selectionProcess=%7Bname%7D/selector=%7Bselector-name%7D/sampUniProb"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}