Published On: August 6ᵗʰ, 2019 02:13

API Reference for Cisco Enterprise Network Function Virtualization Infrastructure Software

System Monitoring APIs

The system monitoring APIs are used to get statistics on the host and VNFs running on the host. These statistics are used by the portal for pictorial representation. These statistics are collected over a specified duration. For large durations, average values are returned. The default duration for all host and VNF queries is set to five minutes. If data is not available for a particular interval during the specified duration, the API returns "na" (not available) for that interval.

Host CPU Stats APIs

Table 1. Host CPU Stats APIs

Action

Method

Payload Required

API

To get the host CPU utilization of a CPU state

GET

No

  • /api/operational/system-monitoring/host/cpu/stats

  • /api/operational/system-monitoring/host/cpu/stats/cpu-usage?deep

  • /api/operational/system-monitoring/host/cpu/stats

    /cpu-usage/<duration>,<cpu-state>?deep

Valid duration: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host CPU Stats API 


curl -k -v -u "admin:admin" -X GET https://192.0.2.2/api/operational/system-monitoring/host/cpu/stats/cpu-usage/5min,non-idle?deep
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 192.0.2.2...
* Connected to 192.0.2.2 (192.0.2.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 3 05:02:29 2017 GMT
* expire date: Feb 1 05:02:29 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/cpu/stats/cpu-usage/5min,non-idle?deep HTTP/1.1
> Host: 192.0.2.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept:application/vnd.yang.data+xml
> Content-Type:application/vnd.yang.data+xml
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Tue, 07 Feb 2017 03:44:43 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<cpu-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <state>non-idle</state>
 <collect-start-date-time>2017-02-07T03:39:40-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <cpu>
 <id>0</id>
 <usage-percentage>[1.62, 1.16, 1.22, 1.44, 1.41, 1.46, 1.63, 1.82, 3.77, 2.61, 0.94, 1.32, 1.36, 1.14, 1.34, 1.38, 2.75, 2.33, 1.4, 1.28, 1.2, 1.26, 1.42, 1.44, 1.76, 1.22, 1.0, 1.32, 1.16]</usage-percentage>
 </cpu>
 <cpu>
 <id>1</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>2</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>3</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>4</id>
 <usage-percentage>[29.91, 20.67, 5.82, 0.38, 0.25, 0.1, 0.25, 0.88, 5.72, 7.48, 6.58, 7.37, 12.95, 17.53, 19.24, 20.78]</usage-percentage>
 </cpu>
 <cpu>
 <id>5</id>
 <usage-percentage>[0.0, 0.06, 0.04, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>6</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.07, 0.04, 0.0, 0.0, 0.0, 0.0, 0.0, 0.13, 0.09, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>7</id>
 <usage-percentage>[2.14, 4.37, 8.71, 5.46, 2.14, 2.22, 2.16, 2.05, 6.19, 4.8, 2.01, 2.2, 2.01, 1.99, 2.37, 2.47, 2.23, 2.23, 2.33, 2.39, 2.49, 2.29, 2.24, 2.14, 2.01, 2.01, 2.33, 2.47, 3.5]</usage-percentage>
 </cpu>
 <cpu>
 <id>8</id>
 <usage-percentage>[1.44, 1.26, 1.54, 1.88, 1.58, 1.36, 3.81, 5.12, 2.87, 1.51, 1.56, 1.72, 1.68, 1.6, 1.55, 1.38]</usage-percentage>
 </cpu>
 <cpu>
 <id>9</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>10</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>11</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>12</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>13</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>14</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
 <cpu>
 <id>15</id>
 <usage-percentage>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</usage-percentage>
 </cpu>
</cpu-usage>
Table 2. Field Description for Host CPU Stats API Response

duration

Required duration

usage-percentage

It is the percentage of CPU used for the requested state.

state

CPU state

The allowed CPU states are: non-idle, interrupt, nice, system, user, and wait.

Host CPU Table API

Table 3. Host CPU Table APIs

Action

Method

Payload Required

API

To get the host CPU utilization statistics table (minimum, maximum, and average) of all CPU states on each of the CPUs

GET

No

  • /api/operational/system-monitoring/host/cpu/table

  • /api/operational/system-monitoring/host/cpu/table?deep

  • /api/operational/system-monitoring/host/cpu/table/cpu-usage

  • /api/operational/system-monitoring/host/cpu/table/cpu-usage?deep

  • /api/operational/system-monitoring/host

    /cpu/table/cpu-usage/<duration>? deep

Valid duration: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host CPU Table API 


 curl -k -v -u admin:Cisco123# -X GET 'https://172.19.162.209/api/operational/system-monitoring/host/cpu/table/cpu-usage/1h?deep'
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 172.19.162.209...
* Connected to 172.19.162.209 (172.19.162.209) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 3 05:02:29 2017 GMT
* expire date: Feb 1 05:02:29 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/cpu/table/cpu-usage/1h?deep HTTP/1.1
> Host: 172.19.162.209
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
>< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Tue, 07 Feb 2017 04:10:56 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<


<cpu-usage
        xmlns="http://www.cisco.com/nfvos/system-monitoring"
        xmlns:y="http://tail-f.com/ns/rest"
        xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
        <duration>1h</duration>
        <cpu>
                <id>0</id>
                <states>
                        <state>non-idle</state>
                        <min-percentage>0.9</min-percentage>
                        <max-percentage>13.56</max-percentage>
                        <average-percentage>1.72</average-percentage>
                </states>
                <states>
                        <state>interrupt</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>nice</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.06</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>softirq</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.18</max-percentage>
                        <average-percentage>0.01</average-percentage>
                </states>
                <states>
                        <state>steal</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>system</state>
                        <min-percentage>0.36</min-percentage>
                        <max-percentage>5.69</max-percentage>
                        <average-percentage>0.72</average-percentage>
                </states>
                <states>
                        <state>user</state>
                        <min-percentage>0.34</min-percentage>
                        <max-percentage>5.68</max-percentage>
                        <average-percentage>0.65</average-percentage>
                </states>
                <states>
                        <state>wait</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>2.64</max-percentage>
                        <average-percentage>0.35</average-percentage>
                </states>
        </cpu>

...


        <cpu>
                <id>15</id>
                <states>
                        <state>non-idle</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>interrupt</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>nice</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>softirq</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>steal</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>system</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>user</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
                <states>
                        <state>wait</state>
                        <min-percentage>0.0</min-percentage>
                        <max-percentage>0.0</max-percentage>
                        <average-percentage>0.0</average-percentage>
                </states>
        </cpu>
</cpu-usage>
Table 4. Field Description for Host CPU Table API Response

Field

Description

duration

Duration of this collection

cpu states

Indicates the CPU state. This can be non-idle, interrupt, nice, soft interrupt request line (IRQ), steal, system, user and wait.

cpu states min-percentage

Minimum percentage of CPU usage

cpu states max-percentage

Maximum percentage of CPU usage

cpu states average-percentage

Average percentage of CPU usage

Host Disk Stats APIs

Table 5. Host Disk Stats APIs

Action

Method

Payload Required

API

To get arrays of utilizations (per type) for the list of disks or disk partitions on the host server

GET

No

  • /api/operational/system-monitoring/host/disk

  • /api/operational/system-monitoring/host/disk/stats

  • /api/operational/system-monitoring/host/disk/stats?deep

  • /api/operational/system-monitoring/host

    /disk/stats/disk-operations?deep

  • /api/operational/system-monitoring/host

    /disk/stats/disk-operations/<duration>?deep

  • /api/operational/system-monitoring/host

    /disk/stats/disk-space?deep

    /api/operational/system-monitoring/host

    /disk/stats/disk-space/<duration>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host Disk Stats API

Example 1: disk-operations


curl -k -v -u "admin:admin" -X GET "https://209.165.201.2/api/operational/system-monitoring/host/disk/stats/disk-operations/5min?deep
<
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/disk/stats/disk-operations/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 05:56:14 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<disk-operations xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <collect-start-date-time>2017-02-22T05:51:10-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <disk>
 <name>disk-sda</name>
 <io-time-ms>[45.3, 37.5, 117.98, 137.86, 27.6, 30.58, 13.14, 13.22, 25.46, 26.48, 15.62, 27.14, 30.62, 15.68,
 18.68, 78.0, 147.2, 102.5, 44.86, 27.0, 23.66, 15.22, 30.22, 30.16, 15.24, 15.62]</io-time-ms>
 <io-time-weighted-ms>[1986.62, 2263.14, 12979.04, 15663.62, 477.62, 660.3, 17.74, 33.28, 355.26, 484.1,
 27.18, 415.68, 596.6, 27.32, 501.26, 7602.3, 16598.74, 9846.72, 708.42, 359.36, 360.22, 21.82, 407.72, 587.76, 21.3, 21.84]</io-time-weighted-ms>
 <merged-reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</merged-reads-per-sec>
 <merged-writes-per-sec>[5.26, 2.46, 2.72, 2.4, 1.68, 2.28, 1.94, 2.14, 2.28, 1.54, 2.12, 3.5, 4.88, 4.88, 
3.36, 3.58, 3.7, 2.58, 3.4, 2.82, 1.96, 1.94, 2.42, 2.1, 3.02]</merged-writes-per-sec>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[92897.28, 112394.24, 356515.84, 375029.76, 29163.52, 33669.12, 14008.32, 18186.24, 
31703.04, 31293.44, 15319.04, 36864.0, 49971.2, 28344.32, 49397.76, 224952.32, 414023.68, 268615.68, 
58081.28, 33341.44, 27279.36, 14336.0, 35225.6, 40550.4, 22364.16, 23101.44, 40878.08]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[14.66, 19.14, 67.56, 72.26, 5.1, 5.52, 1.12, 1.72, 4.96, 5.4, 1.52, 4.92, 6.18, 1.5, 7.14, 41.76, 
78.92, 49.64, 7.56, 4.54, 4.16, 1.28, 5.24, 6.5]</writes-per-sec>
 <time-per-read-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</time-per-read-ms>
 <time-per-write-ms>[128.4, 109.58, 164.04, 141.78, 66.52, 84.36, 15.76, 17.36, 52.06, 63.96, 17.04, 54.6, 70.24, 18.18, 42.06, 
131.5, 210.24, 164.54, 68.04, 57.46, 75.28, 16.88, 48.7, 64.12, 16.4, 16.74, 48.94]</time-per-write-ms>
 <pending-ops>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 20.8, 31.2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.4]</pending-ops>
 </disk>
 <disk>
 <name>disk-sda1</name>
 <io-time-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</io-time-ms>
 <io-time-weighted-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0]</io-time-weighted-ms>
 <merged-reads-per-sec></merged-reads-per-sec>
 <merged-writes-per-sec></merged-writes-per-sec>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</writes-per-sec>
 <time-per-read-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0]</time-per-read-ms>
 <time-per-write-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</time-per-write-ms>
 <pending-ops></pending-ops>
 </disk>
 <disk>
 <name>disk-sda2</name>
 <io-time-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</io-time-ms>
 <io-time-weighted-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</io-time-weighted-ms>
 <merged-reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</merged-reads-per-sec>
 <merged-writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</merged-writes-per-sec>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</writes-per-sec>
 <time-per-read-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</time-per-read-ms>
 <time-per-write-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</time-per-write-ms>
 <pending-ops></pending-ops>
 </disk>
 <disk>
 <name>disk-sda3</name>
 <io-time-ms>[45.3, 37.5, 117.98, 137.86, 27.6, 30.58, 13.14, 13.22, 25.46, 26.48, 15.62, 27.14, 30.62, 15.68, 18.68, 
78.0, 147.2, 102.5, 44.86, 27.0, 23.66, 15.22, 30.22, 30.16, 15.24, 15.62]</io-time-ms>
 <io-time-weighted-ms>[1986.62, 2263.14, 12979.04, 15663.62, 477.62, 660.3, 17.74, 33.28, 355.26, 484.1, 27.18, 
415.68, 596.6, 27.32, 501.26, 7602.3, 16598.74, 9846.72, 708.42, 359.36, 360.22, 21.82, 407.72, 587.76, 21.3, 21.84]</io-time-weighted-ms>
 <merged-reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</merged-reads-per-sec>
 <merged-writes-per-sec>[5.26, 2.46, 2.72, 2.4, 1.68, 2.28, 1.94, 2.14, 2.28, 1.54, 2.12, 3.5, 4.88, 4.88, 3.36, 3.58, 
3.7, 2.58, 3.4, 2.82, 1.96, 1.94, 2.42, 2.1, 3.02, 3.74, 4.58]</merged-writes-per-sec>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[92897.28, 112394.24, 356515.84, 375029.76, 29163.52, 33669.12, 14008.32, 18186.24, 31703.04, 
31293.44, 15319.04, 36864.0, 49971.2, 28344.32, 49397.76, 224952.32, 414023.68, 268615.68, 58081.28, 33341.44, 27279.36, 
14336.0, 35225.6, 40550.4, 22364.16, 23101.44]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[14.66, 19.14, 67.56, 72.26, 5.1, 5.52, 1.12, 1.72, 4.96, 5.4, 1.52, 4.92, 6.18, 1.5, 7.14, 41.76, 
78.92, 49.64, 7.56, 4.54, 4.16, 1.28, 5.24, 6.5, 1.3, 1.32]</writes-per-sec>
 <time-per-read-ms>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</time-per-read-ms>
 <time-per-write-ms>[128.4, 109.58, 164.04, 141.78, 66.52, 84.36, 15.76, 17.36, 52.06, 63.96, 17.04, 54.6, 70.24, 18.18, 
42.06, 131.5, 210.24, 164.54, 68.04, 57.46, 75.28, 16.88, 48.7, 64.12, 16.4, 16.74]</time-per-write-ms>
 <pending-ops>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 20.8, 
