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

GET image/list/family

List the details of all NFV images with the given family name

Since Product Version: 3.1

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/image/list/family

Request Parameters

Attribute Source Description

familyName String

query

Required

Image family name

Response Parameters

Attribute Description

items Arrow image ImageDetailDTO[]

List of images

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.56.58.149/webacs/api/v1/op/image/list/family

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/image/list/family" rootUrl="https://10.56.58.149/webacs/api/v1/op">
  <imageListDTO>
    <imageList>
      <image>
        <applicationType>String value</applicationType>
        <family>String value</family>
        <imageId>2</imageId>
        <imageLocation>String value</imageLocation>
        <imageType>String value</imageType>
        <lastModified>String value</lastModified>
        <name>String value</name>
        <ovaProfiles>
          <ovaProfile>
            <description>String value</description>
            <memory>1</memory>
            <profileName>String value</profileName>
            <shares>1</shares>
            <vcpu>1</vcpu>
          </ovaProfile>
          <ovaProfile>
            <description>Another string value</description>
            <memory>11</memory>
            <profileName>Another string value</profileName>
            <shares>11</shares>
            <vcpu>11</vcpu>
          </ovaProfile>
        </ovaProfiles>
        <size>String value</size>
        <userInputInfo>
          <maxCPU>3.0</maxCPU>
          <maxMemory>3.0</maxMemory>
          <maxStorage>3.0</maxStorage>
          <minCPU>3.0</minCPU>
          <minMemory>3.0</minMemory>
          <minStorage>3.0</minStorage>
        </userInputInfo>
        <version>String value</version>
      </image>
      <image>
        <applicationType>Another string value</applicationType>
        <family>Another string value</family>
        <imageId>12</imageId>
        <imageLocation>Another string value</imageLocation>
        <imageType>Another string value</imageType>
        <lastModified>Another string value</lastModified>
        <name>Another string value</name>
        <ovaProfiles>
          <ovaProfile>
            <description>String value</description>
            <memory>1</memory>
            <profileName>String value</profileName>
            <shares>1</shares>
            <vcpu>1</vcpu>
          </ovaProfile>
          <ovaProfile>
            <description>Another string value</description>
            <memory>11</memory>
            <profileName>Another string value</profileName>
            <shares>11</shares>
            <vcpu>11</vcpu>
          </ovaProfile>
        </ovaProfiles>
        <size>Another string value</size>
        <userInputInfo>
          <maxCPU>13.0</maxCPU>
          <maxMemory>13.0</maxMemory>
          <maxStorage>13.0</maxStorage>
          <minCPU>13.0</minCPU>
          <minMemory>13.0</minMemory>
          <minStorage>13.0</minStorage>
        </userInputInfo>
        <version>Another string value</version>
      </image>
    </imageList>
  </imageListDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.56.58.149/webacs/api/v1/op/image/list/family.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/image\/list\/family",
    "@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
    "imageListDTO" : {
      "imageList" : {
        "image" : [{
          "applicationType" : "String value",
          "family" : "String value",
          "imageId" : 2,
          "imageLocation" : "String value",
          "imageType" : "String value",
          "lastModified" : "String value",
          "name" : "String value",
          "ovaProfiles" : {
            "ovaProfile" : [{
              "description" : "String value",
              "memory" : 1,
              "profileName" : "String value",
              "shares" : 1,
              "vcpu" : 1
            },
            {
              "description" : "Another string value",
              "memory" : 11,
              "profileName" : "Another string value",
              "shares" : 11,
              "vcpu" : 11
            }]
          },
          "size" : "String value",
          "userInputInfo" : {
            "maxCPU" : 3,
            "maxMemory" : 3,
            "maxStorage" : 3,
            "minCPU" : 3,
            "minMemory" : 3,
            "minStorage" : 3
          },
          "version" : "String value"
        },
        {
          "applicationType" : "Another string value",
          "family" : "Another string value",
          "imageId" : 12,
          "imageLocation" : "Another string value",
          "imageType" : "Another string value",
          "lastModified" : "Another string value",
          "name" : "Another string value",
          "ovaProfiles" : {
            "ovaProfile" : [{
              "description" : "String value",
              "memory" : 1,
              "profileName" : "String value",
              "shares" : 1,
              "vcpu" : 1
            },
            {
              "description" : "Another string value",
              "memory" : 11,
              "profileName" : "Another string value",
              "shares" : 11,
              "vcpu" : 11
            }]
          },
          "size" : "Another string value",
          "userInputInfo" : {
            "maxCPU" : 13,
            "maxMemory" : 13,
            "maxStorage" : 13,
            "minCPU" : 13,
            "minMemory" : 13,
            "minStorage" : 13
          },
          "version" : "Another string value"
        }]
      }
    }
  }
}