Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

POST nfv/deploy

Deploy a service on NfVOS.

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 Write

HTTP Methods

POST

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/deploy

Request Payload Parameters

Attribute Description

configuration Arrow image Template[]

Configuration DTO.

server Arrow image Server

The server DTO.

serviceType String

e.g. Thirdparty, CSR, ASAv, vWLC, vNAM

service_definition Arrow image ServiceDefinition

ServiceDefinition DTO.

transactionId String

The unique transaction id.

Response Parameters

Attribute Description

deploymentStage String

Deployment stage

eventTime String

Event time

payload String

Response payload

statusCode Integer

The response status code.

statusMessage String

The response message.

transactionId String

The unique transaction id.

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://localhost/webacs/api/v1/op/nfv/deploy

<?xml version="1.0" ?>
<serviceDeployment>
  <configuration>
    <template>
      <attributes>
        <attribute>
          <key>String value</key>
          <value>String value</value>
        </attribute>
      </attributes>
      <name>String value</name>
    </template>
  </configuration>
  <server>
    <ipAddress>String value</ipAddress>
    <port>15</port>
    <protocol>String value</protocol>
  </server>
  <serviceType>String value</serviceType>
  <service_definition>
    <name>String value</name>
    <networks>
      <network>
        <admin_state>true</admin_state>
        <akey_name>String value</akey_name>
        <bridge>String value</bridge>
        <mirror>true</mirror>
        <mirror_src>String value</mirror_src>
        <provider_network_type>String value</provider_network_type>
        <provider_physical_network>String value</provider_physical_network>
        <provider_segmentation_id>15</provider_segmentation_id>
        <router_external>true</router_external>
        <shared>true</shared>
        <sriov>String value</sriov>
        <subnets>
          <subnet>
            <address>String value</address>
            <akey_name>String value</akey_name>
            <dhcp>true</dhcp>
            <gateway>String value</gateway>
            <ipversion>String value</ipversion>
            <netmask>String value</netmask>
          </subnet>
        </subnets>
        <trunk>true</trunk>
        <vlans>
          <vlan>15</vlan>
        </vlans>
      </network>
    </networks>
    <version>String value</version>
    <vm_groups>
      <vm_group>
        <akey_name>String value</akey_name>
        <bootup_time>15</bootup_time>
        <config_data>
          <configuration>
            <akey_dst>String value</akey_dst>
            <data>String value</data>
            <file>String value</file>
            <variables>
              <variable>
                <name>String value</name>
                <values>
                  <val>String value</val>
                </values>
              </variable>
            </variables>
          </configuration>
        </config_data>
        <disk>
          <akey_name>String value</akey_name>
          <container_format>String value</container_format>
          <disk_bus>String value</disk_bus>
          <disk_format>String value</disk_format>
          <e1000_net>true</e1000_net>
          <serial_console>true</serial_console>
          <size>15</size>
          <sizeunit>String value</sizeunit>
          <src>String value</src>
          <virtio_net>true</virtio_net>
        </disk>
        <flavor>String value</flavor>
        <image>String value</image>
        <interfaces>
          <interface>
            <akey_nicid>15</akey_nicid>
            <allowed_address_pairs>
              <addresses>
                <address>
                  <ip_address>String value</ip_address>
                  <netmask>String value</netmask>
                </address>
              </addresses>
              <address_pair_networks>
                <network>
                  <admin_state>true</admin_state>
                  <akey_name>String value</akey_name>
                  <bridge>String value</bridge>
                  <mirror>true</mirror>
                  <mirror_src>String value</mirror_src>
                  <provider_network_type>String value</provider_network_type>
                  <provider_physical_network>String value</provider_physical_network>
                  <provider_segmentation_id>15</provider_segmentation_id>
                  <router_external>true</router_external>
                  <shared>true</shared>
                  <sriov>String value</sriov>
                  <subnets>
                    <subnet>
                      <address>String value</address>
                      <akey_name>String value</akey_name>
                      <dhcp>true</dhcp>
                      <gateway>String value</gateway>
                      <ipversion>String value</ipversion>
                      <netmask>String value</netmask>
                    </subnet>
                  </subnets>
                  <trunk>true</trunk>
                  <vlans>
                    <vlan>15</vlan>
                  </vlans>
                </network>
              </address_pair_networks>
            </allowed_address_pairs>
            <anycast_address>String value</anycast_address>
            <bandwidth>
              <max>15</max>
              <min>15</min>
            </bandwidth>
            <ip_address>String value</ip_address>
            <mac_address>String value</mac_address>
            <model>String value</model>
            <network>String value</network>
            <port_forwarding>
              <port>
                <akey_type>String value</akey_type>
                <external_port_ranges>
                  <external_port_range>
                    <akey_start>15</akey_start>
                    <end>15</end>
                  </external_port_range>
                </external_port_ranges>
                <protocol>String value</protocol>
                <vnf_port>15</vnf_port>
              </port>
            </port_forwarding>
            <subnet>String value</subnet>
            <type>String value</type>
          </interface>
        </interfaces>
        <kpi_data>
          <enabled>true</enabled>
          <kpis>
            <kpi>
              <event_name>String value</event_name>
              <metric_collector>
                <continuous_alarm>true</continuous_alarm>
                <nicid>15</nicid>
                <poll_frequency>15</poll_frequency>
                <polling_unit>String value</polling_unit>
                <proxy>String value</proxy>
                <type>String value</type>
              </metric_collector>
              <metric_cond>String value</metric_cond>
              <metric_occurrences_false>15</metric_occurrences_false>
              <metric_occurrences_true>15</metric_occurrences_true>
              <metric_proxy>String value</metric_proxy>
              <metric_type>String value</metric_type>
              <metric_value>String value</metric_value>
            </kpi>
          </kpis>
        </kpi_data>
        <misc>
          <watchdog>
            <action>String value</action>
            <hardware>String value</hardware>
          </watchdog>
        </misc>
        <placements>
          <placement>
            <akey_type>String value</akey_type>
            <enforcement>String value</enforcement>
            <host>String value</host>
            <target_vm_group_ref>String value</target_vm_group_ref>
            <vm_group_references>
              <vm_group_ref>String value</vm_group_ref>
            </vm_group_references>
            <zone>String value</zone>
          </placement>
        </placements>
        <port_forwarding>
          <port>
            <akey_type>String value</akey_type>
            <external_port_ranges>
              <external_port_range>
                <akey_start>15</akey_start>
                <end>15</end>
              </external_port_range>
            </external_port_ranges>
            <protocol>String value</protocol>
            <vnf_port>15</vnf_port>
          </port>
        </port_forwarding>
        <properties>
          <property>
            <prop_key>String value</prop_key>
            <prop_value>String value</prop_value>
          </property>
        </properties>
        <recovery_wait_time>15</recovery_wait_time>
        <rules>
          <admin_rules>
            <rule>
              <event_name>String value</event_name>
              <list_actions>
                <action>String value</action>
              </list_actions>
            </rule>
          </admin_rules>
          <user_rules>
            <rule>
              <event_name>String value</event_name>
              <list_actions>
                <action>String value</action>
              </list_actions>
            </rule>
          </user_rules>
        </rules>
        <scaling>
          <elastic>true</elastic>
          <max_active>15</max_active>
          <max_standby>15</max_standby>
          <min_active>15</min_active>
          <min_standby>15</min_standby>
          <standby_ratio>String value</standby_ratio>
          <static_ip_address_pools>
            <static_ip_address_pool>
              <akey_network>String value</akey_network>
              <gateway>String value</gateway>
              <ip_addresses>
                <ip_address>String value</ip_address>
              </ip_addresses>
              <ip_address_ranges>
                <ip_address_range>
                  <akey_start>String value</akey_start>
                  <end>String value</end>
                </ip_address_range>
              </ip_address_ranges>
              <netmask>String value</netmask>
            </static_ip_address_pool>
          </static_ip_address_pools>
          <static_license_pool>
            <license>
              <akey_license_key_value>String value</akey_license_key_value>
              <license_data>String value</license_data>
              <license_file>String value</license_file>
              <license_key_type>String value</license_key_type>
            </license>
          </static_license_pool>
          <static_mac_address_pools>
            <static_mac_address_pool>
              <akey_network>String value</akey_network>
              <mac_addresses>
                <mac_address>String value</mac_address>
              </mac_addresses>
              <mac_address_ranges>
                <mac_address_range>
                  <akey_start>String value</akey_start>
                  <end>String value</end>
                </mac_address_range>
              </mac_address_ranges>
            </static_mac_address_pool>
          </static_mac_address_pools>
        </scaling>
        <shared_ips>
          <shared_ip>
            <akey_nicid>15</akey_nicid>
            <ip_address>String value</ip_address>
            <is_static>true</is_static>
          </shared_ip>
        </shared_ips>
        <vm_flavor>
          <akey_name>String value</akey_name>
          <cores>15</cores>
          <ephemeral_disk_mb>15</ephemeral_disk_mb>
          <memory_mb>15</memory_mb>
          <root_disk_mb>15</root_disk_mb>
          <sockets>15</sockets>
          <swap_disk_mb>15</swap_disk_mb>
          <threads>15</threads>
          <vcpus>15</vcpus>
        </vm_flavor>
        <volumes>
          <volume>
            <akey_volname>String value</akey_volname>
            <bus>String value</bus>
            <maxsize>15</maxsize>
            <minsize>15</minsize>
            <size>15</size>
            <sizeunit>String value</sizeunit>
            <volid>15</volid>
          </volume>
        </volumes>
      </vm_group>
    </vm_groups>
  </service_definition>
  <transactionId>String value</transactionId>