31.2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.4]</pending-ops>
 </disk>
</disk-operations>
Table 6. Field Description for Host Disk Stats API Response

Field

Description

io-time-ms

Time spent doing I/Os in milliseconds

io-time-weighted-ms

Measure of both I/O completion time and the backlog that may be accumulating.

merged-reads-per-sec

The number of read operations that could be merged into already queued operations, that is one physical disk access served two or more logical operations.

merged-writes-per-sec

The number of write operations that could be merged into other already queued operations, that is one physical disk access served two or more logical operations.

bytes-read-per-sec

Bytes read per second

bytes-written-per-sec

Bytes written per second

reads-per-sec

Number of read operations per second.

writes-per-sec

Number of write operations per second

time-per-read-ms

The average time a read operation took to complete

time-per-write-ms

The average time a write operation took to complete

time-per-write-ms

The average time a write operation took to complete

pending-ops

The queue size of pending I/O operations

Example 2: disk-space


curl -k -v -u admin:Cisco123# -X GET https://209.165.201.2/api/operational/system-monitoring/host/disk/stats/disk-space/5min?deep
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/disk/stats/disk-space/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 05:59:38 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<disk-space xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <collect-start-date-time>2017-02-22T05:54:30-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <mount-point>
 <name>/boot</name>
 <free-GB>[0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33, 0.33]</free-GB>
 <used-GB>[0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1]</used-GB>
 <reserved-GB>[0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03]</reserved-GB>
 </mount-point>
 <mount-point>
 <name>/data</name>
 <free-GB>[849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 
849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26, 849.26]</free-GB>
 <used-GB>[3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09, 3.09]</used-GB>
 <reserved-GB>[45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 
45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64, 45.64]</reserved-GB>
 </mount-point>
 <mount-point>
 <name>/home</name>
 <free-GB>[0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43, 0.43]</free-GB>
 <used-GB>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</used-GB>
 <reserved-GB>[0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03, 0.03]</reserved-GB>
 </mount-point>
 <mount-point>
 <name>/</name>
 <free-GB>[5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69, 5.69]</free-GB>
 <used-GB>[1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65, 1.65]</used-GB>
 <reserved-GB>[0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42, 0.42]</reserved-GB>
 </mount-point>
 <mount-point>
 <name>/var</name>
 <free-GB>[1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55, 1.55]</free-GB>
 <used-GB>[0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24, 0.24]</used-GB>
 <reserved-GB>[0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12]</reserved-GB>
 </mount-point>
