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

POST image/deployConfigure

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

Configure the deployment with the provided details

Since Product Version: 3.1

Resource URL

/webacs/api/v1/op/image/deployConfigure

Request Payload Parameters

Type Attribute Name Description

deployConfig[]

deployConfigs

String

imageConfigType

String

imageFileName

String

imageId

boolean

powerOn

String

server

String

vmDeviceType

Response Parameters

Type Attribute Name Description

String

jobName

String

jobScheduleStatus

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 Request Payload

https://172.25.123.114/webacs/api/v1/op/image/deployConfigure

<?xml version="1.0" ?>
<imageDeployConfig>
  <deployConfigList>
    <deployConfig>
      <config>
        <deviceId>String value</deviceId>
        <spanConfig>
          <sessionName>String value</sessionName>
          <spanDestination>
            <port>String value</port>
            <vmName>String value</vmName>
          </spanDestination>
          <spanSources>
            <spanSource>
              <port>String value</port>
              <vmName>String value</vmName>
            </spanSource>
          </spanSources>
        </spanConfig>
      </config>
      <deploy>
        <dataNetwork>String value</dataNetwork>
        <dataStore>String value</dataStore>
        <exsiHost>String value</exsiHost>
        <id>String value</id>
        <managementNetwork>String value</managementNetwork>
        <rootPasswd>String value</rootPasswd>
        <snmpstring>String value</snmpstring>
        <vmDefaultGateway>String value</vmDefaultGateway>
        <vmIpAddress>String value</vmIpAddress>
        <vmName>String value</vmName>
        <vmNetMask>String value</vmNetMask>
      </deploy>
    </deployConfig>
  </deployConfigList>
  <imageConfigType>String value</imageConfigType>
  <imageFileName>String value</imageFileName>
  <imageId>String value</imageId>
  <powerOn>true</powerOn>
  <server>String value</server>
  <vmDeviceType>String value</vmDeviceType>
</imageDeployConfig>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/image/deployConfigure.json

{
  "imageDeployConfig" : {
    "deployConfigList" : {
      "deployConfig" : {
        "config" : {
          "deviceId" : "String value",
          "spanConfig" : {
            "sessionName" : "String value",
            "spanDestination" : {
              "port" : "String value",
              "vmName" : "String value"
            },
            "spanSources" : {
              "spanSource" : {
                "port" : "String value",
                "vmName" : "String value"
              }
            }
          }
        },
        "deploy" : {
          "dataNetwork" : "String value",
          "dataStore" : "String value",
          "exsiHost" : "String value",
          "id" : "String value",
          "managementNetwork" : "String value",
          "rootPasswd" : "String value",
          "snmpstring" : "String value",
          "vmDefaultGateway" : "String value",
          "vmIpAddress" : "String value",
          "vmName" : "String value",
          "vmNetMask" : "String value"
        }
      }
    },
    "imageConfigType" : "String value",
    "imageFileName" : "String value",
    "imageId" : "String value",
    "powerOn" : true,
    "server" : "String value",
    "vmDeviceType" : "String value"
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/image/deployConfigure

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <jobInformationDTO>
    <jobName>String value</jobName>
    <jobScheduleStatus>String value</jobScheduleStatus>
  </jobInformationDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/image/deployConfigure.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/image\/deployConfigure",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "jobInformationDTO" : {
      "jobName" : "String value",
      "jobScheduleStatus" : "String value"
    }
  }
}