
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET nfv/getServices

Get services from NfVOS.

Since Product Version: 3.1

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/nfv/getServices

## Request Parameters

Attribute | Source | Description
--- | --- | ---
deviceIp String | query | Optional Device management address

## Response Parameters

Attribute | Description
--- | ---
images ImagePropertiesDTO[] |
Attribute | Description
--- | ---
container_format String | Format of the disk container.
disk_bus String | Root disk bus: ide, scsi, virtio
disk_format String | Format of the disk: qcow2, raw, vmdk.
e1000_net String | True if image has e1000 drivers.
name String | Name of the service
properties ImageProperty[] | List of property name and value
Attribute | Description
--- | ---
name String | Name of the property
value String | Value of the property
serial_console String | Serial console boolean flag.
size String | Size of the image specified by URL above. If unsure, leave it blank.
sizeunit String | Size unit. MiB/GiB/TiB/PiB/EiB.
src String | URL of the VM image from where it can be downloaded by ESC.
virtio_net String | True if image has VIRTIO drivers.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/nfv/getServices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <imageList>
        <images>
          <image>
            <container_format>String value</container_format>
            <disk_bus>String value</disk_bus>
            <disk_format>String value</disk_format>
            <e1000_net>String value</e1000_net>
            <name>String value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>String value</serial_console>
            <size>String value</size>
            <sizeunit>String value</sizeunit>
            <src>String value</src>
            <virtio_net>String value</virtio_net>
          </image>
          <image>
            <container_format>Another string value</container_format>
            <disk_bus>Another string value</disk_bus>
            <disk_format>Another string value</disk_format>
            <e1000_net>Another string value</e1000_net>
            <name>Another string value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>Another string value</serial_console>
            <size>Another string value</size>
            <sizeunit>Another string value</sizeunit>
            <src>Another string value</src>
            <virtio_net>Another string value</virtio_net>
          </image>
        </images>
      </imageList>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/nfv/getServices.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/nfv/getServices",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "imageList" : {
          "images" : {
            "image" : [{
              "container_format" : "String value",
              "disk_bus" : "String value",
              "disk_format" : "String value",
              "e1000_net" : "String value",
              "name" : "String value",
              "properties" : {
                "property" : [{
                  "name" : "String value",
                  "value" : "String value"
                },
                {
                  "name" : "Another string value",
                  "value" : "Another string value"
                }]
              },
              "serial_console" : "String value",
              "size" : "String value",
              "sizeunit" : "String value",
              "src" : "String value",
              "virtio_net" : "String value"
            },
            {
              "container_format" : "Another string value",
              "disk_bus" : "Another string value",
              "disk_format" : "Another string value",
              "e1000_net" : "Another string value",
              "name" : "Another string value",
              "properties" : {
                "property" : [{
                  "name" : "String value",
                  "value" : "String value"
                },
                {
                  "name" : "Another string value",
                  "value" : "Another string value"
                }]
              },
              "serial_console" : "Another string value",
              "size" : "Another string value",
              "sizeunit" : "Another string value",
              "src" : "Another string value",
              "virtio_net" : "Another string value"
            }]
          }
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/op/nfv/getServices

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
deviceIp String | query | Optional Device management address

## Response Parameters