</disk-space>

This API response provides information about the disk name and data for various disk usage types.

Table 7. Field Description for Host Disk Stats API Response

Field

Description

free-GB

Gigabytes available

used-GB

Gigabytes in use

reserved-GB

Gigabytes reserved for the root user

Host Memory Stats APIs

Table 8. Host Memory Statistics APIs

Action

Method

Payload Required

API

To get the host memory utilization

GET

No

  • /api/operational/system-monitoring/host/memory

  • /api/operational/system-monitoring/host/memory?deep

  • /api/operational/system-monitoring/host/memory/stats/mem-usage

  • /api/operational/system-monitoring/host/memory/stats/mem-usage?deep

  • /api/operational/system-monitoring/host

    /memory/stats/mem-usage/<duration>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host Memory Stats API


curl -k -v -u admin:Cisco123# -X GET 'https://172.19.162.209/api/operational/system-monitoring/host/memory/stats/mem-usage/5min?deep'
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 172.19.162.209...
* Connected to 172.19.162.209 (172.19.162.209) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 3 05:02:29 2017 GMT
* expire date: Feb 1 05:02:29 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/memory/stats/mem-usage/5min?deep HTTP/1.1
> Host: 172.19.162.209
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Tue, 07 Feb 2017 04:24:45 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<