</serviceDeployment>

Sample JSON Request Payload

https://localhost/webacs/api/v1/op/nfv/deploy.json

{
  "serviceDeployment" : {
    "configuration" : {
      "template" : {
        "attributes" : {
          "attribute" : {
            "key" : "String value",
            "value" : "String value"
          }
        },
        "name" : "String value"
      }
    },
    "server" : {
      "ipAddress" : "String value",
      "port" : 15,
      "protocol" : "String value"
    },
    "serviceType" : "String value",
    "service_definition" : {
      "name" : "String value",
      "networks" : {
        "network" : {
          "admin_state" : true,
          "akey_name" : "String value",
          "bridge" : "String value",
          "mirror" : true,
          "mirror_src" : "String value",
          "provider_network_type" : "String value",
          "provider_physical_network" : "String value",
          "provider_segmentation_id" : 15,
          "router_external" : true,
          "shared" : true,
          "sriov" : "String value",
          "subnets" : {
            "subnet" : {
              "address" : "String value",
              "akey_name" : "String value",
              "dhcp" : true,
              "gateway" : "String value",
              "ipversion" : "String value",
              "netmask" : "String value"
            }
          },
          "trunk" : true,
          "vlans" : {
            "vlan" : 15
          }
        }
      },
      "version" : "String value",
      "vm_groups" : {
        "vm_group" : {
          "akey_name" : "String value",
          "bootup_time" : 15,
          "config_data" : {
            "configuration" : {
              "akey_dst" : "String value",
              "data" : "String value",
              "file" : "String value",
              "variables" : {
                "variable" : {
                  "name" : "String value",
                  "values" : {
                    "val" : "String value"
                  }
                }
              }
            }
          },
          "disk" : {
            "akey_name" : "String value",
            "container_format" : "String value",
            "disk_bus" : "String value",
            "disk_format" : "String value",
            "e1000_net" : true,
            "serial_console" : true,
            "size" : 15,
            "sizeunit" : "String value",
            "src" : "String value",
            "virtio_net" : true
          },
          "flavor" : "String value",
          "image" : "String value",
          "interfaces" : {
            "interface" : {
              "akey_nicid" : 15,
              "allowed_address_pairs" : {
                "addresses" : {
                  "address" : {
                    "ip_address" : "String value",
                    "netmask" : "String value"
                  }
                },
                "address_pair_networks" : {
                  "network" : {
                    "admin_state" : true,
                    "akey_name" : "String value",
                    "bridge" : "String value",
                    "mirror" : true,
                    "mirror_src" : "String value",
                    "provider_network_type" : "String value",
                    "provider_physical_network" : "String value",
                    "provider_segmentation_id" : 15,
                    "router_external" : true,
                    "shared" : true,
                    "sriov" : "String value",
                    "subnets" : {
                      "subnet" : {
                        "address" : "String value",
                        "akey_name" : "String value",
                        "dhcp" : true,
                        "gateway" : "String value",
                        "ipversion" : "String value",
                        "netmask" : "String value"
                      }
                    },
                    "trunk" : true,
                    "vlans" : {
                      "vlan" : 15
                    }
                  }
                }
              },
              "anycast_address" : "String value",
              "bandwidth" : {
                "max" : 15,
                "min" : 15
              },
              "ip_address" : "String value",
              "mac_address" : "String value",
              "model" : "String value",
              "network" : "String value",
              "port_forwarding" : {
                "port" : {
                  "akey_type" : "String value",
                  "external_port_ranges" : {
                    "external_port_range" : {
                      "akey_start" : 15,
                      "end" : 15
                    }
                  },
                  "protocol" : "String value",
                  "vnf_port" : 15
                }
              },
              "subnet" : "String value",
              "type" : "String value"
            }
          },
          "kpi_data" : {
            "enabled" : true,
            "kpis" : {
              "kpi" : {
                "event_name" : "String value",
                "metric_collector" : {
                  "continuous_alarm" : true,
                  "nicid" : 15,
                  "poll_frequency" : 15,
                  "polling_unit" : "String value",
                  "proxy" : "String value",
                  "type" : "String value"
                },
                "metric_cond" : "String value",
                "metric_occurrences_false" : 15,
                "metric_occurrences_true" : 15,
                "metric_proxy" : "String value",
                "metric_type" : "String value",
                "metric_value" : "String value"
              }
            }
          },
          "misc" : {
            "watchdog" : {
              "action" : "String value",
              "hardware" : "String value"
            }
          },
          "placements" : {
            "placement" : {
              "akey_type" : "String value",
              "enforcement" : "String value",
              "host" : "String value",
              "target_vm_group_ref" : "String value",
              "vm_group_references" : {
                "vm_group_ref" : "String value"
              },
              "zone" : "String value"
            }
          },
          "port_forwarding" : {
            "port" : {
              "akey_type" : "String value",
              "external_port_ranges" : {
                "external_port_range" : {
                  "akey_start" : 15,
                  "end" : 15
                }
              },
              "protocol" : "String value",
              "vnf_port" : 15
            }
          },
          "properties" : {
            "property" : {
              "prop_key" : "String value",
              "prop_value" : "String value"
            }
          },
          "recovery_wait_time" : 15,
          "rules" : {
            "admin_rules" : {
              "rule" : {
                "event_name" : "String value",
                "list_actions" : {
                  "action" : "String value"
                }
              }
            },
            "user_rules" : {
              "rule" : {
                "event_name" : "String value",
                "list_actions" : {
                  "action" : "String value"
                }
              }
            }
          },
          "scaling" : {
            "elastic" : true,
            "max_active" : 15,
            "max_standby" : 15,
            "min_active" : 15,
            "min_standby" : 15,
            "standby_ratio" : "String value",
            "static_ip_address_pools" : {
              "static_ip_address_pool" : {
                "akey_network" : "String value",
                "gateway" : "String value",
                "ip_addresses" : {
                  "ip_address" : "String value"
                },
                "ip_address_ranges" : {
                  "ip_address_range" : {
                    "akey_start" : "String value",
                    "end" : "String value"
                  }
                },
                "netmask" : "String value"
              }
            },
            "static_license_pool" : {
              "license" : {
                "akey_license_key_value" : "String value",
                "license_data" : "String value",
                "license_file" : "String value",
                "license_key_type" : "String value"
              }
            },
            "static_mac_address_pools" : {
              "static_mac_address_pool" : {
                "akey_network" : "String value",
                "mac_addresses" : {
                  "mac_address" : "String value"
                },
                "mac_address_ranges" : {
                  "mac_address_range" : {
                    "akey_start" : "String value",
                    "end" : "String value"
                  }
                }
              }
            }
          },
          "shared_ips" : {
            "shared_ip" : {
              "akey_nicid" : 15,
              "ip_address" : "String value",
              "is_static" : true
            }
          },
          "vm_flavor" : {
            "akey_name" : "String value",
            "cores" : 15,
            "ephemeral_disk_mb" : 15,
            "memory_mb" : 15,
            "root_disk_mb" : 15,
            "sockets" : 15,
            "swap_disk_mb" : 15,
            "threads" : 15,
            "vcpus" : 15
          },
          "volumes" : {
            "volume" : {
              "akey_volname" : "String value",
              "bus" : "String value",
              "maxsize" : 15,
              "minsize" : 15,
              "size" : 15,
              "sizeunit" : "String value",
              "volid" : 15
            }
          }
        }
      }
    },
    "transactionId" : "String value"
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v1/op/nfv/deploy

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/nfv/deploy" rootUrl="https://localhost/webacs/api/v1/op">
  <serviceResponse>
    <deploymentStage>String value</deploymentStage>
    <eventTime>String value</eventTime>
    <payload>String value</payload>
    <statusCode>15</statusCode>
    <statusMessage>String value</statusMessage>
    <transactionId>String value</transactionId>
  </serviceResponse>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v1/op/nfv/deploy.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/nfv\/deploy",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
    "serviceResponse" : {
      "deploymentStage" : "String value",
      "eventTime" : "String value",
      "payload" : "String value",
      "statusCode" : 15,
      "statusMessage" : "String value",
      "transactionId" : "String value"
    }
  }
}