Attribute | Description
--- | ---
images ImagePropertiesDTO[] |
Attribute | Description
--- | ---
container_format String | Format of the disk container.
disk_bus String | Root disk bus: ide, scsi, virtio
disk_format String | Format of the disk: qcow2, raw, vmdk.
e1000_net String | True if image has e1000 drivers.
name String | Name of the service
properties ImageProperty[] | List of property name and value
Attribute | Description
--- | ---
name String | Name of the property
value String | Value of the property
serial_console String | Serial console boolean flag.
size String | Size of the image specified by URL above. If unsure, leave it blank.
sizeunit String | Size unit. MiB/GiB/TiB/PiB/EiB.
src String | URL of the VM image from where it can be downloaded by ESC.
virtio_net String | True if image has VIRTIO drivers.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/nfv/getServices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <imageList>
        <images>
          <image>
            <container_format>String value</container_format>
            <disk_bus>String value</disk_bus>
            <disk_format>String value</disk_format>
            <e1000_net>String value</e1000_net>
            <name>String value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>String value</serial_console>
            <size>String value</size>
            <sizeunit>String value</sizeunit>
            <src>String value</src>
            <virtio_net>String value</virtio_net>
          </image>
          <image>
            <container_format>Another string value</container_format>
            <disk_bus>Another string value</disk_bus>
            <disk_format>Another string value</disk_format>
            <e1000_net>Another string value</e1000_net>
            <name>Another string value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>Another string value</serial_console>
            <size>Another string value</size>
            <sizeunit>Another string value</sizeunit>
            <src>Another string value</src>
            <virtio_net>Another string value</virtio_net>
          </image>
        </images>
      </imageList>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/nfv/getServices.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "imageList" : [ {
          "images" : {
            "image" : [ {
              "container_format" : "String value",
              "disk_bus" : "String value",
              "disk_format" : "String value",
              "e1000_net" : "String value",
              "name" : "String value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "String value",
              "size" : "String value",
              "sizeunit" : "String value",
              "src" : "String value",
              "virtio_net" : "String value"
            }, {
              "container_format" : "Another string value",
              "disk_bus" : "Another string value",
              "disk_format" : "Another string value",
              "e1000_net" : "Another string value",
              "name" : "Another string value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "Another string value",
              "size" : "Another string value",
              "sizeunit" : "Another string value",
              "src" : "Another string value",
              "virtio_net" : "Another string value"
            } ]
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/op/nfv/getServices

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
deviceIp String | query | Optional Device management address

## Response Parameters

Attribute | Description
--- | ---
images ImagePropertiesDTO[] |
Attribute | Description
--- | ---
container_format String | Format of the disk container.
disk_bus String | Root disk bus: ide, scsi, virtio
disk_format String | Format of the disk: qcow2, raw, vmdk.
e1000_net String | True if image has e1000 drivers.
name String | Name of the service
properties ImageProperty[] | List of property name and value
Attribute | Description
--- | ---
name String | Name of the property
value String | Value of the property
serial_console String | Serial console boolean flag.
size String | Size of the image specified by URL above. If unsure, leave it blank.
sizeunit String | Size unit. MiB/GiB/TiB/PiB/EiB.
src String | URL of the VM image from where it can be downloaded by ESC.
virtio_net String | True if image has VIRTIO drivers.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/nfv/getServices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <imageList>
        <images>
          <image>
            <container_format>String value</container_format>
            <disk_bus>String value</disk_bus>
            <disk_format>String value</disk_format>
            <e1000_net>String value</e1000_net>
            <name>String value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>String value</serial_console>
            <size>String value</size>
            <sizeunit>String value</sizeunit>
            <src>String value</src>
            <virtio_net>String value</virtio_net>
          </image>
          <image>
            <container_format>Another string value</container_format>
            <disk_bus>Another string value</disk_bus>
            <disk_format>Another string value</disk_format>
            <e1000_net>Another string value</e1000_net>
            <name>Another string value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>Another string value</serial_console>
            <size>Another string value</size>
            <sizeunit>Another string value</sizeunit>
            <src>Another string value</src>
            <virtio_net>Another string value</virtio_net>
          </image>
        </images>
      </imageList>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/nfv/getServices.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "imageList" : [ {
          "images" : {
            "image" : [ {
              "container_format" : "String value",
              "disk_bus" : "String value",
              "disk_format" : "String value",
              "e1000_net" : "String value",
              "name" : "String value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "String value",
              "size" : "String value",
              "sizeunit" : "String value",
              "src" : "String value",
              "virtio_net" : "String value"
            }, {
              "container_format" : "Another string value",
              "disk_bus" : "Another string value",
              "disk_format" : "Another string value",
              "e1000_net" : "Another string value",
              "name" : "Another string value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "Another string value",
              "size" : "Another string value",
              "sizeunit" : "Another string value",
              "src" : "Another string value",
              "virtio_net" : "Another string value"
            } ]
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/op/nfv/getServices

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
deviceIp String | query | Optional Device management address

## Response Parameters

Attribute | Description
--- | ---
images ImagePropertiesDTO[] |
Attribute | Description
--- | ---
container_format String | Format of the disk container.
disk_bus String | Root disk bus: ide, scsi, virtio
disk_format String | Format of the disk: qcow2, raw, vmdk.
e1000_net String | True if image has e1000 drivers.
name String | Name of the service
properties ImageProperty[] | List of property name and value
Attribute | Description
--- | ---
name String | Name of the property
value String | Value of the property
serial_console String | Serial console boolean flag.
size String | Size of the image specified by URL above. If unsure, leave it blank.
sizeunit String | Size unit. MiB/GiB/TiB/PiB/EiB.
src String | URL of the VM image from where it can be downloaded by ESC.
virtio_net String | True if image has VIRTIO drivers.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/nfv/getServices

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <imageList>
        <images>
          <image>
            <container_format>String value</container_format>
            <disk_bus>String value</disk_bus>
            <disk_format>String value</disk_format>
            <e1000_net>String value</e1000_net>
            <name>String value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>String value</serial_console>
            <size>String value</size>
            <sizeunit>String value</sizeunit>
            <src>String value</src>
            <virtio_net>String value</virtio_net>
          </image>
          <image>
            <container_format>Another string value</container_format>
            <disk_bus>Another string value</disk_bus>
            <disk_format>Another string value</disk_format>
            <e1000_net>Another string value</e1000_net>
            <name>Another string value</name>
            <properties>
              <property>
                <name>String value</name>
                <value>String value</value>
              </property>
              <property>
                <name>Another string value</name>
                <value>Another string value</value>
              </property>
            </properties>
            <serial_console>Another string value</serial_console>
            <size>Another string value</size>
            <sizeunit>Another string value</sizeunit>
            <src>Another string value</src>
            <virtio_net>Another string value</virtio_net>
          </image>
        </images>
      </imageList>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/nfv/getServices.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "imageList" : [ {
          "images" : {
            "image" : [ {
              "container_format" : "String value",
              "disk_bus" : "String value",
              "disk_format" : "String value",
              "e1000_net" : "String value",
              "name" : "String value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "String value",
              "size" : "String value",
              "sizeunit" : "String value",
              "src" : "String value",
              "virtio_net" : "String value"
            }, {
              "container_format" : "Another string value",
              "disk_bus" : "Another string value",
              "disk_format" : "Another string value",
              "e1000_net" : "Another string value",
              "name" : "Another string value",
              "properties" : {
                "property" : [ {
                  "name" : "String value",
                  "value" : "String value"
                }, {
                  "name" : "Another string value",
                  "value" : "Another string value"
                } ]
              },
              "serial_console" : "Another string value",
              "size" : "Another string value",
              "sizeunit" : "Another string value",
              "src" : "Another string value",
              "virtio_net" : "Another string value"
            } ]
          }
        } ]
      }
    }