<mem-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <collect-start-date-time>2017-02-07T04:19:40-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <buffered-MB>[16.2, 16.21, 16.22, 16.24, 16.26, 16.27, 16.28, 16.3, 16.32, 16.33, 16.35, 16.36, 16.38, 16.39, 16.4, 16.41, 16.44, 16.46, 16.47, 16.48, 16.5, 16.52, 16.53, 16.54, 16.56, 16.57, 16.58, 16.6, 16.61, 16.62]</buffered-MB>
 <cached-MB>[3730.54, 3730.55, 3730.55, 3730.56, 3730.56, 3730.57, 3730.58, 3730.58, 3730.58, 3730.59, 3730.59, 3730.6, 3730.6, 3730.61, 3730.62, 3730.62, 3730.62, 3730.63, 3730.63, 3730.64, 3730.66, 3730.81, 3730.92, 3730.94, 3731.07, 3731.18, 3731.24, 3731.3, 3731.36, 3731.38]</cached-MB>
 <free-MB>[54090.05, 54089.9, 54089.84, 54089.93, 54089.81, 54089.7, 54089.67, 54089.67, 54089.7, 54089.62, 54089.66, 54089.72, 54089.63, 54089.51, 54089.44, 54089.36, 54089.46, 54089.57, 54089.14, 54088.85, 54088.3, 54087.94, 54088.17, 54076.76, 54080.71, 54088.02, 54087.82, 54087.59, 54087.54, 54087.69]</free-MB>
 <used-MB>[6086.81, 6086.9, 6086.98, 6086.8, 6086.76, 6086.8, 6086.78, 6086.85, 6086.86, 6086.83, 6086.67, 6086.55, 6086.68, 6086.83, 6086.86, 6086.84, 6086.75, 6086.67, 6087.09, 6087.36, 6087.83, 6088.08, 6087.79, 6099.19, 6095.12, 6087.67, 6087.74, 6087.86, 6087.84, 6087.66]</used-MB>
 <slab-recl-MB>[186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79, 186.79]</slab-recl-MB>
 <slab-unrecl-MB>[52.04, 52.08, 52.05, 52.11, 52.24, 52.3, 52.33, 52.24, 52.17, 52.26, 52.37, 52.41, 52.35, 52.3, 52.32, 52.4, 52.37, 52.3, 52.31, 52.31, 52.35, 52.28, 52.22, 52.2, 52.18, 52.2, 52.25, 52.29, 52.29]</slab-unrecl-MB>
</mem-usage>
This API response provides usage information for the following memory types:

  • Buffered

  • Cached

  • Free

  • Used

  • Slab recl

  • Slab unrecl

Host Memory Table APIs

Table 9. Host Memory Table APIs

Action

Method

Payload Required

API

To get the host memory utilization in tabular format (minimum, maximum, and average) for each memory type

GET

No

  • /api/operational/system-monitoring/host/memory/table

  • /api/operational/system-monitoring/host/memory/table?deep

  • /api/operational/system-monitoring/host/memory/table/mem-usage

  • /api/operational/system-monitoring/host/memory/table/mem-usage?deep

  • /api/operational/system-monitoring/host/memory/table

    /mem-usage/<duration>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

.

Example: GET Host Memory Table APIs

curl -k -v -u admin:Cisco123# -X GET 'https://172.19.162.209/api/operational/system-monitoring/host/memory/table/mem-usage/1h?deep'
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 172.19.162.209...
* Connected to 172.19.162.209 (172.19.162.209) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 3 05:02:29 2017 GMT
* expire date: Feb 1 05:02:29 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/memory/table/mem-usage/1h?deep HTTP/1.1
> Host: 172.19.162.209
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
>< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Tue, 07 Feb 2017 04:27:22 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<


<mem-usage
        xmlns="http://www.cisco.com/nfvos/system-monitoring"
        xmlns:y="http://tail-f.com/ns/rest"
        xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
        <duration>1h</duration>
        <memory>
                <type>buffered-MB</type>
                <min>11.41</min>
                <max>16.83</max>
                <average>14.13</average>
        </memory>
        <memory>
                <type>cached-MB</type>
                <min>3711.17</min>
                <max>3731.85</max>
                <average>3719.28</average>
        </memory>
        <memory>
                <type>free-MB</type>
                <min>54076.76</min>
                <max>54166.76</max>
                <average>54127.47</average>
        </memory>
        <memory>
                <type>slab-recl-MB</type>
                <min>186.78</min>
                <max>186.79</max>
                <average>186.79</average>
        </memory>
        <memory>
                <type>slab-unrecl-MB</type>
                <min>52.03</min>
                <max>52.84</max>
                <average>52.26</average>
        </memory>
        <memory>
                <type>used-MB</type>
                <min>6032.55</min>
                <max>6099.19</max>
                <average>6062.51</average>
        </memory>
</mem-usage>

Host Port Stats APIs

Table 10. Host Port Stats APIs

Action

Method

Payload Required

API

To get the packet counts information (error-rx, error-tx, error-total, packets-rx, packets-tx, and packets-total) on all host interfaces

GET

No

  • /api/operational/system-monitoring/host/port

  • /api/operational/system-monitoring/host/port/stats

  • /api/operational/system-monitoring/host/port/stats?deep

  • /api/operational/system-monitoring/host/port

    /stats/port-usage/<duration>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host Port Stats API 

curl -k -v -u admin:Cisco123# -X GET 'https://172.19.162.209/api/operational/system-monitoring/host/port/stats/port-usage/5min?deep'
* Trying 172.19.162.209...
* Connected to 172.19.162.209 (172.19.162.209) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/port/stats/port-usage/5min?deep HTTP/1.1
> Host: 172.19.162.209
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 05:43:42 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<

<port-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <collect-start-date-time>2017-02-22T05:38:40-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <port>
 <name>eth0</name>
 <total-packets-per-sec>[38.8, 24.38, 34.9, 37.94, 21.64, 20.84, 31.72, 36.22, 22.44, 28.16, 31.04, 33.24, 20.56, 21.02, 20.72, 22.64, 21.98, 27.14]</total-packets-per-sec>
 <rx-packets-per-sec>[36.66, 22.02, 32.72, 35.4, 19.88, 18.92, 29.26, 34.4, 18.64, 23.0, 28.88, 30.02, 17.56, 19.12, 18.46, 20.46, 19.74, 25.24]</rx-packets-per-sec>
 <tx-packets-per-sec>[2.14, 2.36, 2.18, 2.54, 1.76, 1.92, 2.46, 1.82, 3.8, 5.16, 2.16, 3.22, 3.0, 1.9, 2.26, 2.18, 2.24, 1.9]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <name>eth1</name>
 <total-packets-per-sec>[34.58, 19.66, 30.5, 32.92, 18.3, 17.08, 26.88, 32.52, 14.2, 16.88, 26.68, 26.7, 14.46, 17.12, 16.26, 18.42, 17.44, 23.46, 26.9]</total-packets-per-sec>
 <rx-packets-per-sec>[34.44, 19.54, 30.46, 32.78, 18.18, 17.0, 26.72, 32.46, 14.12, 16.72, 26.62, 26.62, 14.3, 17.06, 16.18, 18.26, 17.38, 23.34, 26.72]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.14, 0.12, 0.04, 0.14, 0.12, 0.08, 0.16, 0.06, 0.08, 0.16, 0.06, 0.08, 0.16, 0.06, 0.08, 0.16, 0.06, 0.12, 0.18]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <name>eth2</name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <name>eth3</name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <name>eth4</name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <name>eth5</name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
</port-usage>
Table 11. Field Description for Host Port Statistics API Response

Field

Description

name Interface name
total-packets-per-sec Total (rx + tx) packet rate
rx-packets-per-sec Packets received per second
tx-packets-per-sec Packets transmitted per second
total-errors-per-sec Total (rx + tx) error rate
rx-errors-per-sec Error rate for received packets
tx-errors-per-sec Error rate for transmitted packets

Host Port Table APIs

Table 12. Host Port Table APIs

Action

Method

Payload Required

API

To get statistics information about all ports

GET

No

  • /api/operational/system-monitoring/host/port

  • /api/operational/system-monitoring/host/port/table

  • /api/operational/system-monitoring/host/port/table?deep

  • /api/operational/system-monitoring/host/port

    /table/port-usage/<duration>,<name>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET Host Port Table API 

curl -k -v -u admin:Cisco123# -X GET 'https://172.19.162.209/api/operational/system-monitoring/host/port/table?deep'
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 172.19.162.209...
* Connected to 172.19.162.209 (172.19.162.209) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/host/port/table?deep HTTP/1.1
> Host: 172.19.162.209
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 05:50:53 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<

<table xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <port-usage>
 <duration>5min</duration>
 <name>eth0</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>up</status>
 <ip-address>NA</ip-address>
 <rx-packets>9117</rx-packets>
 <tx-packets>620</tx-packets>
 <rx-packets-per-sec>31.44</rx-packets-per-sec>
 <tx-packets-per-sec>2.14</tx-packets-per-sec>
 </port-usage>
 <port-usage>
 <duration>5min</duration>
 <name>eth1</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>up</status>
 <ip-address>NA</ip-address>
 <rx-packets>8491</rx-packets>
 <tx-packets>17</tx-packets>
 <rx-packets-per-sec>29.28</rx-packets-per-sec>
 <tx-packets-per-sec>0.06</tx-packets-per-sec>
 </port-usage>
 <port-usage>
 <duration>5min</duration>
 <name>eth2</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>down</status>
 <ip-address>NA</ip-address>
 <rx-packets>0</rx-packets>
 <tx-packets>0</tx-packets>
 <rx-packets-per-sec>0.0</rx-packets-per-sec>
 <tx-packets-per-sec>0.0</tx-packets-per-sec>
 </port-usage>
 <port-usage>
 <duration>5min</duration>
 <name>eth3</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>down</status>
 <ip-address>NA</ip-address>
 <rx-packets>0</rx-packets>
 <tx-packets>0</tx-packets>
 <rx-packets-per-sec>0.0</rx-packets-per-sec>
 <tx-packets-per-sec>0.0</tx-packets-per-sec>
 </port-usage>
 <port-usage>
 <duration>5min</duration>
 <name>eth4</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>down</status>
 <ip-address>NA</ip-address>
 <rx-packets>0</rx-packets>
 <tx-packets>0</tx-packets>
 <rx-packets-per-sec>0.0</rx-packets-per-sec>
 <tx-packets-per-sec>0.0</tx-packets-per-sec>
 </port-usage>
 <port-usage>
 <duration>5min</duration>
 <name>eth5</name>
 <collect-start-date-time>2017-02-22T05:45:50-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <status>down</status>
 <ip-address>NA</ip-address>
 <rx-packets>0</rx-packets>
 <tx-packets>0</tx-packets>
 <rx-packets-per-sec>0.0</rx-packets-per-sec>
 <tx-packets-per-sec>0.0</tx-packets-per-sec>
 </port-usage>
</table>
Table 13. Field Description for Host Port Table API Response

Field

Description

Name

Name of the host interface or port

collect-start-date-time

The actual start date and time of this collection

duration

The duration of this collection

Status

Port status

IP_Address

IP address of this interface

collect-interval-seconds

Time interval of the collection

rx-packets

Received packets

tx-packets

Transmitted packets

rx-packets-per-sec

Received packet rate (packets/second)

tx-packets-per-sec

Transmitted packet rate (packets/second)

VNF CPU Stats APIs

Table 14. VNF CPU Stats APIs

Action

Method

Payload Required

API

To get CPU statistics information of VMs

GET

No

  • /api/operational/system-monitoring/vnf/vcpu

  • /api/operational/system-monitoring/vnf/vcpu/stats

  • /api/operational/system-monitoring/vnf/vcpu/stats?deep

  • /api/operational/system-monitoring/vnf/vcpu/stats/vcpu-usage

  • /api/operational/system-monitoring/vnf/vcpu

    /stats/vcpu-usage?deep

  • /api/operational/system-monitoring/vnf

    /vcpu/stats/vcpu-usage/<duration>?deep

  • /api/operational/system-monitoring/vnf

    /vcpu/stats/vcpu-usage/<duration>/vnf/<vnf-name>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET VNF CPU Stats API

This example is for all VNFs.


curl -k -v -u admin:Cisco123# -X GET https://209.165.201.2/api/operational/system-monitoring/vnf/vcpu/stats/vcpu-usage/5min?deep

Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Mar 8 19:19:56 2017 GMT
* expire date: Mar 6 19:19:56 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/vnf/vcpu/stats/vcpu-usage/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Thu, 09 Mar 2017 20:37:13 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<vcpu-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <vnf>
 <name>1489003560.ROUTER</name>
 <collect-start-date-time>2017-03-09T20:32:10-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <total-percentage>[15.62, 16.25, 16.28, 15.35, 15.3, 15.28, 15.27, 15.24, 15.12, 15.06, 15.05, 15.05, 15.29, 
15.37, 14.81, 14.77, 14.75, 14.7, 14.59, 14.54, 14.51, 14.42, 14.39, 14.39, 14.34, 14.22, 14.15, 14.2, 14.17]</total-percentage>
 <vcpu>
 <id>0</id>
 <vcpu-percentage>[7.06, 9.82, 10.22, 6.5, 6.5, 6.54, 6.6, 6.48, 6.3, 6.3, 6.38, 6.46, 7.76, 8.44, 6.4, 6.4, 6.44, 6.5, 
6.42, 6.38, 6.46, 6.48, 6.6, 6.64, 6.66, 6.44, 6.36, 6.52]</vcpu-percentage>
 </vcpu>
 <vcpu>
 <id>1</id>
 <vcpu-percentage>[14.02, 13.98, 14.14, 14.16, 14.1, 14.1, 14.06, 14.04, 14.1, 14.1, 14.1, 14.1, 14.1, 14.06, 14.0, 
14.04, 14.1, 14.06, 14.0, 14.04, 14.06, 13.96, 13.94, 13.96, 13.98, 14.02, 13.94, 13.96]</vcpu-percentage>
 </vcpu>
 <vcpu>
 <id>2</id>
 <vcpu-percentage>[10.6, 10.68, 10.72, 10.6, 10.6, 10.64, 10.66, 10.6, 10.6, 10.64, 10.7, 10.66, 10.64, 10.7, 10.7, 10.7, 
10.7, 10.7, 10.7, 10.7, 10.74, 10.76, 10.74, 10.76, 10.7, 10.74, 10.8, 10.76]</vcpu-percentage>
 </vcpu>
 <vcpu>
 <id>3</id>
 <vcpu-percentage>[30.78, 30.36, 30.12, 30.14, 29.9, 29.82, 29.74, 29.76, 29.54, 29.18, 28.96, 28.9, 28.7, 28.32, 28.08, 27.9, 
27.82, 27.46, 27.06, 26.96, 26.78, 26.56, 26.38, 26.12, 25.92, 26.2, 26.52, 25.1]</vcpu-percentage>
 </vcpu>
 </vnf>
 <vnf>
 <name>1489002218.OTHER</name>
 <collect-start-date-time>2017-03-09T20:32:10-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <total-percentage>[0.36, 0.3, 0.3, 0.18, 0.16, 0.32, 0.2, 0.2, 0.2, 0.2, 0.16, 0.18, 0.26, 0.2, 0.24, 0.22, 0.18, 0.3, 0.26, 0.2, 
0.2, 0.2, 0.24, 0.3, 0.26, 0.24, 0.26, 0.2]</total-percentage>
 <vcpu>
 <id>0</id>
 <vcpu-percentage>[0.36, 0.26, 0.24, 0.18, 0.16, 0.32, 0.2, 0.2, 0.2, 0.2, 0.16, 0.18, 0.22, 0.18, 0.3, 0.22, 0.14, 0.24, 
0.26, 0.2, 0.2, 0.2, 0.24, 0.26, 0.2, 0.28, 0.28, 0.14, 0.2]</vcpu-percentage>
 </vcpu>
 </vnf>
</vcpu-usage>

VNF Disk Stats APIs

Table 15. VNF Disk Stats APIs

Action

Method

Payload Required

API

To get the VNF disk statistics

GET

No

  • /api/operational/system-monitoring/vnf/disk

  • /api/operational/system-monitoring/vnf/disk/stats

  • /api/operational/system-monitoring/vnf/disk/stats?deep

  • /api/operational/system-monitoring/vnf/disk

    /stats/disk-operations

  • /api/operational/system-monitoring/vnf/disk

    /stats/disk-operations?deep

  • /api/operational/system-monitoring/vnf

    /disk/stats/disk-operations/<duration>?deep

  • /api/operational/system-monitoring/vnf

    /disk/stats/disk-operations/<duration>/vnf?deep

  • /api/operational/system-monitoring/vnf

    /disk/stats/disk-operations/<duration>/vnf/<vnf-name>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET VNF Disk Stats API

This example is for all VMs.


curl -k -v -u admin:Cisco123# -X GET https://209.165.201.2/api/operational/system-monitoring/vnf/disk/stats/disk-operations/5min?deep
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/vnf/disk/stats/disk-operations/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 06:17:48 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<disk-operations xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com
/nfvos/system-monitoring">
 <duration>5min</duration>
 <vnf>
 <name>1487397034.OTHER</name>
 <collect-start-date-time>2017-02-22T06:12:40-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <disk>
 <disk-name>vda</disk-name>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</writes-per-sec>
 </disk>
 </vnf>
 <vnf>
 <name>1487399314.ROUTER2</name>
 <collect-start-date-time>2017-02-22T06:12:40-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <disk>
 <disk-name>hdd</disk-name>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</writes-per-sec>
 </disk>
 <disk>
 <disk-name>vda</disk-name>
 <bytes-read-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</bytes-read-per-sec>
 <bytes-written-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3276.8, 4915.2, 0.0, 655.36, 983.04, 0.0, 0.0, 0.0, 0.0, 0.0, 122.88]</bytes-written-per-sec>
 <reads-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</reads-per-sec>
 <writes-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.36, 0.54, 0.0, 0.12, 0.18, 0.0, 0.0, 0.0, 0.0, 0.0, 0.12, 0.18]</writes-per-sec>
 </disk>
 </vnf>
</disk-operations>

VNF Memory Stats API

Table 16. VNF Memory Stats APIs

Action

Method

Payload Required

API

To get the memory statistics of VMs

GET

No

  • /api/operational/system-monitoring/vnf/memory

  • /api/operational/system-monitoring/vnf/memory/stats

  • /api/operational/system-monitoring/vnf/memory/stats?deep

  • /api/operational/system-monitoring/vnf/memory

    /stats/mem-usage /<duration>?deep

  • /api/operational/system-monitoring/vnf

    /memory/stats/mem-usage/<duration>/vnf/<vnf-name>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET VNF Memory Stats API

This example is for all VMs.


curl -k -v -u "admin:admin" -X GET https://209.165.201.2/api/operational/system-monitoring/vnf/memory/stats/mem-usage/5min?deep
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/vnf/memory/stats/mem-usage/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 06:35:09 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<mem-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <vnf>
 <name>1487397034.OTHER</name>
 <collect-start-date-time>2017-02-22T06:30:00-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <total-MB>[256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 256.0, 
256.0, 256.0, 256.0, 256.0, 256.0, 256.0]</total-MB>
 <rss-MB>[116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 
116.29, 116.29, 116.29, 116.29, 116.29, 116.29, 116.29]</rss-MB>
 </vnf>
 <vnf>
 <name>1487399314.ROUTER2</name>
 <collect-start-date-time>2017-02-22T06:30:00-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <total-MB>[4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 
4096.0, 4096.0, 4096.0, 4096.0, 4096.0, 4096.0]</total-MB>
 <rss-MB>[4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 
4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93, 4179.93]</rss-MB>
 </vnf>
</mem-usage>
Table 17. Field Description for VNF Memory Stats API Response

Field

Description

total-MB

Total memory of the VNF in MB

rss-MB

Resident Set Size of the VNF in MB

VNF Port Stats APIs

Table 18. VNF Port Stats APIs

Action

Method

Payload Required

API

To get the VNF port statistics

GET

No

  • /api/operational/system-monitoring/vnf/port

  • /api/operational/system-monitoring/vnf/port/stats

  • /api/operational/system-monitoring/vnf/port/stats?deep

  • /api/operational/system-monitoring/vnf/port/stats/port-usage

  • /api/operational/system-monitoring/vnf/port/stats/port-usage?deep

  • /api/operational/system-monitoring

    /vnf/port/stats/port-usage/<duration>?deep

  • /api/operational/system-monitoring

    /vnf/port/stats/port-usage/<duration>/vnf?deep

  • /api/operational/system-monitoring/vnf/port

    /stats/port-usage/<duration>/vnf/<vnf-name>?deep

The valid duration can be: 1min, 5min, 15min, 30min, 1h, 1H, 6h, 6H, 1d, 1D, 5d, 5D, 30d, and 30D

Example: GET VNF Port Stats API

This example is for all VMs.


curl -k -v -u admin:Cisco123# -X GET https://209.165.201.2/api/operational/system-monitoring
/vnf/port/stats/port-usage/5min?deep
Note: Unnecessary use of -X or --request, GET is already inferred.
* Trying 209.165.201.2...
* Connected to 209.165.201.2 (209.165.201.2) port 443 (#0)
* Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
* successfully set certificate verify locations:
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
 CApath: none
* TLSv1.0 (OUT), TLS handshake, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Server hello (2):
* TLSv1.0 (IN), TLS handshake, Certificate (11):
* TLSv1.0 (IN), TLS handshake, Server key exchange (12):
* TLSv1.0 (IN), TLS handshake, Server finished (14):
* TLSv1.0 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.0 (OUT), TLS change cipher, Client hello (1):
* TLSv1.0 (OUT), TLS handshake, Finished (20):
* TLSv1.0 (IN), TLS change cipher, Client hello (1):
* TLSv1.0 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.0 / DHE-RSA-AES256-SHA
* Server certificate:
* subject: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* start date: Feb 18 12:04:07 2017 GMT
* expire date: Feb 16 12:04:07 2027 GMT
* issuer: CN=Cisco-Enterprise-NFVIS-Self-Signed-Certificate
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* Server auth using Basic with user 'admin'
> GET /api/operational/system-monitoring/vnf/port/stats/port-usage/5min?deep HTTP/1.1
> Host: 209.165.201.2
> Authorization: Basic YWRtaW46Q2lzY28xMjMj
> User-Agent: curl/7.49.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Server: nginx/1.10.1
< Date: Wed, 22 Feb 2017 06:14:09 GMT
< Content-Type: application/vnd.yang.data+xml
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Control: private, no-cache, must-revalidate, proxy-revalidate
< Pragma: no-cache
<
<port-usage xmlns="http://www.cisco.com/nfvos/system-monitoring" xmlns:y="http://tail-f.com/ns/rest" xmlns:system_monitoring="http://www.cisco.com/nfvos/system-monitoring">
 <duration>5min</duration>
 <vnf>
 <name>1487397034.OTHER</name>
 <collect-start-date-time>2017-02-22T06:09:00-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <port>
 <port-name>vnic0</port-name>
 <total-packets-per-sec>[23.04, 16.26, 14.38, 13.38, 14.98, 14.5, 14.34, 14.46, 15.44, 14.86, 22.08, 25.78, 12.74, 
15.02, 14.1, 15.84, 18.54, 16.56, 15.36, 18.64, 19.32, 24.2, 30.32, 19.06, 15.68]</total-packets-per-sec>
 <rx-packets-per-sec>[22.96, 16.1, 14.32, 13.3, 14.82, 14.44, 14.22, 14.28, 15.44, 14.74, 21.9, 25.78, 12.62, 
14.84, 14.1, 15.72, 18.36, 16.52, 15.22, 18.52, 19.28, 24.06, 30.2, 19.02, 15.54]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.08, 0.16, 0.06, 0.08, 0.16, 0.06, 0.12, 0.18, 0.0, 0.12, 0.18, 0.0, 0.12, 0.18, 0.0, 0.12, 
0.18, 0.04, 0.14, 0.12, 0.04, 0.14, 0.12, 0.04, 0.14]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <port-name>vnic1</port-name>
 <total-packets-per-sec>[23.04, 16.26, 14.38, 13.38, 14.98, 14.5, 14.34, 14.46, 15.44, 14.86, 22.08, 25.78, 
12.74, 15.02, 14.1, 15.84, 18.54, 16.56, 15.36, 18.64, 19.32, 24.2, 30.32, 19.06, 15.68]</total-packets-per-sec>
 <rx-packets-per-sec>[22.96, 16.1, 14.32, 13.3, 14.82, 14.44, 14.22, 14.28, 15.44, 14.74, 21.9, 25.78, 12.62, 14.84, 
14.1, 15.72, 18.36, 16.52, 15.22, 18.52, 19.28, 24.06, 30.2, 19.02, 15.54]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.08, 0.16, 0.06, 0.08, 0.16, 0.06, 0.12, 0.18, 0.0, 0.12, 0.18, 0.0, 0.12, 0.18, 0.0, 0.12, 
0.18, 0.04, 0.14, 0.12, 0.04, 0.14, 0.12, 0.04, 0.14]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 </vnf>
 <vnf>
 <name>1487399314.ROUTER2</name>
 <collect-start-date-time>2017-02-22T06:09:00-00:00</collect-start-date-time>
 <collect-interval-seconds>10</collect-interval-seconds>
 <port>
 <port-name>vnic2</port-name>
 <total-packets-per-sec>[0.68, 0.72, 0.68, 0.8, 0.72, 0.68, 0.8, 0.72, 0.6, 0.76, 0.84, 0.6, 0.76, 0.84, 0.6, 0.68, 0.8, 
0.72, 0.68, 0.72, 0.68, 0.8, 0.72, 0.68, 0.8]</total-packets-per-sec>
 <rx-packets-per-sec>[0.34, 0.36, 0.34, 0.4, 0.36, 0.34, 0.4, 0.36, 0.3, 0.38, 0.42, 0.3, 0.38, 0.42, 0.3, 0.34, 0.4, 0.36, 
0.34, 0.36, 0.34, 0.4, 0.36, 0.34, 0.4]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.34, 0.36, 0.34, 0.4, 0.36, 0.34, 0.4, 0.36, 0.3, 0.38, 0.42, 0.3, 0.38, 0.42, 0.3, 0.34, 0.4, 0.36, 
0.34, 0.36, 0.34, 0.4, 0.36, 0.34, 0.4]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <port-name>vnic4</port-name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 <port>
 <port-name>vnic3</port-name>
 <total-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</total-packets-per-sec>
 <rx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</rx-packets-per-sec>
 <tx-packets-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0]</tx-packets-per-sec>
 <total-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</total-errors-per-sec>
 <rx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</rx-errors-per-sec>
 <tx-errors-per-sec>[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 
0.0, 0.0, 0.0, 0.0]</tx-errors-per-sec>
 </port>
 </vnf>
</port-usage>
Table 19. Field Description for VNF Port Stats API Response

Field

Description

total-packets-per-sec

Total packets received and sent per second

rx-packets-per-sec

Packets received per second

tx-packets-per-sec

Packets sent per second

total-errors-per-sec

Total error rate (for packet reception and transmission)

rx-errors-per-sec

Error rate for receiving packets

tx-errors-per-sec

Error rate for sending packets